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 * AxisLabelLocation.java
029 * ----------------------
030 * (C) Copyright 2013-present, by David Gilbert and Contributors.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.chart.axis;
038
039import java.io.ObjectStreamException;
040import java.io.Serializable;
041
042/**
043 * Used to indicate the location of an axis label.
044 */
045public final class AxisLabelLocation implements Serializable {
046
047    /** For serialization. */
048    private static final long serialVersionUID = 1L;
049
050    /** Axis label at the top. */
051    public static final AxisLabelLocation HIGH_END = new AxisLabelLocation(
052            "HIGH_END");
053    
054    /** Axis label at the middle. */
055    public static final AxisLabelLocation MIDDLE = new AxisLabelLocation(
056            "MIDDLE");
057    
058    /** Axis label at the bottom. */
059    public static final AxisLabelLocation LOW_END = new AxisLabelLocation(
060            "LOW_END");
061
062    /** The name. */
063    private final String name;
064
065    /**
066     * Private constructor.
067     *
068     * @param name  the name.
069     */
070    private AxisLabelLocation(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} if this object is equal to the specified
086     * object, and {@code false} otherwise.
087     *
088     * @param obj  the other object ({@code null} permitted).
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 AxisLabelLocation)) {
098            return false;
099        }
100        AxisLabelLocation location = (AxisLabelLocation) obj;
101        if (!this.name.equals(location.toString())) {
102            return false;
103        }
104        return true;
105    }
106
107    /**
108     * Returns a hash code for this instance.
109     * 
110     * @return A hash code. 
111     */
112    @Override
113    public int hashCode() {
114        int hash = 5;
115        hash = 83 * hash + this.name.hashCode();
116        return hash;
117    }
118
119    /**
120     * Ensures that serialization returns the unique instances.
121     *
122     * @return The object.
123     *
124     * @throws ObjectStreamException if there is a problem.
125     */
126    private Object readResolve() throws ObjectStreamException {
127        if (this.equals(AxisLabelLocation.HIGH_END)) {
128            return AxisLabelLocation.HIGH_END;
129        }
130        if (this.equals(AxisLabelLocation.MIDDLE)) {
131            return AxisLabelLocation.MIDDLE;
132        }
133        if (this.equals(AxisLabelLocation.LOW_END)) {
134            return AxisLabelLocation.LOW_END;
135        }
136
137        return null;
138    }
139
140}