Module ical4j.core

Package net.fortuna.ical4j.transform.recurrence

Enum Class Frequency

java.lang.Object

java.lang.Enum<Frequency>

net.fortuna.ical4j.transform.recurrence.Frequency

All Implemented Interfaces:

Serializable, Comparable<Frequency>, java.lang.constant.Constable

public enum Frequency
extends Enum<Frequency>

Represents the possible expansion rules used to generate recurrences. From RFC5545:

       The FREQ rule part identifies the type of recurrence rule.  This
       rule part MUST be specified in the recurrence rule.  Valid values
       include SECONDLY, to specify repeating events based on an interval
       of a second or more; MINUTELY, to specify repeating events based
       on an interval of a minute or more; HOURLY, to specify repeating
       events based on an interval of an hour or more; DAILY, to specify
       repeating events based on an interval of a day or more; WEEKLY, to
       specify repeating events based on an interval of a week or more;
       MONTHLY, to specify repeating events based on an interval of a
       month or more; and YEARLY, to specify repeating events based on an
       interval of a year or more.
 

See rfc5545 for more details.

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 Frequency	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Frequency[]	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

SECONDLY

public static final Frequency SECONDLY

MINUTELY

public static final Frequency MINUTELY

HOURLY

public static final Frequency HOURLY

DAILY

public static final Frequency DAILY

WEEKLY

public static final Frequency WEEKLY

MONTHLY

public static final Frequency MONTHLY

YEARLY

public static final Frequency YEARLY

Method Details

values

public static Frequency[] 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 Frequency 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