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 * LegendRenderingOrder.java
029 * -------------------------
030 * (C) Copyright 2004-2013, by Object Refinery Limited and Contributors.
031 *
032 * Original Author:  Angel;
033 * Contributor(s):   David Gilbert (for Object Refinery Limited);
034 *
035 * Changes
036 * -------
037 * 26-Mar-2004 : Version 1 (DG);
038 *
039 */
040
041package org.jfree.chart;
042
043import java.io.ObjectStreamException;
044import java.io.Serializable;
045
046/**
047 * Represents the order for rendering legend items.
048 */
049public final class LegendRenderingOrder implements Serializable {
050
051    /** For serialization. */
052    private static final long serialVersionUID = -3832486612685808616L;
053
054    /** In order. */
055    public static final LegendRenderingOrder STANDARD
056            = new LegendRenderingOrder("LegendRenderingOrder.STANDARD");
057
058    /** In reverse order. */
059    public static final LegendRenderingOrder REVERSE
060            = new LegendRenderingOrder("LegendRenderingOrder.REVERSE");
061
062    /** The name. */
063    private String name;
064
065    /**
066     * Private constructor.
067     *
068     * @param name  the name.
069     */
070    private LegendRenderingOrder(String name) {
071        this.name = name;
072    }
073
074    /**
075     * Returns a string representing the object.
076     *
077     * @return The string.
078     */
079    @Override
080    public String toString() {
081        return this.name;
082    }
083
084    /**
085     * Returns <code>true</code> if this object is equal to the specified
086     * object, and <code>false</code> otherwise.
087     *
088     * @param obj  the other object.
089     *
090     * @return A boolean.
091     */
092    @Override
093    public boolean equals(Object obj) {
094        if (this == obj) {
095            return true;
096        }
097        if (!(obj instanceof LegendRenderingOrder)) {
098            return false;
099        }
100        LegendRenderingOrder order = (LegendRenderingOrder) obj;
101        if (!this.name.equals(order.toString())) {
102            return false;
103        }
104        return true;
105    }
106
107    /**
108     * Ensures that serialization returns the unique instances.
109     *
110     * @return The object.
111     *
112     * @throws ObjectStreamException if there is a problem.
113     */
114    private Object readResolve() throws ObjectStreamException {
115        if (this.equals(LegendRenderingOrder.STANDARD)) {
116            return LegendRenderingOrder.STANDARD;
117        }
118        else if (this.equals(LegendRenderingOrder.REVERSE)) {
119            return LegendRenderingOrder.REVERSE;
120        }
121        return null;
122    }
123
124}