KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jfree > chart > plot > PlotOrientation


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 License
20  * along with this library; if not, write to the Free Software Foundation,
21  * Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
22  *
23  * [Java is a trademark or registered trademark of Sun Microsystems, Inc.
24  * in the United States and other countries.]
25  *
26  * --------------------
27  * PlotOrientation.java
28  * --------------------
29  * (C) Copyright 2003-2005, by Object Refinery Limited.
30  *
31  * Original Author: David Gilbert (for Object Refinery Limited);
32  * Contributor(s): -;
33  *
34  * $Id: PlotOrientation.java,v 1.4 2005/05/19 14:03:41 mungady Exp $
35  *
36  * Changes:
37  * --------
38  * 02-May-2003 : Version 1 (DG);
39  * 17-Jul-2003 : Added readResolve() method (DG);
40  *
41  */
42
43 package org.jfree.chart.plot;
44
45 import java.io.ObjectStreamException JavaDoc;
46 import java.io.Serializable JavaDoc;
47
48 /**
49  * Used to indicate the orientation (horizontal or vertical) of a 2D plot.
50  */
51 public final class PlotOrientation implements Serializable JavaDoc {
52
53     /** For serialization. */
54     private static final long serialVersionUID = -2508771828190337782L;
55     
56     /** For a plot where the range axis is horizontal. */
57     public static final PlotOrientation HORIZONTAL
58         = new PlotOrientation("PlotOrientation.HORIZONTAL");
59
60     /** For a plot where the range axis is vertical. */
61     public static final PlotOrientation VERTICAL
62         = new PlotOrientation("PlotOrientation.VERTICAL");
63
64     /** The name. */
65     private String JavaDoc name;
66
67     /**
68      * Private constructor.
69      *
70      * @param name the name.
71      */
72     private PlotOrientation(String JavaDoc name) {
73         this.name = name;
74     }
75
76     /**
77      * Returns a string representing the object.
78      *
79      * @return The string.
80      */
81     public String JavaDoc toString() {
82         return this.name;
83     }
84
85     /**
86      * Returns <code>true</code> if this object is equal to the specified
87      * object, and <code>false</code> otherwise.
88      *
89      * @param o the other object.
90      *
91      * @return A boolean.
92      */
93     public boolean equals(Object JavaDoc o) {
94
95         if (this == o) {
96             return true;
97         }
98         if (!(o instanceof PlotOrientation)) {
99             return false;
100         }
101
102         PlotOrientation orientation = (PlotOrientation) o;
103         if (!this.name.equals(orientation.toString())) {
104             return false;
105         }
106
107         return true;
108
109     }
110     
111     /**
112      * Ensures that serialization returns the unique instances.
113      *
114      * @return The object.
115      *
116      * @throws ObjectStreamException if there is a problem.
117      */
118     private Object JavaDoc readResolve() throws ObjectStreamException JavaDoc {
119         Object JavaDoc result = null;
120         if (this.equals(PlotOrientation.HORIZONTAL)) {
121             result = PlotOrientation.HORIZONTAL;
122         }
123         else if (this.equals(PlotOrientation.VERTICAL)) {
124             result = PlotOrientation.VERTICAL;
125         }
126         return result;
127     }
128
129 }
130
Popular Tags