biweekly.parameter

Class Role

java.lang.Object

biweekly.parameter.EnumParameterValue

biweekly.parameter.VersionedEnumParameterValue

biweekly.parameter.Role

public class Role
extends VersionedEnumParameterValue

Defines the role that a calendar user holds.

Author:

Michael Angstadt

See Also:

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

Field Summary

Fields

Modifier and Type	Field and Description
static Role	ATTENDEE Indicates that the user is an attendee of the calendar entity.
static Role	CHAIR Indicates that the user is the chair of the calendar entity.
static Role	DELEGATE Indicates that the user is a delegate of another attendee.
static Role	ORGANIZER Indicates that the user is the organizer of the calendar entity.
static Role	OWNER Indicates that the user is the owner of the calendar entity.

Fields inherited from class biweekly.parameter.VersionedEnumParameterValue

supportedVersions

Fields inherited from class biweekly.parameter.EnumParameterValue

value

Method Summary

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

Methods inherited from class biweekly.parameter.VersionedEnumParameterValue

isSupported

Methods inherited from class biweekly.parameter.EnumParameterValue

getValue, toString

Methods inherited from class java.lang.Object

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

Field Detail

CHAIR

public static final Role CHAIR

Indicates that the user is the chair of the calendar entity.

Supported versions: 2.0

ATTENDEE

public static final Role ATTENDEE

Indicates that the user is an attendee of the calendar entity.

Supported versions: 1.0

ORGANIZER

public static final Role ORGANIZER

Indicates that the user is the organizer of the calendar entity.

Supported versions: 1.0

OWNER

public static final Role OWNER

Indicates that the user is the owner of the calendar entity.

Supported versions: 1.0

DELEGATE

public static final Role DELEGATE

Indicates that the user is a delegate of another attendee.

Supported versions: 1.0

Method Detail

find

public static Role 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 Role 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<Role> all()

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

Returns:

the parameter values