001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2007, 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 * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
025 * in the United States and other countries.]
026 *
027 * --------------
028 * DialShape.java
029 * --------------
030 * (C) Copyright 2003-2007, by Object Refinery Limited.
031 *
032 * Original Author:  David Gilbert (for Object Refinery Limited);
033 * Contributor(s):   -;
034 *
035 * Changes:
036 * --------
037 * 20-Aug-2003 : Version 1 (DG);
038 *
039 */
040
041package org.jfree.chart.plot;
042
043import java.io.ObjectStreamException;
044import java.io.Serializable;
045
046/**
047 * Used to indicate the background shape for a 
048 * {@link org.jfree.chart.plot.MeterPlot}.
049 */
050public final class DialShape implements Serializable {
051
052    /** For serialization. */
053    private static final long serialVersionUID = -3471933055190251131L;
054    
055    /** Circle. */
056    public static final DialShape CIRCLE = new DialShape("DialShape.CIRCLE");
057
058    /** Chord. */
059    public static final DialShape CHORD = new DialShape("DialShape.CHORD");
060
061    /** Pie. */
062    public static final DialShape PIE = new DialShape("DialShape.PIE");
063
064    /** The name. */
065    private String name;
066
067    /**
068     * Private constructor.
069     *
070     * @param name  the name.
071     */
072    private DialShape(String name) {
073        this.name = name;
074    }
075
076    /**
077     * Returns a string representing the object.
078     *
079     * @return The string.
080     */
081    public String toString() {
082        return this.name;
083    }
084
085    /**
086     * Returns <code>true</code> if this object is equal to the specified 
087     * object, and <code>false</code> otherwise.
088     *
089     * @param obj  the other object.
090     *
091     * @return A boolean.
092     */
093    public boolean equals(Object obj) {
094        if (this == obj) {
095            return true;
096        }
097        if (!(obj instanceof DialShape)) {
098            return false;
099        }
100        DialShape shape = (DialShape) obj;
101        if (!this.name.equals(shape.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(DialShape.CIRCLE)) {
116            return DialShape.CIRCLE;
117        }
118        else if (this.equals(DialShape.CHORD)) {
119            return DialShape.CHORD;
120        }      
121        else if (this.equals(DialShape.PIE)) {
122            return DialShape.PIE;
123        }      
124        return null;
125    }
126
127}