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