Source for org.jfree.chart.axis.TickType

   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:  * TickType.java
  29:  * -------------
  30:  * (C) Copyright 2007, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * Changes:
  36:  * --------
  37:  * 02-Aug-2007 : 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 tick type (MAJOR or MINOR).
  48:  *
  49:  * @since 1.0.7
  50:  */
  51: public final class TickType implements Serializable {
  52:     
  53:     /** Major tick. */
  54:     public static final TickType MAJOR = new TickType("MAJOR");
  55: 
  56:     /** Minor tick. */
  57:     public static final TickType MINOR = new TickType("MINOR");
  58: 
  59:     /** The name. */
  60:     private String name;
  61: 
  62:     /**
  63:      * Private constructor.
  64:      *
  65:      * @param name  the name.
  66:      */
  67:     private TickType(String name) {
  68:         this.name = name;
  69:     }
  70: 
  71:     /**
  72:      * Returns a string representing the object.
  73:      *
  74:      * @return The string.
  75:      */
  76:     public String toString() {
  77:         return this.name;
  78:     }
  79: 
  80:     /**
  81:      * Returns <code>true</code> if this object is equal to the specified 
  82:      * object, and <code>false</code> otherwise.
  83:      *
  84:      * @param obj  the other object.
  85:      *
  86:      * @return A boolean.
  87:      */
  88:     public boolean equals(Object obj) {
  89:         if (this == obj) {
  90:             return true;
  91:         }
  92:         if (!(obj instanceof TickType)) {
  93:             return false;
  94:         }
  95: 
  96:         TickType that = (TickType) obj;
  97:         if (!this.name.equals(that.name)) {
  98:             return false;
  99:         }
 100:         return true;
 101:     }
 102:     
 103:     /**
 104:      * Ensures that serialization returns the unique instances.
 105:      * 
 106:      * @return The object.
 107:      * 
 108:      * @throws ObjectStreamException if there is a problem.
 109:      */
 110:     private Object readResolve() throws ObjectStreamException {
 111:         Object result = null;
 112:         if (this.equals(TickType.MAJOR)) {
 113:             result = TickType.MAJOR;
 114:         }
 115:         else if (this.equals(TickType.MINOR)) {
 116:             result = TickType.MINOR;
 117:         }
 118:         return result;
 119:     }
 120: 
 121: }