Source for org.jfree.chart.axis.DateTickMarkPosition

   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:  * DateTickMarkPosition.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:  * 30-Apr-2003 : Version 1 (DG);
  38:  *
  39:  */
  40: 
  41: package org.jfree.chart.axis;
  42: 
  43: import java.io.ObjectStreamException;
  44: import java.io.Serializable;
  45: 
  46: /**
  47:  * Used to indicate the required position of tick marks on a date axis relative
  48:  * to the underlying time period.
  49:  */
  50: public final class DateTickMarkPosition implements Serializable {
  51: 
  52:     /** For serialization. */
  53:     private static final long serialVersionUID = 2540750672764537240L;
  54:     
  55:     /** Start of period. */
  56:     public static final DateTickMarkPosition START
  57:         = new DateTickMarkPosition("DateTickMarkPosition.START");
  58: 
  59:     /** Middle of period. */
  60:     public static final DateTickMarkPosition MIDDLE
  61:         = new DateTickMarkPosition("DateTickMarkPosition.MIDDLE");
  62: 
  63:     /** End of period. */
  64:     public static final DateTickMarkPosition END
  65:         = new DateTickMarkPosition("DateTickMarkPosition.END");
  66: 
  67:     /** The name. */
  68:     private String name;
  69: 
  70:     /**
  71:      * Private constructor.
  72:      *
  73:      * @param name  the name.
  74:      */
  75:     private DateTickMarkPosition(String name) {
  76:         this.name = name;
  77:     }
  78: 
  79:     /**
  80:      * Returns a string representing the object.
  81:      *
  82:      * @return The string.
  83:      */
  84:     public String toString() {
  85:         return this.name;
  86:     }
  87: 
  88:     /**
  89:      * Returns <code>true</code> if this object is equal to the specified 
  90:      * object, and <code>false</code> otherwise.
  91:      *
  92:      * @param obj  the other object.
  93:      *
  94:      * @return A boolean.
  95:      */
  96:     public boolean equals(Object obj) {
  97: 
  98:         if (this == obj) {
  99:             return true;
 100:         }
 101:         if (!(obj instanceof DateTickMarkPosition)) {
 102:             return false;
 103:         }
 104:         DateTickMarkPosition position = (DateTickMarkPosition) obj;
 105:         if (!this.name.equals(position.toString())) {
 106:             return false;
 107:         }
 108:         return true;
 109: 
 110:     }
 111:     
 112:     /**
 113:      * Ensures that serialization returns the unique instances.
 114:      * 
 115:      * @return The object.
 116:      * 
 117:      * @throws ObjectStreamException if there is a problem.
 118:      */
 119:     private Object readResolve() throws ObjectStreamException {
 120:         if (this.equals(DateTickMarkPosition.START)) {
 121:             return DateTickMarkPosition.START;
 122:         }
 123:         else if (this.equals(DateTickMarkPosition.MIDDLE)) {
 124:             return DateTickMarkPosition.MIDDLE;
 125:         }    
 126:         else if (this.equals(DateTickMarkPosition.END)) {
 127:             return DateTickMarkPosition.END;
 128:         }    
 129:         return null;
 130:     }
 131: 
 132: 
 133: }