org.jfree.chart.axis.DateTickUnitType Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of jfreechart Show documentation
Show all versions of jfreechart Show documentation
JFreeChart is a class library, written in Java, for generating charts.
Utilising the Java2D APIs, it currently supports bar charts, pie charts,
line charts, XY-plots and time series plots.
/* ===========================================================
* JFreeChart : a free chart library for the Java(tm) platform
* ===========================================================
*
* (C) Copyright 2000-2020, by Object Refinery Limited and Contributors.
*
* Project Info: http://www.jfree.org/jfreechart/index.html
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation; either version 2.1 of the License, or
* (at your option) any later version.
*
* This library is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
* USA.
*
* [Oracle and Java are registered trademarks of Oracle and/or its affiliates.
* Other names may be trademarks of their respective owners.]
*
* ---------------------
* DateTickUnitType.java
* ---------------------
* (C) Copyright 2009, by Object Refinery Limited.
*
* Original Author: David Gilbert (for Object Refinery Limited);
* Contributor(s): -;
*
* Changes
* -------
* 09-Jan-2009 : Version 1 (DG);
*
*/
package org.jfree.chart.axis;
import java.io.ObjectStreamException;
import java.io.Serializable;
import java.util.Calendar;
/**
* An enumeration of the unit types for a {@link DateTickUnit} instance.
*
* @since 1.0.13
*/
public class DateTickUnitType implements Serializable {
/** Year. */
public static final DateTickUnitType YEAR
= new DateTickUnitType("DateTickUnitType.YEAR", Calendar.YEAR);
/** Month. */
public static final DateTickUnitType MONTH
= new DateTickUnitType("DateTickUnitType.MONTH", Calendar.MONTH);
/** Day. */
public static final DateTickUnitType DAY
= new DateTickUnitType("DateTickUnitType.DAY", Calendar.DATE);
/** Hour. */
public static final DateTickUnitType HOUR
= new DateTickUnitType("DateTickUnitType.HOUR",
Calendar.HOUR_OF_DAY);
/** Minute. */
public static final DateTickUnitType MINUTE
= new DateTickUnitType("DateTickUnitType.MINUTE", Calendar.MINUTE);
/** Second. */
public static final DateTickUnitType SECOND
= new DateTickUnitType("DateTickUnitType.SECOND", Calendar.SECOND);
/** Millisecond. */
public static final DateTickUnitType MILLISECOND
= new DateTickUnitType("DateTickUnitType.MILLISECOND",
Calendar.MILLISECOND);
/** The name. */
private String name;
/** The corresponding field value in Java's Calendar class. */
private int calendarField;
/**
* Private constructor.
*
* @param name the name.
* @param calendarField the calendar field.
*/
private DateTickUnitType(String name, int calendarField) {
this.name = name;
this.calendarField = calendarField;
}
/**
* Returns the calendar field.
*
* @return The calendar field.
*/
public int getCalendarField() {
return this.calendarField;
}
/**
* Returns a string representing the object.
*
* @return The string.
*/
@Override
public String toString() {
return this.name;
}
/**
* Returns {@code true} if this object is equal to the specified
* object, and {@code false} otherwise.
*
* @param obj the other object.
*
* @return A boolean.
*/
@Override
public boolean equals(Object obj) {
if (this == obj) {
return true;
}
if (!(obj instanceof DateTickUnitType)) {
return false;
}
DateTickUnitType t = (DateTickUnitType) obj;
if (!this.name.equals(t.toString())) {
return false;
}
return true;
}
/**
* Ensures that serialization returns the unique instances.
*
* @return The object.
*
* @throws ObjectStreamException if there is a problem.
*/
private Object readResolve() throws ObjectStreamException {
if (this.equals(DateTickUnitType.YEAR)) {
return DateTickUnitType.YEAR;
}
else if (this.equals(DateTickUnitType.MONTH)) {
return DateTickUnitType.MONTH;
}
else if (this.equals(DateTickUnitType.DAY)) {
return DateTickUnitType.DAY;
}
else if (this.equals(DateTickUnitType.HOUR)) {
return DateTickUnitType.HOUR;
}
else if (this.equals(DateTickUnitType.MINUTE)) {
return DateTickUnitType.MINUTE;
}
else if (this.equals(DateTickUnitType.SECOND)) {
return DateTickUnitType.SECOND;
}
else if (this.equals(DateTickUnitType.MILLISECOND)) {
return DateTickUnitType.MILLISECOND;
}
return null;
}
}