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
029package org.jfree.chart.util;
030
031/**
032 * Represents a direction of rotation ({@code CLOCKWISE} or 
033 * {@code ANTICLOCKWISE}).
034 */
035public enum Rotation {
036
037    /** Clockwise. */
038    CLOCKWISE("Rotation.CLOCKWISE", -1.0),
039
040    /** The reverse order renders the primary dataset first. */
041    ANTICLOCKWISE("Rotation.ANTICLOCKWISE", 1.0);
042
043    /** The name. */
044    private String name;
045
046    /**
047     * The factor (-1.0 for {@code CLOCKWISE} and 1.0 for
048     * {@code ANTICLOCKWISE}).
049     */
050    private double factor;
051
052    /**
053     * Private constructor.
054     *
055     * @param name  the name.
056     * @param factor  the rotation factor.
057     */
058    Rotation(String name, double factor) {
059        this.name = name;
060        this.factor = factor;
061    }
062
063    /**
064     * Returns a string representing the object.
065     *
066     * @return the string (never {@code null}).
067     */
068    @Override
069    public String toString() {
070        return this.name;
071    }
072
073    /**
074     * Returns the rotation factor, which is -1.0 for {@code CLOCKWISE}
075     * and 1.0 for {@code ANTICLOCKWISE}.
076     *
077     * @return the rotation factor.
078     */
079    public double getFactor() {
080        return this.factor;
081    }
082}
083