KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jfree > data > KeyedValueComparatorType


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  * KeyedValueComparatorType.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: KeyedValueComparatorType.java,v 1.3 2005/03/28 19:40:26 mungady Exp $
35  *
36  * Changes:
37  * --------
38  * 05-Mar-2003 : Version 1 (DG);
39  *
40  */
41
42 package org.jfree.data;
43
44
45 /**
46  * Used to indicate the type of a {@link KeyedValueComparator} : 'by key' or
47  * 'by value'.
48  */
49 public final class KeyedValueComparatorType {
50
51     /** An object representing 'by key' sorting. */
52     public static final KeyedValueComparatorType BY_KEY
53         = new KeyedValueComparatorType("KeyedValueComparatorType.BY_KEY");
54
55     /** An object representing 'by value' sorting. */
56     public static final KeyedValueComparatorType BY_VALUE
57         = new KeyedValueComparatorType("KeyedValueComparatorType.BY_VALUE");
58
59     /** The name. */
60     private String JavaDoc name;
61
62     /**
63      * Private constructor.
64      *
65      * @param name the name.
66      */
67     private KeyedValueComparatorType(String JavaDoc name) {
68         this.name = name;
69     }
70
71     /**
72      * Returns a string representing the object.
73      *
74      * @return The string.
75      */
76     public String JavaDoc toString() {
77         return this.name;
78     }
79
80     /**
81      * Returns <code>true</code> if this object is equal to the specified
82      * object, and <code>false</code> otherwise.
83      *
84      * @param o the other object.
85      *
86      * @return A boolean.
87      */
88     public boolean equals(Object JavaDoc o) {
89         if (this == o) {
90             return true;
91         }
92         if (!(o instanceof KeyedValueComparatorType)) {
93             return false;
94         }
95
96         KeyedValueComparatorType type = (KeyedValueComparatorType) o;
97         if (!this.name.equals(type.name)) {
98             return false;
99         }
100
101         return true;
102     }
103
104     /**
105      * Returns a hash code.
106      *
107      * @return A hash code.
108      */
109     public int hashCode() {
110         return this.name.hashCode();
111     }
112 }
113
114
Popular Tags