Package org.dmfs.rfc5545.recur

Enum Class Freq

java.lang.Object

java.lang.Enum<Freq>

org.dmfs.rfc5545.recur.Freq

All Implemented Interfaces:

Serializable, Comparable<Freq>, Constable

public enum Freq
extends Enum<Freq>

Enumeration of valid FREQ values. Each value provides methods to get the successor of a given date based the respective frequency an a given interval.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
DAILY
HOURLY
MINUTELY
MONTHLY
SECONDLY
WEEKLY
YEARLY

Method Summary

Modifier and Type	Method	Description
static Freq	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Freq[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

YEARLY

public static final Freq YEARLY

MONTHLY

public static final Freq MONTHLY

WEEKLY

public static final Freq WEEKLY

DAILY

public static final Freq DAILY

HOURLY

public static final Freq HOURLY

MINUTELY

public static final Freq MINUTELY

SECONDLY

public static final Freq SECONDLY

Method Details

values

public static Freq[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Freq valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null