Source for org.jfree.data.time.TimePeriodAnchor

   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:  * TimePeriodAnchor.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: TimePeriodAnchor.java,v 1.5.2.1 2005/10/25 21:35:24 mungady Exp $
  36:  *
  37:  * Changes:
  38:  * --------
  39:  * 30-Jul-2003 : Version 1 (DG);
  40:  * 01-Mar-2004 : Added readResolve() method (DG);
  41:  *
  42:  */
  43: 
  44: package org.jfree.data.time;
  45: 
  46: import java.io.ObjectStreamException;
  47: import java.io.Serializable;
  48: 
  49: /**
  50:  * Used to indicate one of three positions in a time period: 
  51:  * <code>START</code>, <code>MIDDLE</code> and <code>END</code>.
  52:  */
  53: public final class TimePeriodAnchor implements Serializable {
  54: 
  55:     /** For serialization. */
  56:     private static final long serialVersionUID = 2011955697457548862L;
  57:     
  58:     /** Start of period. */
  59:     public static final TimePeriodAnchor START 
  60:         = new TimePeriodAnchor("TimePeriodAnchor.START");
  61: 
  62:     /** Middle of period. */
  63:     public static final TimePeriodAnchor MIDDLE 
  64:         = new TimePeriodAnchor("TimePeriodAnchor.MIDDLE");
  65: 
  66:     /** End of period. */
  67:     public static final TimePeriodAnchor END 
  68:         = new TimePeriodAnchor("TimePeriodAnchor.END");
  69: 
  70:     /** The name. */
  71:     private String name;
  72: 
  73:     /**
  74:      * Private constructor.
  75:      *
  76:      * @param name  the name.
  77:      */
  78:     private TimePeriodAnchor(String name) {
  79:         this.name = name;
  80:     }
  81: 
  82:     /**
  83:      * Returns a string representing the object.
  84:      *
  85:      * @return The string.
  86:      */
  87:     public String toString() {
  88:         return this.name;
  89:     }
  90: 
  91:     /**
  92:      * Returns <code>true</code> if this object is equal to the specified 
  93:      * object, and <code>false</code> otherwise.
  94:      *
  95:      * @param obj  the other object.
  96:      *
  97:      * @return A boolean.
  98:      */
  99:     public boolean equals(Object obj) {
 100: 
 101:         if (this == obj) {
 102:             return true;
 103:         }
 104:         if (!(obj instanceof TimePeriodAnchor)) {
 105:             return false;
 106:         }
 107: 
 108:         TimePeriodAnchor position = (TimePeriodAnchor) obj;
 109:         if (!this.name.equals(position.name)) {
 110:             return false;
 111:         }
 112: 
 113:         return true;
 114:     }
 115: 
 116:     /**
 117:      * Returns a hash code value for the object.
 118:      *
 119:      * @return The hashcode
 120:      */
 121:     public int hashCode() {
 122:         return this.name.hashCode();
 123:     }
 124:     
 125:     /**
 126:      * Ensures that serialization returns the unique instances.
 127:      * 
 128:      * @return The object.
 129:      * 
 130:      * @throws ObjectStreamException if there is a problem.
 131:      */
 132:     private Object readResolve() throws ObjectStreamException {
 133:         if (this.equals(TimePeriodAnchor.START)) {
 134:             return TimePeriodAnchor.START;
 135:         }
 136:         else if (this.equals(TimePeriodAnchor.MIDDLE)) {
 137:             return TimePeriodAnchor.MIDDLE;
 138:         }
 139:         else if (this.equals(TimePeriodAnchor.END)) {
 140:             return TimePeriodAnchor.END;
 141:         }
 142:         return null;
 143:     }
 144: 
 145: }