001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-present, by David Gilbert and Contributors.
006 *
007 * Project Info:  http://www.jfree.org/jfreechart/index.html
008 *
009 * This library is free software; you can redistribute it and/or modify it
010 * under the terms of the GNU Lesser General Public License as published by
011 * the Free Software Foundation; either version 2.1 of the License, or
012 * (at your option) any later version.
013 *
014 * This library is distributed in the hope that it will be useful, but
015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
017 * License for more details.
018 *
019 * You should have received a copy of the GNU Lesser General Public
020 * License along with this library; if not, write to the Free Software
021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,
022 * USA.
023 *
024 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 
025 * Other names may be trademarks of their respective owners.]
026 *
027 * -------------------------
028 * LegendItemCollection.java
029 * -------------------------
030 * (C) Copyright 2002-present, by David Gilbert.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   Tracy Hiltbrand (equals/hashCode comply with EqualsVerifier);
034 *
035 */
036
037package org.jfree.chart;
038
039import java.io.Serializable;
040import java.util.Iterator;
041import java.util.List;
042import java.util.Objects;
043import org.jfree.chart.util.ObjectUtils;
044
045/**
046 * A collection of legend items.
047 */
048public class LegendItemCollection implements Cloneable, Serializable {
049
050    /** For serialization. */
051    private static final long serialVersionUID = 1365215565589815953L;
052
053    /** Storage for the legend items. */
054    private List items;
055
056    /**
057     * Constructs a new legend item collection, initially empty.
058     */
059    public LegendItemCollection() {
060        this.items = new java.util.ArrayList();
061    }
062
063    /**
064     * Adds a legend item to the collection.
065     *
066     * @param item  the item to add.
067     */
068    public void add(LegendItem item) {
069        this.items.add(item);
070    }
071
072    /**
073     * Adds the legend items from another collection to this collection.
074     *
075     * @param collection  the other collection ({@code null} not
076     *     permitted).
077     */
078    public void addAll(LegendItemCollection collection) {
079        this.items.addAll(collection.items);
080    }
081
082    /**
083     * Returns a legend item from the collection.
084     *
085     * @param index  the legend item index (zero-based).
086     *
087     * @return The legend item.
088     */
089    public LegendItem get(int index) {
090        return (LegendItem) this.items.get(index);
091    }
092
093    /**
094     * Returns the number of legend items in the collection.
095     *
096     * @return The item count.
097     */
098    public int getItemCount() {
099        return this.items.size();
100    }
101
102    /**
103     * Returns an iterator that provides access to all the legend items.
104     *
105     * @return An iterator.
106     */
107    public Iterator iterator() {
108        return this.items.iterator();
109    }
110
111    /**
112     * Tests this collection for equality with an arbitrary object.
113     *
114     * @param obj  the object ({@code null} permitted).
115     *
116     * @return A boolean.
117     */
118    @Override
119    public boolean equals(Object obj) {
120        if (obj == this) {
121            return true;
122        }
123        if (!(obj instanceof LegendItemCollection)) {
124            return false;
125        }
126        LegendItemCollection that = (LegendItemCollection) obj;
127        if (!Objects.equals(this.items, that.items)) {
128            return false;
129        }
130        return true;
131    }
132
133    @Override
134    public int hashCode() {
135        int hash = 7;
136        hash = 13 * hash + Objects.hashCode(this.items);
137        return hash;
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    @Override
149    public Object clone() throws CloneNotSupportedException {
150        LegendItemCollection clone = (LegendItemCollection) super.clone();
151        clone.items = (List) ObjectUtils.deepClone(this.items);
152        return clone;
153    }
154
155}