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