Source for org.jfree.data.Values

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2006, by Object Refinery Limited and Contributors.
   6:  *
   7:  * Project Info:  http://www.jfree.org/jfreechart/index.html
   8:  *
   9:  * This library is free software; you can redistribute it and/or modify it 
  10:  * under the terms of the GNU Lesser General Public License as published by 
  11:  * the Free Software Foundation; either version 2.1 of the License, or 
  12:  * (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but 
  15:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  16:  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
  17:  * License for more details.
  18:  *
  19:  * You should have received a copy of the GNU Lesser General Public
  20:  * License along with this library; if not, write to the Free Software
  21:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
  22:  * USA.  
  23:  *
  24:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
  25:  * in the United States and other countries.]
  26:  *
  27:  * -----------
  28:  * Values.java
  29:  * -----------
  30:  * (C) Copyright 2001-2006, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * $Id: Values.java,v 1.2.2.2 2006/07/26 12:15:52 mungady Exp $
  36:  *
  37:  * Changes:
  38:  * --------
  39:  * 08-Nov-2001 : Version 1 (DG);
  40:  * 23-Oct-2002 : Renamed getValueCount --> getItemCount (DG);#
  41:  * ------------- JFREECHART 1.0.0 ---------------------------------------------
  42:  * 02-May-2006 : Updated API docs (DG);
  43:  *
  44:  */
  45: 
  46: package org.jfree.data;
  47: 
  48: /**
  49:  * An interface through which (single-dimension) data values can be accessed.
  50:  */
  51: public interface Values {
  52: 
  53:     /**
  54:      * Returns the number of items (values) in the collection.
  55:      *
  56:      * @return The item count (possibly zero).
  57:      */
  58:     public int getItemCount();
  59: 
  60:     /**
  61:      * Returns the value with the specified index.
  62:      *
  63:      * @param index  the item index (in the range <code>0</code> to 
  64:      *     <code>getItemCount() - 1</code>).
  65:      *
  66:      * @return The value (possibly <code>null</code>).
  67:      * 
  68:      * @throws IndexOutOfBoundsException if <code>index</code> is not in the 
  69:      *     specified range.
  70:      */
  71:     public Number getValue(int index);
  72: 
  73: }