Source for org.jfree.util.TableOrder

   1: /* ========================================================================
   2:  * JCommon : a free general purpose class 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/jcommon/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:  * TableOrder.java
  29:  * ---------------
  30:  * (C) Copyright 2004, 2005, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * $Id: TableOrder.java,v 1.5 2005/10/18 13:24:19 mungady Exp $
  36:  *
  37:  * Changes:
  38:  * --------
  39:  * 29-Jan-2004 : Version 1 (DG);
  40:  * 
  41:  */
  42: 
  43: package org.jfree.util;
  44: 
  45: import java.io.ObjectStreamException;
  46: import java.io.Serializable;
  47: 
  48: /**
  49:  * Used to indicate the processing order for a table (by row or by column).
  50:  *
  51:  * @author David Gilbert
  52:  */
  53: public final class TableOrder implements Serializable {
  54: 
  55:     /** For serialization. */
  56:     private static final long serialVersionUID = 525193294068177057L;
  57:     
  58:     /** By row. */
  59:     public static final TableOrder BY_ROW = new TableOrder("TableOrder.BY_ROW");
  60: 
  61:     /** By column. */
  62:     public static final TableOrder BY_COLUMN 
  63:         = new TableOrder("TableOrder.BY_COLUMN");
  64: 
  65:     /** The name. */
  66:     private String name;
  67: 
  68:     /**
  69:      * Private constructor.
  70:      *
  71:      * @param name  the name.
  72:      */
  73:     private TableOrder(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 obj  the other object.
  91:      *
  92:      * @return A boolean.
  93:      */
  94:     public boolean equals(Object obj) {
  95:         if (this == obj) {
  96:             return true;
  97:         }
  98:         if (!(obj instanceof TableOrder)) {
  99:             return false;
 100:         }
 101:         TableOrder that = (TableOrder) obj;
 102:         if (!this.name.equals(that.name)) {
 103:             return false;
 104:         }
 105:         return true;
 106:     }
 107: 
 108:     /**
 109:      * Returns a hash code value for the object.
 110:      *
 111:      * @return The hashcode
 112:      */
 113:     public int hashCode() {
 114:         return this.name.hashCode();
 115:     }
 116: 
 117:     /**
 118:      * Ensures that serialization returns the unique instances.
 119:      * 
 120:      * @return The object.
 121:      * 
 122:      * @throws ObjectStreamException if there is a problem.
 123:      */
 124:     private Object readResolve() throws ObjectStreamException {
 125:         if (this.equals(TableOrder.BY_ROW)) {
 126:             return TableOrder.BY_ROW;
 127:         }
 128:         else if (this.equals(TableOrder.BY_COLUMN)) {
 129:             return TableOrder.BY_COLUMN;
 130:         }
 131:         return null;
 132:     }
 133:     
 134: }