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