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-2005, 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-2005, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * $Id: DialShape.java,v 1.4.2.1 2005/10/25 20:52:08 mungady Exp $
  36:  *
  37:  * Changes:
  38:  * --------
  39:  * 20-Aug-2003 : Version 1 (DG);
  40:  *
  41:  */
  42: 
  43: package org.jfree.chart.plot;
  44: 
  45: import java.io.ObjectStreamException;
  46: import java.io.Serializable;
  47: 
  48: /**
  49:  * Used to indicate the background shape for a 
  50:  * {@link org.jfree.chart.plot.MeterPlot}.
  51:  */
  52: public final class DialShape implements Serializable {
  53: 
  54:     /** For serialization. */
  55:     private static final long serialVersionUID = -3471933055190251131L;
  56:     
  57:     /** Circle. */
  58:     public static final DialShape CIRCLE = new DialShape("DialShape.CIRCLE");
  59: 
  60:     /** Chord. */
  61:     public static final DialShape CHORD = new DialShape("DialShape.CHORD");
  62: 
  63:     /** Pie. */
  64:     public static final DialShape PIE = new DialShape("DialShape.PIE");
  65: 
  66:     /** The name. */
  67:     private String name;
  68: 
  69:     /**
  70:      * Private constructor.
  71:      *
  72:      * @param name  the name.
  73:      */
  74:     private DialShape(String name) {
  75:         this.name = name;
  76:     }
  77: 
  78:     /**
  79:      * Returns a string representing the object.
  80:      *
  81:      * @return The string.
  82:      */
  83:     public String toString() {
  84:         return this.name;
  85:     }
  86: 
  87:     /**
  88:      * Returns <code>true</code> if this object is equal to the specified 
  89:      * object, and <code>false</code> otherwise.
  90:      *
  91:      * @param obj  the other object.
  92:      *
  93:      * @return A boolean.
  94:      */
  95:     public boolean equals(Object obj) {
  96:         if (this == obj) {
  97:             return true;
  98:         }
  99:         if (!(obj instanceof DialShape)) {
 100:             return false;
 101:         }
 102:         DialShape shape = (DialShape) obj;
 103:         if (!this.name.equals(shape.toString())) {
 104:             return false;
 105:         }
 106:         return true;
 107:     }
 108:     
 109:     /**
 110:      * Ensures that serialization returns the unique instances.
 111:      * 
 112:      * @return The object.
 113:      * 
 114:      * @throws ObjectStreamException if there is a problem.
 115:      */
 116:     private Object readResolve() throws ObjectStreamException {
 117:         if (this.equals(DialShape.CIRCLE)) {
 118:             return DialShape.CIRCLE;
 119:         }
 120:         else if (this.equals(DialShape.CHORD)) {
 121:             return DialShape.CHORD;
 122:         }      
 123:         else if (this.equals(DialShape.PIE)) {
 124:             return DialShape.PIE;
 125:         }      
 126:         return null;
 127:     }
 128: 
 129: }