Source for org.jfree.chart.plot.PlotOrientation

   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:  * PlotOrientation.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: PlotOrientation.java,v 1.4.2.1 2005/10/25 20:52:08 mungady Exp $
  36:  *
  37:  * Changes:
  38:  * --------
  39:  * 02-May-2003 : Version 1 (DG);
  40:  * 17-Jul-2003 : Added readResolve() method (DG);
  41:  *
  42:  */
  43: 
  44: package org.jfree.chart.plot;
  45: 
  46: import java.io.ObjectStreamException;
  47: import java.io.Serializable;
  48: 
  49: /**
  50:  * Used to indicate the orientation (horizontal or vertical) of a 2D plot.
  51:  */
  52: public final class PlotOrientation implements Serializable {
  53: 
  54:     /** For serialization. */
  55:     private static final long serialVersionUID = -2508771828190337782L;
  56:     
  57:     /** For a plot where the range axis is horizontal. */
  58:     public static final PlotOrientation HORIZONTAL
  59:         = new PlotOrientation("PlotOrientation.HORIZONTAL");
  60: 
  61:     /** For a plot where the range axis is vertical. */
  62:     public static final PlotOrientation VERTICAL
  63:         = new PlotOrientation("PlotOrientation.VERTICAL");
  64: 
  65:     /** The name. */
  66:     private String name;
  67: 
  68:     /**
  69:      * Private constructor.
  70:      *
  71:      * @param name  the name.
  72:      */
  73:     private PlotOrientation(String name) {
  74:         this.name = name;
  75:     }
  76: 
  77:     /**
  78:      * Returns a string representing the object.
  79:      *
  80:      * @return The string.
  81:      */
  82:     public String toString() {
  83:         return this.name;
  84:     }
  85: 
  86:     /**
  87:      * Returns <code>true</code> if this object is equal to the specified 
  88:      * object, and <code>false</code> otherwise.
  89:      *
  90:      * @param o  the other object.
  91:      *
  92:      * @return A boolean.
  93:      */
  94:     public boolean equals(Object o) {
  95: 
  96:         if (this == o) {
  97:             return true;
  98:         }
  99:         if (!(o instanceof PlotOrientation)) {
 100:             return false;
 101:         }
 102: 
 103:         PlotOrientation orientation = (PlotOrientation) o;
 104:         if (!this.name.equals(orientation.toString())) {
 105:             return false;
 106:         }
 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:         Object result = null;
 121:         if (this.equals(PlotOrientation.HORIZONTAL)) {
 122:             result = PlotOrientation.HORIZONTAL;
 123:         }
 124:         else if (this.equals(PlotOrientation.VERTICAL)) {
 125:             result = PlotOrientation.VERTICAL;
 126:         }
 127:         return result;
 128:     }
 129: 
 130: }