com.google.ical.values

Enum Frequency

java.lang.Object

java.lang.Enum<Frequency>

com.google.ical.values.Frequency

All Implemented Interfaces:

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

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

possible recurrence frequencies. Names correspond to RFC2445 literals.

According to section 4.3.10 of RFC 2445:

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.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DAILY
HOURLY
MINUTELY
MONTHLY
SECONDLY
WEEKLY
YEARLY

Method Summary

Methods

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

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 Detail

values

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

Returns:

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

valueOf

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