1 /* =========================================================== 2 * JFreeChart : a free chart library for the Java(tm) platform 3 * =========================================================== 4 * 5 * (C) Copyright 2000-2013, 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 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 25 * Other names may be trademarks of their respective owners.] 26 * 27 * ----------------- 28 * AxisLocation.java 29 * ----------------- 30 * (C) Copyright 2003-2013, by Object Refinery Limited and Contributors. 31 * 32 * Original Author: David Gilbert (for Object Refinery Limited); 33 * Contributor(s): Nick Guenther; 34 * 35 * Changes: 36 * -------- 37 * 02-May-2003 : Version 1 (DG); 38 * 03-Jul-2003 : Added isTopOrBottom() and isLeftOrRight() methods (DG); 39 * 13-Aug-2003 : Fixed readResolve() bug (id=788202) (DG); 40 * 24-Mar-2004 : Added static getOpposite() method (DG); 41 * ------------- JFREECHART 1.0.x --------------------------------------------- 42 * 22-Mar-2007 : Added getOpposite() method, suggested by Nick Guenther (DG); 43 * 02-Jul-2013 : Use ParamChecks (DG); 44 * 45 */ 46 47 package org.jfree.chart.axis; 48 49 import java.io.ObjectStreamException; 50 import java.io.Serializable; 51 import org.jfree.chart.util.ParamChecks; 52 53 /** 54 * Used to indicate the location of an axis on a 2D plot, prior to knowing the 55 * orientation of the plot. 56 */ 57 public final class AxisLocation implements Serializable { 58 59 /** For serialization. */ 60 private static final long serialVersionUID = -3276922179323563410L; 61 62 /** Axis at the top or left. */ 63 public static final AxisLocation TOP_OR_LEFT = new AxisLocation( 64 "AxisLocation.TOP_OR_LEFT"); 65 66 /** Axis at the top or right. */ 67 public static final AxisLocation TOP_OR_RIGHT = new AxisLocation( 68 "AxisLocation.TOP_OR_RIGHT"); 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 /** Axis at the bottom or right. */ 75 public static final AxisLocation BOTTOM_OR_RIGHT = new AxisLocation( 76 "AxisLocation.BOTTOM_OR_RIGHT"); 77 78 /** The name. */ 79 private String name; 80 81 /** 82 * Private constructor. 83 * 84 * @param name the name. 85 */ AxisLocation(String name)86 private AxisLocation(String name) { 87 this.name = name; 88 } 89 90 /** 91 * Returns the location that is opposite to this location. 92 * 93 * @return The opposite location. 94 * 95 * @since 1.0.5 96 */ getOpposite()97 public AxisLocation getOpposite() { 98 return getOpposite(this); 99 } 100 101 /** 102 * Returns a string representing the object. 103 * 104 * @return The string. 105 */ 106 @Override toString()107 public String toString() { 108 return this.name; 109 } 110 111 /** 112 * Returns <code>true</code> if this object is equal to the specified 113 * object, and <code>false</code> otherwise. 114 * 115 * @param obj the other object (<code>null</code> permitted). 116 * 117 * @return A boolean. 118 */ 119 @Override equals(Object obj)120 public boolean equals(Object obj) { 121 if (this == obj) { 122 return true; 123 } 124 if (!(obj instanceof AxisLocation)) { 125 return false; 126 } 127 AxisLocation location = (AxisLocation) obj; 128 if (!this.name.equals(location.toString())) { 129 return false; 130 } 131 return true; 132 } 133 134 /** 135 * Returns a hash code for this instance. 136 * 137 * @return A hash code. 138 */ 139 @Override hashCode()140 public int hashCode() { 141 int hash = 5; 142 hash = 83 * hash + this.name.hashCode(); 143 return hash; 144 } 145 146 /** 147 * Returns the location that is opposite to the supplied location. 148 * 149 * @param location the location (<code>null</code> not permitted). 150 * 151 * @return The opposite location. 152 */ getOpposite(AxisLocation location)153 public static AxisLocation getOpposite(AxisLocation location) { 154 ParamChecks.nullNotPermitted(location, "location"); 155 AxisLocation result = null; 156 if (location == AxisLocation.TOP_OR_LEFT) { 157 result = AxisLocation.BOTTOM_OR_RIGHT; 158 } 159 else if (location == AxisLocation.TOP_OR_RIGHT) { 160 result = AxisLocation.BOTTOM_OR_LEFT; 161 } 162 else if (location == AxisLocation.BOTTOM_OR_LEFT) { 163 result = AxisLocation.TOP_OR_RIGHT; 164 } 165 else if (location == AxisLocation.BOTTOM_OR_RIGHT) { 166 result = AxisLocation.TOP_OR_LEFT; 167 } 168 else { 169 throw new IllegalStateException("AxisLocation not recognised."); 170 } 171 return result; 172 } 173 174 /** 175 * Ensures that serialization returns the unique instances. 176 * 177 * @return The object. 178 * 179 * @throws ObjectStreamException if there is a problem. 180 */ readResolve()181 private Object readResolve() throws ObjectStreamException { 182 if (this.equals(AxisLocation.TOP_OR_RIGHT)) { 183 return AxisLocation.TOP_OR_RIGHT; 184 } 185 else if (this.equals(AxisLocation.BOTTOM_OR_RIGHT)) { 186 return AxisLocation.BOTTOM_OR_RIGHT; 187 } 188 else if (this.equals(AxisLocation.TOP_OR_LEFT)) { 189 return AxisLocation.TOP_OR_LEFT; 190 } 191 else if (this.equals(AxisLocation.BOTTOM_OR_LEFT)) { 192 return AxisLocation.BOTTOM_OR_LEFT; 193 } 194 return null; 195 } 196 197 } 198