Package org.bedework.calfacade

Enum Class RecurringRetrievalMode.Rmode

java.lang.Object

java.lang.Enum<RecurringRetrievalMode.Rmode>

org.bedework.calfacade.RecurringRetrievalMode.Rmode

All Implemented Interfaces:

Serializable, Comparable<RecurringRetrievalMode.Rmode>, Constable

Enclosing class:

RecurringRetrievalMode

public static enum RecurringRetrievalMode.Rmode
extends Enum<RecurringRetrievalMode.Rmode>

Values which define how to retrieve events. For recurring events we have the following choices (derived from caldav)

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
entityOnly	return the single entity or instance only.
expanded	return all instances within the time range as individual events.
overrides	return the master event and overrides only (start and end may be specified)

Method Summary

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

expanded

public static final RecurringRetrievalMode.Rmode expanded

return all instances within the time range as individual events.

For CalDAV, convert all times to UTC. No timezone information is returned.

We use this a lot in bedework to return all events within a given time period. We display the times with all timezone information however.

overrides

public static final RecurringRetrievalMode.Rmode overrides

return the master event and overrides only (start and end may be specified)

entityOnly

public static final RecurringRetrievalMode.Rmode entityOnly

return the single entity or instance only.

Method Details

values

public static RecurringRetrievalMode.Rmode[] 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 RecurringRetrievalMode.Rmode 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