Source for org.jfree.data.RangeType

   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:  * RangeType.java
  29:  * --------------
  30:  * (C) Copyright 2005, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * $Id: RangeType.java,v 1.2.2.1 2005/10/25 21:29:13 mungady Exp $
  36:  *
  37:  * Changes:
  38:  * --------
  39:  * 24-Feb-2005 : Version 1 (DG);
  40:  * 
  41:  */
  42: 
  43: package org.jfree.data;
  44: 
  45: import java.io.ObjectStreamException;
  46: import java.io.Serializable;
  47: 
  48: /**
  49:  * Used to indicate the type of range to display on an axis (full, positive or
  50:  * negative).
  51:  */
  52: public final class RangeType implements Serializable {
  53: 
  54:     /** For serialization. */
  55:     private static final long serialVersionUID = -9073319010650549239L;
  56:      
  57:     /** Full range (positive and negative). */
  58:     public static final RangeType FULL = new RangeType("RangeType.FULL");
  59: 
  60:     /** Positive range. */
  61:     public static final RangeType POSITIVE 
  62:         = new RangeType("RangeType.POSITIVE");
  63: 
  64:     /** Negative range. */
  65:     public static final RangeType NEGATIVE 
  66:         = new RangeType("RangeType.NEGATIVE");
  67: 
  68:     /** The name. */
  69:     private String name;
  70: 
  71:     /**
  72:      * Private constructor.
  73:      *
  74:      * @param name  the name.
  75:      */
  76:     private RangeType(String name) {
  77:         this.name = name;
  78:     }
  79: 
  80:     /**
  81:      * Returns a string representing the object.
  82:      *
  83:      * @return The string.
  84:      */
  85:     public String toString() {
  86:         return this.name;
  87:     }
  88: 
  89:     /**
  90:      * Returns <code>true</code> if this object is equal to the specified 
  91:      * object, and <code>false</code> otherwise.
  92:      *
  93:      * @param obj  the other object.
  94:      *
  95:      * @return A boolean.
  96:      */
  97:     public boolean equals(Object obj) {
  98: 
  99:         if (this == obj) {
 100:             return true;
 101:         }
 102:         if (!(obj instanceof RangeType)) {
 103:             return false;
 104:         }
 105:         RangeType that = (RangeType) obj;
 106:         if (!this.name.equals(that.toString())) {
 107:             return false;
 108:         }
 109:         return true;
 110:     }
 111:     
 112:     /**
 113:      * Returns a hash code value for the object.
 114:      *
 115:      * @return The hashcode
 116:      */
 117:     public int hashCode() {
 118:         return this.name.hashCode();
 119:     }
 120: 
 121:     /**
 122:      * Ensures that serialization returns the unique instances.
 123:      * 
 124:      * @return The object.
 125:      * 
 126:      * @throws ObjectStreamException if there is a problem.
 127:      */
 128:     private Object readResolve() throws ObjectStreamException {
 129:         if (this.equals(RangeType.FULL)) {
 130:             return RangeType.FULL;
 131:         }
 132:         else if (this.equals(RangeType.POSITIVE)) {
 133:             return RangeType.POSITIVE;
 134:         }
 135:         else if (this.equals(RangeType.NEGATIVE)) {
 136:             return RangeType.NEGATIVE;
 137:         }
 138:         return null;
 139:     }
 140:     
 141: }