KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jfree > chart > LegendRenderingOrder


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  * LegendRenderingOrder.java
29  * -------------------------
30  * (C) Copyright 2004, 2005, by Object Refinery Limited and Contributors.
31  *
32  * Original Author: Angel;
33  * Contributor(s): -;
34  *
35  * $Id: LegendRenderingOrder.java,v 1.4.2.1 2005/10/25 16:50:20 mungady Exp $
36  *
37  * Changes
38  * -------
39  * 26-Mar-2004 : Version 1 (DG);
40  *
41  */
42
43 package org.jfree.chart;
44
45 import java.io.ObjectStreamException JavaDoc;
46 import java.io.Serializable JavaDoc;
47
48 /**
49  * Represents the order for rendering legend items.
50  */
51 public final class LegendRenderingOrder implements Serializable JavaDoc {
52
53     /** For serialization. */
54     private static final long serialVersionUID = -3832486612685808616L;
55     
56     /** In order. */
57     public static final LegendRenderingOrder STANDARD
58         = new LegendRenderingOrder("LegendRenderingOrder.STANDARD");
59
60     /** In reverse order. */
61     public static final LegendRenderingOrder REVERSE
62         = new LegendRenderingOrder("LegendRenderingOrder.REVERSE");
63
64     /** The name. */
65     private String JavaDoc name;
66
67     /**
68      * Private constructor.
69      *
70      * @param name the name.
71      */
72     private LegendRenderingOrder(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 obj the other object.
90      *
91      * @return A boolean.
92      */
93     public boolean equals(Object JavaDoc obj) {
94         if (this == obj) {
95             return true;
96         }
97         if (!(obj instanceof LegendRenderingOrder)) {
98             return false;
99         }
100         LegendRenderingOrder order = (LegendRenderingOrder) obj;
101         if (!this.name.equals(order.toString())) {
102             return false;
103         }
104         return true;
105     }
106    
107     /**
108      * Ensures that serialization returns the unique instances.
109      *
110      * @return The object.
111      *
112      * @throws ObjectStreamException if there is a problem.
113      */
114     private Object JavaDoc readResolve() throws ObjectStreamException JavaDoc {
115         if (this.equals(LegendRenderingOrder.STANDARD)) {
116             return LegendRenderingOrder.STANDARD;
117         }
118         else if (this.equals(LegendRenderingOrder.REVERSE)) {
119             return LegendRenderingOrder.REVERSE;
120         }
121         return null;
122     }
123
124 }
125
Popular Tags