001: /* ========================================================================
002: * JCommon : a free general purpose class library for the Java(tm) platform
003: * ========================================================================
004: *
005: * (C) Copyright 2000-2005, by Object Refinery Limited and Contributors.
006: *
007: * Project Info: http://www.jfree.org/jcommon/index.html
008: *
009: * This library is free software; you can redistribute it and/or modify it
010: * under the terms of the GNU Lesser General Public License as published by
011: * the Free Software Foundation; either version 2.1 of the License, or
012: * (at your option) any later version.
013: *
014: * This library is distributed in the hope that it will be useful, but
015: * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
016: * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
017: * License for more details.
018: *
019: * You should have received a copy of the GNU Lesser General Public
020: * License along with this library; if not, write to the Free Software
021: * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
022: * USA.
023: *
024: * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
025: * in the United States and other countries.]
026: *
027: * ---------------
028: * TableOrder.java
029: * ---------------
030: * (C) Copyright 2004, 2005, by Object Refinery Limited.
031: *
032: * Original Author: David Gilbert (for Object Refinery Limited);
033: * Contributor(s): -;
034: *
035: * $Id: TableOrder.java,v 1.5 2005/10/18 13:24:19 mungady Exp $
036: *
037: * Changes:
038: * --------
039: * 29-Jan-2004 : Version 1 (DG);
040: *
041: */
042:
043: package org.jfree.util;
044:
045: import java.io.ObjectStreamException;
046: import java.io.Serializable;
047:
048: /**
049: * Used to indicate the processing order for a table (by row or by column).
050: *
051: * @author David Gilbert
052: */
053: public final class TableOrder implements Serializable {
054:
055: /** For serialization. */
056: private static final long serialVersionUID = 525193294068177057L;
057:
058: /** By row. */
059: public static final TableOrder BY_ROW = new TableOrder(
060: "TableOrder.BY_ROW");
061:
062: /** By column. */
063: public static final TableOrder BY_COLUMN = new TableOrder(
064: "TableOrder.BY_COLUMN");
065:
066: /** The name. */
067: private String name;
068:
069: /**
070: * Private constructor.
071: *
072: * @param name the name.
073: */
074: private TableOrder(String name) {
075: this .name = name;
076: }
077:
078: /**
079: * Returns a string representing the object.
080: *
081: * @return The string.
082: */
083: public String toString() {
084: return this .name;
085: }
086:
087: /**
088: * Returns <code>true</code> if this object is equal to the specified
089: * object, and <code>false</code> otherwise.
090: *
091: * @param obj the other object.
092: *
093: * @return A boolean.
094: */
095: public boolean equals(Object obj) {
096: if (this == obj) {
097: return true;
098: }
099: if (!(obj instanceof TableOrder)) {
100: return false;
101: }
102: TableOrder that = (TableOrder) obj;
103: if (!this .name.equals(that.name)) {
104: return false;
105: }
106: return true;
107: }
108:
109: /**
110: * Returns a hash code value for the object.
111: *
112: * @return The hashcode
113: */
114: public int hashCode() {
115: return this .name.hashCode();
116: }
117:
118: /**
119: * Ensures that serialization returns the unique instances.
120: *
121: * @return The object.
122: *
123: * @throws ObjectStreamException if there is a problem.
124: */
125: private Object readResolve() throws ObjectStreamException {
126: if (this.equals(TableOrder.BY_ROW)) {
127: return TableOrder.BY_ROW;
128: } else if (this.equals(TableOrder.BY_COLUMN)) {
129: return TableOrder.BY_COLUMN;
130: }
131: return null;
132: }
133:
134: }
|