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