jfxtras.icalendarfx.parameters

Interface Parameter<T>

All Superinterfaces:

java.lang.Comparable<Parameter<T>>, VChild, VElement

All Known Implementing Classes:

AlarmTriggerRelationship, AlternateText, CalendarUser, CommonName, Delegatees, Delegators, DirectoryEntry, Encoding, FormatType, FreeBusyType, GroupMembership, Language, NonStandardParameter, OtherParameter, ParameterBase, ParameterEnumBasedWithUnknown, ParticipationRole, ParticipationStatus, Range, Relationship, RSVP, SentBy, TimeZoneIdentifierParameter, ValueParameter

public interface Parameter<T>
extends java.lang.Comparable<Parameter<T>>, VChild

Every parameter requires the following methods: toContentLine - make iCalendar string getValue - return parameters value isEqualsTo - checks equality between two parameters parse - convert string into parameter - this method is in ParameterEnum

Property Summary

Type	Property and Description
javafx.beans.property.ObjectProperty<T>	value object property of parameter’s value

Method Summary

Modifier and Type	Method and Description
static java.lang.String	extractName(java.lang.String content)
static java.lang.String	extractValue(java.lang.String content)
T	getValue() The value of the parameter.
ParameterType	parameterType() Returns the enumerated type for the parameter as it would appear in the iCalendar content line Examples: VALUE TZID
void	setValue(T value) Set the value of this parameter
java.lang.String	toContent() return parameter name-value pair string separated by an "=" for example: LANGUAGE=en-US
javafx.beans.property.ObjectProperty<T>	valueProperty() object property of parameter’s value

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from interface jfxtras.icalendarfx.VChild

getParent, setParent

Methods inherited from interface jfxtras.icalendarfx.VElement

errors, isValid, name, parseContent

Property Detail

value

javafx.beans.property.ObjectProperty<T> valueProperty

object property of parameter’s value

See Also:

getValue(), setValue(T)

Method Detail

getValue

T getValue()

The value of the parameter.

For example, in the below parameter: CN=John Doe The value is the String "John Doe"

Note: the value’s object must have an overridden toString method that complies with iCalendar content line output.

valueProperty

javafx.beans.property.ObjectProperty<T> valueProperty()

object property of parameter’s value

See Also:

getValue(), setValue(T)

setValue

void setValue(T value)

Set the value of this parameter

parameterType

ParameterType parameterType()

Returns the enumerated type for the parameter as it would appear in the iCalendar content line Examples: VALUE TZID

Returns:

toContent

java.lang.String toContent()

return parameter name-value pair string separated by an "=" for example: LANGUAGE=en-US

Specified by:

toContent in interface VElement

Returns:

the content string

extractValue

static java.lang.String extractValue(java.lang.String content)

extractName

static java.lang.String extractName(java.lang.String content)