biweekly

Class ICalDataType

java.lang.Object

biweekly.ICalDataType

public class ICalDataType
extends Object

Defines the data type of a property's value.

Author:

Michael Angstadt

See Also:

RFC 5545 p.29-50

Field Summary

Fields

Modifier and Type	Field and Description
static ICalDataType	BINARY Binary data (such as an image or word-processing document).
static ICalDataType	BOOLEAN Boolean value (i.e.
static ICalDataType	CAL_ADDRESS A URI containing a calendar user address (i.e.
static ICalDataType	CONTENT_ID The property value is located in a separate MIME entity (vCal 1.0 only).
static ICalDataType	DATE A date (e.g.
static ICalDataType	DATE_TIME A date/time value (e.g.
static ICalDataType	DURATION A duration of time (e.g.
static ICalDataType	FLOAT A floating point value (e.g.
static ICalDataType	INTEGER An integer value (e.g.
static ICalDataType	PERIOD A period of time (e.g.
static ICalDataType	RECUR A recurrence rule (e.g.
static ICalDataType	TEXT A plain text value.
static ICalDataType	TIME A time value (e.g.
static ICalDataType	URI A URI value.
static ICalDataType	URL A URL (e.g.
static ICalDataType	UTC_OFFSET A UTC-offset (e.g.

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Field Detail

BINARY

public static final ICalDataType BINARY

Binary data (such as an image or word-processing document).

See Also:

RFC 5545 p.30-1, vCal 1.0 p.18

BOOLEAN

public static final ICalDataType BOOLEAN

Boolean value (i.e. "true" or "false").

See Also:

RFC 5545 p.31

CAL_ADDRESS

public static final ICalDataType CAL_ADDRESS

A URI containing a calendar user address (i.e. a "mailto" URI).

See Also:

RFC 5545 p.30-1

CONTENT_ID

public static final ICalDataType CONTENT_ID

The property value is located in a separate MIME entity (vCal 1.0 only).

See Also:

vCal 1.0 p.17

DATE

public static final ICalDataType DATE

A date (e.g. "2014-03-12")

See Also:

RFC 5545 p.32, vCal 1.0 p.16-7

DATE_TIME

public static final ICalDataType DATE_TIME

A date/time value (e.g. "2014-03-12 13:30:00")

See Also:

RFC 5545 p.32-4, vCal 1.0 p.16-7

DURATION

public static final ICalDataType DURATION

A duration of time (e.g. "2 hours, 30 minutes").

See Also:

RFC 5545 p.35-6, vCal 1.0 p.17

FLOAT

public static final ICalDataType FLOAT

A floating point value (e.g. "3.14")

See Also:

RFC 5545 p.36

INTEGER

public static final ICalDataType INTEGER

An integer value (e.g. "42")

See Also:

RFC 5545 p.37

PERIOD

public static final ICalDataType PERIOD

A period of time (e.g. "October 3 through October 5").

See Also:

RFC 5545 p.37-8

RECUR

public static final ICalDataType RECUR

A recurrence rule (e.g. "every Monday at 2pm").

See Also:

RFC 5545 p.38-45, vCal 1.0 p.18-23

TEXT

public static final ICalDataType TEXT

A plain text value.

See Also:

RFC 5545 p.45-6

TIME

public static final ICalDataType TIME

A time value (e.g. "2pm").

See Also:

RFC 5545 p.47-8

URI

public static final ICalDataType URI

A URI value.

See Also:

RFC 5545 p.49

URL

public static final ICalDataType URL

A URL (e.g. "http://example.com/picture.jpg") (vCal 1.0 only).

See Also:

vCal 1.0 p.17-8

UTC_OFFSET

public static final ICalDataType UTC_OFFSET

A UTC-offset (e.g. "+0500").

See Also:

RFC 5545 p.49-50

Method Detail

getName

public String getName()

Gets the name of the data type.

Returns:

the name of the data type (e.g. "TEXT")

toString

public String toString()

Overrides:

toString in class Object

find

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

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

Returns:

the parameter values