org.jvnet.its
Enum TimePeriodFactory

java.lang.Object
  java.lang.Enum<TimePeriodFactory>
      org.jvnet.its.TimePeriodFactory

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TimePeriodFactory>

public enum TimePeriodFactory
extends java.lang.Enum<TimePeriodFactory>

Given a date, return the TimePeriod that includes the date.

Different instance of the factory uses different time period, which in turn translates to different "bin width" in the final picture.

Author:

Kohsuke Kawaguchi

Enum Constant Summary

MONTH

WEEK

Method Summary

abstract org.jfree.data.time.TimePeriod	toTimePeriod(java.util.Calendar cal)
static TimePeriodFactory	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TimePeriodFactory[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WEEK

public static final TimePeriodFactory WEEK

MONTH

public static final TimePeriodFactory MONTH

Method Detail

values

public static TimePeriodFactory[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (TimePeriodFactory c : TimePeriodFactory.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TimePeriodFactory valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

toTimePeriod

public abstract org.jfree.data.time.TimePeriod toTimePeriod(java.util.Calendar cal)