Source for org.jfree.chart.LegendRenderingOrder

   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:  * LegendRenderingOrder.java
  29:  * -------------------------
  30:  * (C) Copyright 2004-2007, by Object Refinery Limited and Contributors.
  31:  *
  32:  * Original Author:  Angel;
  33:  * Contributor(s):   -;
  34:  *
  35:  * Changes
  36:  * -------
  37:  * 26-Mar-2004 : Version 1 (DG);
  38:  * 
  39:  */
  40: 
  41: package org.jfree.chart;
  42: 
  43: import java.io.ObjectStreamException;
  44: import java.io.Serializable;
  45: 
  46: /**
  47:  * Represents the order for rendering legend items.
  48:  */
  49: public final class LegendRenderingOrder implements Serializable {
  50: 
  51:     /** For serialization. */
  52:     private static final long serialVersionUID = -3832486612685808616L;
  53:     
  54:     /** In order. */
  55:     public static final LegendRenderingOrder STANDARD 
  56:         = new LegendRenderingOrder("LegendRenderingOrder.STANDARD");
  57: 
  58:     /** In reverse order. */
  59:     public static final LegendRenderingOrder REVERSE 
  60:         = new LegendRenderingOrder("LegendRenderingOrder.REVERSE");
  61: 
  62:     /** The name. */
  63:     private String name;
  64: 
  65:     /**
  66:      * Private constructor.
  67:      *
  68:      * @param name  the name.
  69:      */
  70:     private LegendRenderingOrder(String name) {
  71:         this.name = name;
  72:     }
  73: 
  74:     /**
  75:      * Returns a string representing the object.
  76:      *
  77:      * @return The string.
  78:      */
  79:     public String toString() {
  80:         return this.name;
  81:     }
  82: 
  83:     /**
  84:      * Returns <code>true</code> if this object is equal to the specified 
  85:      * object, and <code>false</code> otherwise.
  86:      *
  87:      * @param obj  the other object.
  88:      *
  89:      * @return A boolean.
  90:      */
  91:     public boolean equals(Object obj) {
  92:         if (this == obj) {
  93:             return true;
  94:         }
  95:         if (!(obj instanceof LegendRenderingOrder)) {
  96:             return false;
  97:         }
  98:         LegendRenderingOrder order = (LegendRenderingOrder) obj;
  99:         if (!this.name.equals(order.toString())) {
 100:             return false;
 101:         }
 102:         return true;
 103:     }
 104:    
 105:     /**
 106:      * Ensures that serialization returns the unique instances.
 107:      *
 108:      * @return The object.
 109:      *
 110:      * @throws ObjectStreamException if there is a problem.
 111:      */
 112:     private Object readResolve() throws ObjectStreamException {
 113:         if (this.equals(LegendRenderingOrder.STANDARD)) {
 114:             return LegendRenderingOrder.STANDARD;
 115:         }
 116:         else if (this.equals(LegendRenderingOrder.REVERSE)) {
 117:             return LegendRenderingOrder.REVERSE;
 118:         }     
 119:         return null;
 120:     }
 121: 
 122: }