com.google.ical.values

Enum IcalValueType

java.lang.Object

java.lang.Enum<IcalValueType>

com.google.ical.values.IcalValueType

All Implemented Interfaces:

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

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

a value type for an Ical property.

 4.2.20 Value Data Types

 Parameter Name: VALUE

 Purpose: To explicitly specify the data type format for a property value.

 Format Definition: The "VALUE" property parameter is defined by the
 following notation:

      valuetypeparam = "VALUE" "=" valuetype

      valuetype  = ("BINARY"
                 / "BOOLEAN"
                 / "CAL-ADDRESS"
                 / "DATE"
                 / "DATE-TIME"
                 / "DURATION"
                 / "FLOAT"
                 / "INTEGER"
                 / "PERIOD"
                 / "RECUR"
                 / "TEXT"
                 / "TIME"
                 / "URI"
                 / "UTC-OFFSET"
                 / x-name
                 ; Some experimental iCalendar data type.
                 / iana-token)
                 ; Some other IANA registered iCalendar data type.


 Description: The parameter specifies the data type and format of the property
 value. The property values MUST be of a single value type. For example, a
 "RDATE" property cannot have a combination of DATE- TIME and TIME value
 types.

 If the property's value is the default value type, then this parameter need
 not be specified. However, if the property's default value type is overridden
 by some other allowable value type, then this parameter MUST be specified.
 

Enum Constant Summary

Enum Constants

Enum Constant and Description
BINARY
BOOLEAN
CAL_ADDRESS
DATE
DATE_TIME
DURATION
FLOAT
INTEGER
OTHER
PERIOD
RECUR
TEXT
TIME
URI
UTC_OFFSET
X_NAME

Method Summary

Methods

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

BINARY

public static final IcalValueType BINARY

BOOLEAN

public static final IcalValueType BOOLEAN

CAL_ADDRESS

public static final IcalValueType CAL_ADDRESS

DATE

public static final IcalValueType DATE

DATE_TIME

public static final IcalValueType DATE_TIME

DURATION

public static final IcalValueType DURATION

FLOAT

public static final IcalValueType FLOAT

INTEGER

public static final IcalValueType INTEGER

PERIOD

public static final IcalValueType PERIOD

RECUR

public static final IcalValueType RECUR

TEXT

public static final IcalValueType TEXT

TIME

public static final IcalValueType TIME

URI

public static final IcalValueType URI

UTC_OFFSET

public static final IcalValueType UTC_OFFSET

X_NAME

public static final IcalValueType X_NAME

OTHER

public static final IcalValueType OTHER

Method Detail

values

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

Returns:

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

valueOf

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

fromIcal

public static IcalValueType fromIcal(java.lang.String icalValue)

toIcal

public java.lang.String toIcal()