001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2013, by Object Refinery Limited 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 * SeriesRenderingOrder.java
029 * --------------------------
030 * (C) Copyright 2005-2008, by Object Refinery Limited.
031 *
032 * Original Author:  Eric Thomas (www.isti.com);
033 * Contributor(s):   David Gilbert (for Object Refinery Limited);
034 *
035 * Changes:
036 * --------
037 * 21-Apr-2005 : Version 1 contributed by Eric Thomas (ET);
038 * 21-Nov-2007 : Implemented hashCode() (DG);
039 *
040 */
041
042package org.jfree.chart.plot;
043
044import java.io.ObjectStreamException;
045import java.io.Serializable;
046
047/**
048 * Defines the tokens that indicate the rendering order for series in a
049 * {@link org.jfree.chart.plot.XYPlot}.
050 */
051public final class SeriesRenderingOrder implements Serializable {
052
053    /** For serialization. */
054    private static final long serialVersionUID = 209336477448807735L;
055
056    /**
057     * Render series in the order 0, 1, 2, ..., N-1, where N is the number
058     * of series.
059     */
060    public static final SeriesRenderingOrder FORWARD
061            = new SeriesRenderingOrder("SeriesRenderingOrder.FORWARD");
062
063    /**
064     * Render series in the order N-1, N-2, ..., 2, 1, 0, where N is the
065     * number of series.
066     */
067    public static final SeriesRenderingOrder REVERSE
068            = new SeriesRenderingOrder("SeriesRenderingOrder.REVERSE");
069
070    /** The name. */
071    private String name;
072
073    /**
074     * Private constructor.
075     *
076     * @param name  the name.
077     */
078    private SeriesRenderingOrder(String name) {
079        this.name = name;
080    }
081
082    /**
083     * Returns a string representing the object.
084     *
085     * @return The string (never <code>null</code>).
086     */
087    @Override
088    public String toString() {
089        return this.name;
090    }
091
092    /**
093     * Returns <code>true</code> if this object is equal to the specified
094     * object, and <code>false</code> otherwise.
095     *
096     * @param obj  the object (<code>null</code> permitted).
097     *
098     * @return A boolean.
099     */
100    @Override
101    public boolean equals(Object obj) {
102        if (this == obj) {
103            return true;
104        }
105        if (!(obj instanceof SeriesRenderingOrder)) {
106            return false;
107        }
108        SeriesRenderingOrder order = (SeriesRenderingOrder) obj;
109        if (!this.name.equals(order.toString())) {
110            return false;
111        }
112        return true;
113    }
114
115    /**
116     * Returns a hash code for this instance.
117     *
118     * @return A hash code.
119     */
120    @Override
121    public int hashCode() {
122        return this.name.hashCode();
123    }
124
125    /**
126     * Ensures that serialization returns the unique instances.
127     *
128     * @return The object.
129     *
130     * @throws ObjectStreamException if there is a problem.
131     */
132    private Object readResolve() throws ObjectStreamException {
133        if (this.equals(SeriesRenderingOrder.FORWARD)) {
134            return SeriesRenderingOrder.FORWARD;
135        }
136        else if (this.equals(SeriesRenderingOrder.REVERSE)) {
137            return SeriesRenderingOrder.REVERSE;
138        }
139        return null;
140    }
141
142}