Source for org.jfree.ui.VerticalAlignment

   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:  * VerticalAlignment.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: VerticalAlignment.java,v 1.4 2005/10/18 13:18:34 mungady Exp $
  36:  *
  37:  * Changes:
  38:  * --------
  39:  * 08-Jan-2004 : Version 1 (DG);
  40:  * 
  41:  */
  42: 
  43: package org.jfree.ui;
  44: 
  45: import java.io.ObjectStreamException;
  46: import java.io.Serializable;
  47: 
  48: /**
  49:  * An enumeration of the vertical alignment types (<code>TOP</code>, 
  50:  * <code>BOTTOM</code> and <code>CENTER</code>).
  51:  *
  52:  * @author David Gilbert
  53:  */
  54: public final class VerticalAlignment implements Serializable {
  55: 
  56:     /** For serialization. */
  57:     private static final long serialVersionUID = 7272397034325429853L;
  58:     
  59:     /** Top alignment. */
  60:     public static final VerticalAlignment TOP 
  61:         = new VerticalAlignment("VerticalAlignment.TOP");
  62: 
  63:     /** Bottom alignment. */
  64:     public static final VerticalAlignment BOTTOM 
  65:         = new VerticalAlignment("VerticalAlignment.BOTTOM");
  66: 
  67:     /** Center alignment. */
  68:     public static final VerticalAlignment CENTER 
  69:         = new VerticalAlignment("VerticalAlignment.CENTER");
  70: 
  71:     /** The name. */
  72:     private String name;
  73: 
  74:     /**
  75:      * Private constructor.
  76:      *
  77:      * @param name  the name.
  78:      */
  79:     private VerticalAlignment(final String name) {
  80:         this.name = name;
  81:     }
  82: 
  83:     /**
  84:      * Returns a string representing the object.
  85:      *
  86:      * @return the string.
  87:      */
  88:     public String toString() {
  89:         return this.name;
  90:     }
  91: 
  92:     /**
  93:      * Returns <code>true</code> if this object is equal to the specified 
  94:      * object, and <code>false</code> otherwise.
  95:      *
  96:      * @param o  the other object.
  97:      *
  98:      * @return a boolean.
  99:      */
 100:     public boolean equals(final Object o) {
 101: 
 102:         if (this == o) {
 103:             return true;
 104:         }
 105:         if (!(o instanceof VerticalAlignment)) {
 106:             return false;
 107:         }
 108: 
 109:         final VerticalAlignment alignment = (VerticalAlignment) o;
 110:         if (!this.name.equals(alignment.name)) {
 111:             return false;
 112:         }
 113: 
 114:         return true;
 115:     }
 116:     
 117:     /**
 118:      * Returns a hash code value for the object.
 119:      *
 120:      * @return the hashcode
 121:      */
 122:     public int hashCode() {
 123:         return this.name.hashCode();
 124:     }
 125: 
 126:     /**
 127:      * Ensures that serialization returns the unique instances.
 128:      * 
 129:      * @return The object.
 130:      * 
 131:      * @throws ObjectStreamException if there is a problem.
 132:      */
 133:     private Object readResolve() throws ObjectStreamException {
 134:         if (this.equals(VerticalAlignment.TOP)) {
 135:             return VerticalAlignment.TOP;
 136:         }
 137:         else if (this.equals(VerticalAlignment.BOTTOM)) {
 138:             return VerticalAlignment.BOTTOM;
 139:         }
 140:         else if (this.equals(VerticalAlignment.CENTER)) {
 141:             return VerticalAlignment.CENTER;
 142:         }
 143:         else {
 144:             return null;  // this should never happen
 145:         }
 146:     }
 147:     
 148: }