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