001/* =========================================================== 002 * JFreeChart : a free chart library for the Java(tm) platform 003 * =========================================================== 004 * 005 * (C) Copyright 2000-2013, by Object Refinery Limited and Contributors. 006 * 007 * Project Info: http://www.jfree.org/jfreechart/index.html 008 * 009 * This library is free software; you can redistribute it and/or modify it 010 * under the terms of the GNU Lesser General Public License as published by 011 * the Free Software Foundation; either version 2.1 of the License, or 012 * (at your option) any later version. 013 * 014 * This library is distributed in the hope that it will be useful, but 015 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY 016 * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public 017 * License for more details. 018 * 019 * You should have received a copy of the GNU Lesser General Public 020 * License along with this library; if not, write to the Free Software 021 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 022 * USA. 023 * 024 * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. 025 * Other names may be trademarks of their respective owners.] 026 * 027 * ----------------------------- 028 * KeyedValueComparatorType.java 029 * ----------------------------- 030 * (C) Copyright 2003-2012, by Object Refinery Limited. 031 * 032 * Original Author: David Gilbert (for Object Refinery Limited); 033 * Contributor(s): -; 034 * 035 * Changes: 036 * -------- 037 * 05-Mar-2003 : Version 1 (DG); 038 * 23-Sep-2012 : Make this class serializable (DG); 039 * 040 */ 041 042package org.jfree.data; 043 044import java.io.Serializable; 045 046/** 047 * Used to indicate the type of a {@link KeyedValueComparator} : 'by key' or 048 * 'by value'. 049 */ 050public final class KeyedValueComparatorType implements Serializable { 051 052 /** An object representing 'by key' sorting. */ 053 public static final KeyedValueComparatorType BY_KEY 054 = new KeyedValueComparatorType("KeyedValueComparatorType.BY_KEY"); 055 056 /** An object representing 'by value' sorting. */ 057 public static final KeyedValueComparatorType BY_VALUE 058 = new KeyedValueComparatorType("KeyedValueComparatorType.BY_VALUE"); 059 060 /** The name. */ 061 private String name; 062 063 /** 064 * Private constructor. 065 * 066 * @param name the name. 067 */ 068 private KeyedValueComparatorType(String name) { 069 this.name = name; 070 } 071 072 /** 073 * Returns a string representing the object. 074 * 075 * @return The string. 076 */ 077 @Override 078 public String toString() { 079 return this.name; 080 } 081 082 /** 083 * Returns <code>true</code> if this object is equal to the specified 084 * object, and <code>false</code> otherwise. 085 * 086 * @param o the other object. 087 * 088 * @return A boolean. 089 */ 090 @Override 091 public boolean equals(Object o) { 092 if (this == o) { 093 return true; 094 } 095 if (!(o instanceof KeyedValueComparatorType)) { 096 return false; 097 } 098 099 KeyedValueComparatorType type = (KeyedValueComparatorType) o; 100 if (!this.name.equals(type.name)) { 101 return false; 102 } 103 104 return true; 105 } 106 107 /** 108 * Returns a hash code. 109 * 110 * @return A hash code. 111 */ 112 @Override 113 public int hashCode() { 114 return this.name.hashCode(); 115 } 116} 117