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 * SortOrder.java
029 * --------------
030 * (C) Copyright 2000-present, by David Gilbert and Contributors.
031 *
032 * Original Author:  David Gilbert;
033 * Contributors:     -;
034 */
035
036package org.jfree.chart.util;
037
038/**
039 * Defines tokens used to indicate sorting order (ascending or descending).
040 */
041public enum SortOrder {
042
043    /** Ascending order. */
044    ASCENDING("SortOrder.ASCENDING"),
045
046    /** Descending order. */
047    DESCENDING("SortOrder.DESCENDING");
048
049    /** The name. */
050    private final String name;
051
052    /**
053     * Private constructor.
054     *
055     * @param name  the name.
056     */
057    SortOrder(String name) {
058        this.name = name;
059    }
060
061    /**
062     * Returns a string representing the object.
063     *
064     * @return The string.
065     */
066    @Override
067    public String toString() {
068        return this.name;
069    }
070
071}