001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-present, by David Gilbert 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-present, by David Gilbert.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.data;
038
039import java.io.Serializable;
040
041/**
042 * Used to indicate the type of a {@link KeyedValueComparator} : 'by key' or
043 * 'by value'.
044 */
045public final class KeyedValueComparatorType implements Serializable {
046
047    /** An object representing 'by key' sorting. */
048    public static final KeyedValueComparatorType BY_KEY
049        = new KeyedValueComparatorType("KeyedValueComparatorType.BY_KEY");
050
051    /** An object representing 'by value' sorting. */
052    public static final KeyedValueComparatorType BY_VALUE
053        = new KeyedValueComparatorType("KeyedValueComparatorType.BY_VALUE");
054
055    /** The name. */
056    private String name;
057
058    /**
059     * Private constructor.
060     *
061     * @param name  the name.
062     */
063    private KeyedValueComparatorType(String name) {
064        this.name = name;
065    }
066
067    /**
068     * Returns a string representing the object.
069     *
070     * @return The string.
071     */
072    @Override
073    public String toString() {
074        return this.name;
075    }
076
077    /**
078     * Returns {@code true} if this object is equal to the specified
079     * object, and {@code false} otherwise.
080     *
081     * @param o  the other object.
082     *
083     * @return A boolean.
084     */
085    @Override
086    public boolean equals(Object o) {
087        if (this == o) {
088            return true;
089        }
090        if (!(o instanceof KeyedValueComparatorType)) {
091            return false;
092        }
093
094        KeyedValueComparatorType type = (KeyedValueComparatorType) o;
095        if (!this.name.equals(type.name)) {
096            return false;
097        }
098
099        return true;
100    }
101
102    /**
103     * Returns a hash code.
104     *
105     * @return A hash code.
106     */
107    @Override
108    public int hashCode() {
109        return this.name.hashCode();
110    }
111}
112