Source for org.jfree.chart.plot.DialShape

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2007, by Object Refinery Limited and Contributors.
   6:  *
   7:  * Project Info:  http://www.jfree.org/jfreechart/index.html
   8:  *
   9:  * This library is free software; you can redistribute it and/or modify it 
  10:  * under the terms of the GNU Lesser General Public License as published by 
  11:  * the Free Software Foundation; either version 2.1 of the License, or 
  12:  * (at your option) any later version.
  13:  *
  14:  * This library is distributed in the hope that it will be useful, but 
  15:  * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 
  16:  * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 
  17:  * License for more details.
  18:  *
  19:  * You should have received a copy of the GNU Lesser General Public
  20:  * License along with this library; if not, write to the Free Software
  21:  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, 
  22:  * USA.  
  23:  *
  24:  * [Java is a trademark or registered trademark of Sun Microsystems, Inc. 
  25:  * in the United States and other countries.]
  26:  *
  27:  * --------------
  28:  * DialShape.java
  29:  * --------------
  30:  * (C) Copyright 2003-2007, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * Changes:
  36:  * --------
  37:  * 20-Aug-2003 : Version 1 (DG);
  38:  * 12-Nov-2007 : Implemented hashCode() (DG);
  39:  *
  40:  */
  41: 
  42: package org.jfree.chart.plot;
  43: 
  44: import java.io.ObjectStreamException;
  45: import java.io.Serializable;
  46: 
  47: /**
  48:  * Used to indicate the background shape for a 
  49:  * {@link org.jfree.chart.plot.MeterPlot}.
  50:  */
  51: public final class DialShape implements Serializable {
  52: 
  53:     /** For serialization. */
  54:     private static final long serialVersionUID = -3471933055190251131L;
  55:     
  56:     /** Circle. */
  57:     public static final DialShape CIRCLE = new DialShape("DialShape.CIRCLE");
  58: 
  59:     /** Chord. */
  60:     public static final DialShape CHORD = new DialShape("DialShape.CHORD");
  61: 
  62:     /** Pie. */
  63:     public static final DialShape PIE = new DialShape("DialShape.PIE");
  64: 
  65:     /** The name. */
  66:     private String name;
  67: 
  68:     /**
  69:      * Private constructor.
  70:      *
  71:      * @param name  the name.
  72:      */
  73:     private DialShape(String name) {
  74:         this.name = name;
  75:     }
  76: 
  77:     /**
  78:      * Returns a string representing the object.
  79:      *
  80:      * @return The string.
  81:      */
  82:     public String toString() {
  83:         return this.name;
  84:     }
  85: 
  86:     /**
  87:      * Returns <code>true</code> if this object is equal to the specified 
  88:      * object, and <code>false</code> otherwise.
  89:      *
  90:      * @param obj  the other object.
  91:      *
  92:      * @return A boolean.
  93:      */
  94:     public boolean equals(Object obj) {
  95:         if (this == obj) {
  96:             return true;
  97:         }
  98:         if (!(obj instanceof DialShape)) {
  99:             return false;
 100:         }
 101:         DialShape shape = (DialShape) obj;
 102:         if (!this.name.equals(shape.toString())) {
 103:             return false;
 104:         }
 105:         return true;
 106:     }
 107:     
 108:     /**
 109:      * Returns a hash code for this instance.
 110:      * 
 111:      * @return A hash code.
 112:      */
 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(DialShape.CIRCLE)) {
 126:             return DialShape.CIRCLE;
 127:         }
 128:         else if (this.equals(DialShape.CHORD)) {
 129:             return DialShape.CHORD;
 130:         }      
 131:         else if (this.equals(DialShape.PIE)) {
 132:             return DialShape.PIE;
 133:         }      
 134:         return null;
 135:     }
 136: 
 137: }