biweekly.parameter

Class ParticipationLevel

java.lang.Object

biweekly.parameter.ParticipationLevel

public class ParticipationLevel
extends Object

Defines what level of participation is expected from a calendar user. Note that this class does not correspond to a particular parameter. The parameter varies depending on the iCalendar version.

Author:

Michael Angstadt

See Also:

RFC 5545 p.25-6, vCal 1.0 p.26-7

Field Summary

Fields

Modifier and Type	Field and Description
static ParticipationLevel	FYI Indicates that the user has been notified about the event for informational purposes only and does not need to attend.
static ParticipationLevel	OPTIONAL Indicates that the user's participation is optional.
static ParticipationLevel	REQUIRED Indicates that the user's participation is required.

Method Summary

Methods

Modifier and Type	Method and Description
static Collection<ParticipationLevel>	all() Gets all of the parameter values that are defined as static constants in this class.
static ParticipationLevel	find(String value) Searches for a parameter value that is defined as a static constant in this class.
static ParticipationLevel	get(String value) Searches for a parameter value and creates one if it cannot be found.
String	getValue(ICalVersion version) Gets the value of the parameter

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REQUIRED

public static final ParticipationLevel REQUIRED

Indicates that the user's participation is required.

OPTIONAL

public static final ParticipationLevel OPTIONAL

Indicates that the user's participation is optional.

FYI

public static final ParticipationLevel FYI

Indicates that the user has been notified about the event for informational purposes only and does not need to attend.

Method Detail

getValue

public String getValue(ICalVersion version)

Gets the value of the parameter

Parameters:

version - the version

Returns:

the parameter value

find

public static ParticipationLevel find(String value)

Searches for a parameter value that is defined as a static constant in this class.

Parameters:

value - the parameter value

Returns:

the object or null if not found

get

public static ParticipationLevel get(String value)

Searches for a parameter value and creates one if it cannot be found. All objects are guaranteed to be unique, so they can be compared with == equality.

Parameters:

value - the parameter value

Returns:

the object

all

public static Collection<ParticipationLevel> all()

Gets all of the parameter values that are defined as static constants in this class.

Returns:

the parameter values