com.atlassian.scheduler.caesium.cron.rule

Enum DateTimeTemplate.Field

java.lang.Object

java.lang.Enum<DateTimeTemplate.Field>

com.atlassian.scheduler.caesium.cron.rule.DateTimeTemplate.Field

All Implemented Interfaces:

Serializable, Comparable<DateTimeTemplate.Field>

Enclosing class:

DateTimeTemplate

public static enum DateTimeTemplate.Field
extends Enum<DateTimeTemplate.Field>

Represent one of the base fields of date information.

As such, this is parallel to Joda-time's DateTimeFieldType, but with the fields mapped to our simpler DateTimeTemplate value holder.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAY
HOUR
MINUTE
MONTH
SECOND
YEAR

Method Summary

Modifier and Type	Method and Description
abstract int	get(DateTimeTemplate dateTime)
int	getMaximumValue()
int	getMinimumValue()
abstract void	set(DateTimeTemplate dateTime, int value)
static DateTimeTemplate.Field	valueOf(String name) Returns the enum constant of this type with the specified name.
static DateTimeTemplate.Field[]	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

YEAR

public static final DateTimeTemplate.Field YEAR

MONTH

public static final DateTimeTemplate.Field MONTH

DAY

public static final DateTimeTemplate.Field DAY

HOUR

public static final DateTimeTemplate.Field HOUR

MINUTE

public static final DateTimeTemplate.Field MINUTE

SECOND

public static final DateTimeTemplate.Field SECOND

Method Detail

values

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

Returns:

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

valueOf

public static DateTimeTemplate.Field 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

get

public abstract int get(DateTimeTemplate dateTime)

set

public abstract void set(DateTimeTemplate dateTime,
                         int value)

getMinimumValue

public int getMinimumValue()

getMaximumValue

public int getMaximumValue()