Source for org.jfree.data.KeyedValueComparatorType

   1: /* ===========================================================
   2:  * JFreeChart : a free chart library for the Java(tm) platform
   3:  * ===========================================================
   4:  *
   5:  * (C) Copyright 2000-2007, 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:  * KeyedValueComparatorType.java
  29:  * -----------------------------
  30:  * (C) Copyright 2003-2007, by Object Refinery Limited.
  31:  *
  32:  * Original Author:  David Gilbert (for Object Refinery Limited);
  33:  * Contributor(s):   -;
  34:  *
  35:  * Changes:
  36:  * --------
  37:  * 05-Mar-2003 : Version 1 (DG);
  38:  *
  39:  */
  40: 
  41: package org.jfree.data;
  42: 
  43: 
  44: /**
  45:  * Used to indicate the type of a {@link KeyedValueComparator} : 'by key' or 
  46:  * 'by value'.
  47:  */
  48: public final class KeyedValueComparatorType {
  49: 
  50:     /** An object representing 'by key' sorting. */
  51:     public static final KeyedValueComparatorType BY_KEY
  52:         = new KeyedValueComparatorType("KeyedValueComparatorType.BY_KEY");
  53: 
  54:     /** An object representing 'by value' sorting. */
  55:     public static final KeyedValueComparatorType BY_VALUE
  56:         = new KeyedValueComparatorType("KeyedValueComparatorType.BY_VALUE");
  57: 
  58:     /** The name. */
  59:     private String name;
  60: 
  61:     /**
  62:      * Private constructor.
  63:      *
  64:      * @param name  the name.
  65:      */
  66:     private KeyedValueComparatorType(String name) {
  67:         this.name = name;
  68:     }
  69: 
  70:     /**
  71:      * Returns a string representing the object.
  72:      *
  73:      * @return The string.
  74:      */
  75:     public String toString() {
  76:         return this.name;
  77:     }
  78: 
  79:     /**
  80:      * Returns <code>true</code> if this object is equal to the specified 
  81:      * object, and <code>false</code> otherwise.
  82:      *
  83:      * @param o  the other object.
  84:      *
  85:      * @return A boolean.
  86:      */
  87:     public boolean equals(Object o) {
  88:         if (this == o) {
  89:             return true;
  90:         }
  91:         if (!(o instanceof KeyedValueComparatorType)) {
  92:             return false;
  93:         }
  94: 
  95:         KeyedValueComparatorType type = (KeyedValueComparatorType) o;
  96:         if (!this.name.equals(type.name)) {
  97:             return false;
  98:         }
  99: 
 100:         return true;
 101:     }
 102: 
 103:     /**
 104:      * Returns a hash code.
 105:      * 
 106:      * @return A hash code.
 107:      */
 108:     public int hashCode() {
 109:         return this.name.hashCode();
 110:     }
 111: }
 112: