Source for org.jfree.data.RangeType

   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:  * RangeType.java
  29:  * --------------
  30:  * (C) Copyright 2005-2007, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * Changes:
  36:  * --------
  37:  * 24-Feb-2005 : Version 1 (DG);
  38:  * 
  39:  */
  40: 
  41: package org.jfree.data;
  42: 
  43: import java.io.ObjectStreamException;
  44: import java.io.Serializable;
  45: 
  46: /**
  47:  * Used to indicate the type of range to display on an axis (full, positive or
  48:  * negative).
  49:  */
  50: public final class RangeType implements Serializable {
  51: 
  52:     /** For serialization. */
  53:     private static final long serialVersionUID = -9073319010650549239L;
  54:      
  55:     /** Full range (positive and negative). */
  56:     public static final RangeType FULL = new RangeType("RangeType.FULL");
  57: 
  58:     /** Positive range. */
  59:     public static final RangeType POSITIVE 
  60:         = new RangeType("RangeType.POSITIVE");
  61: 
  62:     /** Negative range. */
  63:     public static final RangeType NEGATIVE 
  64:         = new RangeType("RangeType.NEGATIVE");
  65: 
  66:     /** The name. */
  67:     private String name;
  68: 
  69:     /**
  70:      * Private constructor.
  71:      *
  72:      * @param name  the name.
  73:      */
  74:     private RangeType(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: 
  97:         if (this == obj) {
  98:             return true;
  99:         }
 100:         if (!(obj instanceof RangeType)) {
 101:             return false;
 102:         }
 103:         RangeType that = (RangeType) obj;
 104:         if (!this.name.equals(that.toString())) {
 105:             return false;
 106:         }
 107:         return true;
 108:     }
 109:     
 110:     /**
 111:      * Returns a hash code value for the object.
 112:      *
 113:      * @return The hashcode
 114:      */
 115:     public int hashCode() {
 116:         return this.name.hashCode();
 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(RangeType.FULL)) {
 128:             return RangeType.FULL;
 129:         }
 130:         else if (this.equals(RangeType.POSITIVE)) {
 131:             return RangeType.POSITIVE;
 132:         }
 133:         else if (this.equals(RangeType.NEGATIVE)) {
 134:             return RangeType.NEGATIVE;
 135:         }
 136:         return null;
 137:     }
 138:     
 139: }