Source for org.jfree.chart.LegendItemCollection

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2008, 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:  * LegendItemCollection.java
  29:  * -------------------------
  30:  * (C) Copyright 2002-2008, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * Changes
  36:  * -------
  37:  * 07-Feb-2002 : Version 1 (DG);
  38:  * 24-Sep-2002 : Added get(int) and getItemCount() methods (DG);
  39:  * 02-Oct-2002 : Fixed errors reported by Checkstyle (DG);
  40:  * 18-Apr-2005 : Added equals() method and implemented Cloneable and
  41:  *               Serializable (DG);
  42:  * 23-Apr-2008 : Fixed clone() method (DG);
  43:  *
  44:  */
  45: 
  46: package org.jfree.chart;
  47: 
  48: import java.io.Serializable;
  49: import java.util.Iterator;
  50: import java.util.List;
  51: 
  52: import org.jfree.util.ObjectUtilities;
  53: 
  54: /**
  55:  * A collection of legend items.
  56:  */
  57: public class LegendItemCollection implements Cloneable, Serializable {
  58: 
  59:     /** For serialization. */
  60:     private static final long serialVersionUID = 1365215565589815953L;
  61: 
  62:     /** Storage for the legend items. */
  63:     private List items;
  64: 
  65:     /**
  66:      * Constructs a new legend item collection, initially empty.
  67:      */
  68:     public LegendItemCollection() {
  69:         this.items = new java.util.ArrayList();
  70:     }
  71: 
  72:     /**
  73:      * Adds a legend item to the collection.
  74:      *
  75:      * @param item  the item to add.
  76:      */
  77:     public void add(LegendItem item) {
  78:         this.items.add(item);
  79:     }
  80: 
  81:     /**
  82:      * Adds the legend items from another collection to this collection.
  83:      *
  84:      * @param collection  the other collection.
  85:      */
  86:     public void addAll(LegendItemCollection collection) {
  87:         this.items.addAll(collection.items);
  88:     }
  89: 
  90:     /**
  91:      * Returns a legend item from the collection.
  92:      *
  93:      * @param index  the legend item index (zero-based).
  94:      *
  95:      * @return The legend item.
  96:      */
  97:     public LegendItem get(int index) {
  98:         return (LegendItem) this.items.get(index);
  99:     }
 100: 
 101:     /**
 102:      * Returns the number of legend items in the collection.
 103:      *
 104:      * @return The item count.
 105:      */
 106:     public int getItemCount() {
 107:         return this.items.size();
 108:     }
 109: 
 110:     /**
 111:      * Returns an iterator that provides access to all the legend items.
 112:      *
 113:      * @return An iterator.
 114:      */
 115:     public Iterator iterator() {
 116:         return this.items.iterator();
 117:     }
 118: 
 119:     /**
 120:      * Tests this collection for equality with an arbitrary object.
 121:      *
 122:      * @param obj  the object (<code>null</code> permitted).
 123:      *
 124:      * @return A boolean.
 125:      */
 126:     public boolean equals(Object obj) {
 127:         if (obj == this) {
 128:             return true;
 129:         }
 130:         if (!(obj instanceof LegendItemCollection)) {
 131:             return false;
 132:         }
 133:         LegendItemCollection that = (LegendItemCollection) obj;
 134:         if (!this.items.equals(that.items)) {
 135:             return false;
 136:         }
 137:         return true;
 138:     }
 139: 
 140:     /**
 141:      * Returns a clone of the collection.
 142:      *
 143:      * @return A clone.
 144:      *
 145:      * @throws CloneNotSupportedException if an item in the collection is not
 146:      *         cloneable.
 147:      */
 148:     public Object clone() throws CloneNotSupportedException {
 149:         LegendItemCollection clone = (LegendItemCollection) super.clone();
 150:         clone.items = (List) ObjectUtilities.deepClone(this.items);
 151:         return clone;
 152:     }
 153: 
 154: }