org.pojava.datetime

Enum CalendarUnit

java.lang.Object

java.lang.Enum<CalendarUnit>

org.pojava.datetime.CalendarUnit

All Implemented Interfaces:

Serializable, Comparable<CalendarUnit>

public enum CalendarUnit
extends Enum<CalendarUnit>

A CalendarUnit represents a time interval whose duration is allowed to vary in order to adjust to Daylight Saving Time where needed.

The fundamental difference between CalendarUnit and Duration is that calculations performed with CalendarUnit will seek to match an equivalent time of day should a DST to non-DST boundary be crossed, whereas calculations with Duration will simply add a fixed unit of time.

Author:

John Pile

Enum Constant Summary

Enum Constants

Enum Constant and Description
CENTURY
DAY
HOUR
MICROSECOND
MILLISECOND
MINUTE
MONTH
NANOSECOND
QUARTER
SECOND
WEEK
YEAR

Method Summary

Methods

Modifier and Type	Method and Description
static CalendarUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static CalendarUnit[]	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

NANOSECOND

public static final CalendarUnit NANOSECOND

MICROSECOND

public static final CalendarUnit MICROSECOND

MILLISECOND

public static final CalendarUnit MILLISECOND

SECOND

public static final CalendarUnit SECOND

MINUTE

public static final CalendarUnit MINUTE

HOUR

public static final CalendarUnit HOUR

DAY

public static final CalendarUnit DAY

WEEK

public static final CalendarUnit WEEK

MONTH

public static final CalendarUnit MONTH

QUARTER

public static final CalendarUnit QUARTER

YEAR

public static final CalendarUnit YEAR

CENTURY

public static final CalendarUnit CENTURY

Method Detail

values

public static CalendarUnit[] 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 (CalendarUnit c : CalendarUnit.values())
    System.out.println(c);

Returns:

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

valueOf

public static CalendarUnit valueOf(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:

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

NullPointerException - if the argument is null