Frames | No Frames |
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: * AxisLocation.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: AxisLocation.java,v 1.4.2.1 2005/10/25 20:37:34 mungady Exp $ 36: * 37: * Changes: 38: * -------- 39: * 02-May-2003 : Version 1 (DG); 40: * 03-Jul-2003 : Added isTopOrBottom() and isLeftOrRight() methods (DG); 41: * 13-Aug-2003 : Fixed readResolve() bug (id=788202) (DG); 42: * 24-Mar-2004 : Added getOpposite() method (DG); 43: * 44: */ 45: 46: package org.jfree.chart.axis; 47: 48: import java.io.ObjectStreamException; 49: import java.io.Serializable; 50: 51: /** 52: * Used to indicate the location of an axis on a 2D plot, prior to knowing the 53: * orientation of the plot. 54: */ 55: public final class AxisLocation implements Serializable { 56: 57: /** For serialization. */ 58: private static final long serialVersionUID = -3276922179323563410L; 59: 60: /** Axis at the top or left. */ 61: public static final AxisLocation TOP_OR_LEFT = new AxisLocation( 62: "AxisLocation.TOP_OR_LEFT" 63: ); 64: 65: /** Axis at the top or right. */ 66: public static final AxisLocation TOP_OR_RIGHT = new AxisLocation( 67: "AxisLocation.TOP_OR_RIGHT" 68: ); 69: 70: /** Axis at the bottom or left. */ 71: public static final AxisLocation BOTTOM_OR_LEFT = new AxisLocation( 72: "AxisLocation.BOTTOM_OR_LEFT" 73: ); 74: 75: /** Axis at the bottom or right. */ 76: public static final AxisLocation BOTTOM_OR_RIGHT = new AxisLocation( 77: "AxisLocation.BOTTOM_OR_RIGHT" 78: ); 79: 80: /** The name. */ 81: private String name; 82: 83: /** 84: * Private constructor. 85: * 86: * @param name the name. 87: */ 88: private AxisLocation(String name) { 89: this.name = name; 90: } 91: 92: /** 93: * Returns a string representing the object. 94: * 95: * @return The string. 96: */ 97: public String toString() { 98: return this.name; 99: } 100: 101: /** 102: * Returns <code>true</code> if this object is equal to the specified 103: * object, and <code>false</code> otherwise. 104: * 105: * @param obj the other object (<code>null</code> permitted). 106: * 107: * @return A boolean. 108: */ 109: public boolean equals(Object obj) { 110: 111: if (this == obj) { 112: return true; 113: } 114: if (!(obj instanceof AxisLocation)) { 115: return false; 116: } 117: AxisLocation location = (AxisLocation) obj; 118: if (!this.name.equals(location.toString())) { 119: return false; 120: } 121: return true; 122: 123: } 124: 125: /** 126: * Returns the location that is opposite to the supplied location. 127: * 128: * @param location the location (<code>null</code> not permitted). 129: * 130: * @return The opposite location. 131: */ 132: public static AxisLocation getOpposite(AxisLocation location) { 133: if (location == null) { 134: throw new IllegalArgumentException("Null 'location' argument."); 135: } 136: AxisLocation result = null; 137: if (location == AxisLocation.TOP_OR_LEFT) { 138: result = AxisLocation.BOTTOM_OR_RIGHT; 139: } 140: else if (location == AxisLocation.TOP_OR_RIGHT) { 141: result = AxisLocation.BOTTOM_OR_LEFT; 142: } 143: else if (location == AxisLocation.BOTTOM_OR_LEFT) { 144: result = AxisLocation.TOP_OR_RIGHT; 145: } 146: else if (location == AxisLocation.BOTTOM_OR_RIGHT) { 147: result = AxisLocation.TOP_OR_LEFT; 148: } 149: else { 150: throw new IllegalStateException("AxisLocation not recognised."); 151: } 152: return result; 153: } 154: 155: /** 156: * Ensures that serialization returns the unique instances. 157: * 158: * @return The object. 159: * 160: * @throws ObjectStreamException if there is a problem. 161: */ 162: private Object readResolve() throws ObjectStreamException { 163: if (this.equals(AxisLocation.TOP_OR_RIGHT)) { 164: return AxisLocation.TOP_OR_RIGHT; 165: } 166: else if (this.equals(AxisLocation.BOTTOM_OR_RIGHT)) { 167: return AxisLocation.BOTTOM_OR_RIGHT; 168: } 169: else if (this.equals(AxisLocation.TOP_OR_LEFT)) { 170: return AxisLocation.TOP_OR_LEFT; 171: } 172: else if (this.equals(AxisLocation.BOTTOM_OR_LEFT)) { 173: return AxisLocation.BOTTOM_OR_LEFT; 174: } 175: return null; 176: } 177: 178: }