001/* ===========================================================
002 * JFreeChart : a free chart library for the Java(tm) platform
003 * ===========================================================
004 *
005 * (C) Copyright 2000-2022, 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 * DateTickUnitType.java
029 * ---------------------
030 * (C) Copyright 2009-2022, by David Gilbert.
031 *
032 * Original Author:  David Gilbert;
033 * Contributor(s):   -;
034 *
035 */
036
037package org.jfree.chart.axis;
038
039import java.util.Calendar;
040
041/**
042 * An enumeration of the unit types for a {@link DateTickUnit} instance.
043 */
044public enum DateTickUnitType {
045
046    /** Year. */
047    YEAR(Calendar.YEAR),
048
049    /** Month. */
050    MONTH( Calendar.MONTH),
051
052    /** Day. */
053    DAY( Calendar.DATE),
054
055    /** Hour. */
056    HOUR(Calendar.HOUR_OF_DAY),
057
058    /** Minute. */
059    MINUTE(Calendar.MINUTE),
060
061    /** Second. */
062    SECOND(Calendar.SECOND),
063
064    /** Millisecond. */
065    MILLISECOND(Calendar.MILLISECOND);
066
067    /** The corresponding field value in Java's Calendar class. */
068    private int calendarField;
069
070    /**
071     * Private constructor.
072     *
073     * @param calendarField  the calendar field.
074     */
075    DateTickUnitType(int calendarField) {
076        this.calendarField = calendarField;
077    }
078
079    /**
080     * Returns the calendar field.
081     *
082     * @return The calendar field.
083     */
084    public int getCalendarField() {
085        return this.calendarField;
086    }
087
088}