From: David G. <mu...@us...> - 2006-07-26 13:43:13
|
Update of /cvsroot/jfreechart/jfreechart/source/org/jfree/data In directory sc8-pr-cvs6.sourceforge.net:/tmp/cvs-serv14603/source/org/jfree/data Modified Files: Tag: STABLE_1-0-0 Values.java KeyedValues.java Log Message: Updated API docs. Index: KeyedValues.java =================================================================== RCS file: /cvsroot/jfreechart/jfreechart/source/org/jfree/data/KeyedValues.java,v retrieving revision 1.3.2.1 retrieving revision 1.3.2.2 diff -C2 -d -r1.3.2.1 -r1.3.2.2 *** KeyedValues.java 25 Oct 2005 21:29:13 -0000 1.3.2.1 --- KeyedValues.java 26 Jul 2006 12:15:52 -0000 1.3.2.2 *************** *** 3,7 **** * =========================================================== * ! * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors. * * Project Info: http://www.jfree.org/jfreechart/index.html --- 3,7 ---- * =========================================================== * ! * (C) Copyright 2000-2006, by Object Refinery Limited and Contributors. * * Project Info: http://www.jfree.org/jfreechart/index.html *************** *** 28,32 **** * KeyedValues.java * ---------------- ! * (C) Copyright 2002-2005, by Object Refinery Limited. * * Original Author: David Gilbert (for Object Refinery Limited); --- 28,32 ---- * KeyedValues.java * ---------------- ! * (C) Copyright 2002-2006, by Object Refinery Limited. * * Original Author: David Gilbert (for Object Refinery Limited); *************** *** 40,43 **** --- 40,45 ---- * 12-Jan-2005 : Updated Javadocs to specify new behaviour when key * is not recognised (DG); + * ------------- JFREECHART 1.0.0 --------------------------------------------- + * 02-May-2006 : Updated API docs (DG); * */ *************** *** 48,52 **** /** ! * An ordered list of (key, value) items. * * @see Values --- 50,55 ---- /** ! * An ordered list of (key, value) items where the keys are unique and ! * non-<code>null</code>. * * @see Values *************** *** 58,66 **** * Returns the key associated with an item (value). * ! * @param index the item index (zero-based). * ! * @return The key. * ! * @throws IndexOutOfBoundsException if <code>index</code> is out of bounds. */ public Comparable getKey(int index); --- 61,71 ---- * Returns the key associated with an item (value). * ! * @param index the item index (in the range <code>0</code> to ! * <code>getItemCount() - 1</code>). * ! * @return The key (never <code>null</code>). * ! * @throws IndexOutOfBoundsException if <code>index</code> is not in the ! * specified range. */ public Comparable getKey(int index); *************** *** 69,75 **** * Returns the index for a given key. * ! * @param key the key. * * @return The index, or <code>-1</code> if the key is unrecognised. */ public int getIndex(Comparable key); --- 74,83 ---- * Returns the index for a given key. * ! * @param key the key (<code>null</code> not permitted). * * @return The index, or <code>-1</code> if the key is unrecognised. + * + * @throws IllegalArgumentException if <code>key</code> is + * <code>null</code>. */ public int getIndex(Comparable key); Index: Values.java =================================================================== RCS file: /cvsroot/jfreechart/jfreechart/source/org/jfree/data/Values.java,v retrieving revision 1.2.2.1 retrieving revision 1.2.2.2 diff -C2 -d -r1.2.2.1 -r1.2.2.2 *** Values.java 25 Oct 2005 21:29:13 -0000 1.2.2.1 --- Values.java 26 Jul 2006 12:15:52 -0000 1.2.2.2 *************** *** 3,7 **** * =========================================================== * ! * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors. * * Project Info: http://www.jfree.org/jfreechart/index.html --- 3,7 ---- * =========================================================== * ! * (C) Copyright 2000-2006, by Object Refinery Limited and Contributors. * * Project Info: http://www.jfree.org/jfreechart/index.html *************** *** 28,32 **** * Values.java * ----------- ! * (C) Copyright 2001-2005, by Object Refinery Limited. * * Original Author: David Gilbert (for Object Refinery Limited); --- 28,32 ---- * Values.java * ----------- ! * (C) Copyright 2001-2006, by Object Refinery Limited. * * Original Author: David Gilbert (for Object Refinery Limited); *************** *** 38,42 **** * -------- * 08-Nov-2001 : Version 1 (DG); ! * 23-Oct-2002 : Renamed getValueCount --> getItemCount (DG); * */ --- 38,44 ---- * -------- * 08-Nov-2001 : Version 1 (DG); ! * 23-Oct-2002 : Renamed getValueCount --> getItemCount (DG);# ! * ------------- JFREECHART 1.0.0 --------------------------------------------- ! * 02-May-2006 : Updated API docs (DG); * */ *************** *** 52,67 **** * Returns the number of items (values) in the collection. * ! * @return The item count. */ public int getItemCount(); /** ! * Returns a value. * ! * @param item the item of interest (zero-based index). * ! * @return The value. */ ! public Number getValue(int item); } \ No newline at end of file --- 54,73 ---- * Returns the number of items (values) in the collection. * ! * @return The item count (possibly zero). */ public int getItemCount(); /** ! * Returns the value with the specified index. * ! * @param index the item index (in the range <code>0</code> to ! * <code>getItemCount() - 1</code>). * ! * @return The value (possibly <code>null</code>). ! * ! * @throws IndexOutOfBoundsException if <code>index</code> is not in the ! * specified range. */ ! public Number getValue(int index); } \ No newline at end of file |