jfxtras.icalendarfx.parameters

Class ParameterBase<U,T>

java.lang.Object

jfxtras.icalendarfx.parameters.ParameterBase<U,T>

All Implemented Interfaces:

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

Direct Known Subclasses:

AlarmTriggerRelationship, AlternateText, CommonName, Delegatees, Delegators, DirectoryEntry, Encoding, FormatType, GroupMembership, Language, NonStandardParameter, OtherParameter, ParameterEnumBasedWithUnknown, Range, RSVP, SentBy, TimeZoneIdentifierParameter

public abstract class ParameterBase<U,T>
extends java.lang.Object
implements Parameter<T>

Base class of all iCalendar Parameters. Parameters can’t have children. Example VALUE=DATE

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
int	compareTo(Parameter<T> test)
boolean	equals(java.lang.Object obj)
java.util.List<java.lang.String>	errors() Produces a list of error messages indicating problems with calendar element VElement.errors() is invoked recursively to return errors of child elements in addition to errors in parent
VParent	getParent() Gets the VParent of this VChild
T	getValue() The value of the parameter.
int	hashCode()
java.lang.String	name() <p>Returns the name of the component as it would appear in the iCalendar content line.</p> <p>Examples: <ul> <li>VEVENT <li>SUMMARY <li>LANGUAGE </ul> </p>
ParameterType	parameterType() PARAMETER TYPE
java.util.List<java.lang.String>	parseContent(java.lang.String content) Parse content line into calendar element.
void	setParent(VParent parent) Set the VParent of this VChild.
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
java.lang.String	toString()
javafx.beans.property.ObjectProperty<T>	valueProperty() object property of parameter’s value
U	withValue(T value)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface jfxtras.icalendarfx.parameters.Parameter

extractName, extractValue

Methods inherited from interface jfxtras.icalendarfx.VElement

isValid

Property Detail

value

public javafx.beans.property.ObjectProperty<T> valueProperty

Specified by:

valueProperty in interface Parameter<T>

See Also:

getValue(), setValue(T)

Method Detail

setParent

public void setParent(VParent parent)

Description copied from interface: VChild

Set the VParent of this VChild. This method is invoked internally by the API. Under normal circumstances it should not be used externally

Specified by:

setParent in interface VChild

getParent

public VParent getParent()

Description copied from interface: VChild

Gets the VParent of this VChild

Specified by:

getParent in interface VChild

name

public java.lang.String name()

Description copied from interface: VElement

<p>Returns the name of the component as it would appear in the iCalendar content line.</p> <p>Examples: <ul> <li>VEVENT <li>SUMMARY <li>LANGUAGE </ul> </p>

Specified by:

name in interface VElement

Returns:

getValue

public T getValue()

Description copied from interface: Parameter

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.

Specified by:

getValue in interface Parameter<T>

valueProperty

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

Description copied from interface: Parameter

object property of parameter’s value

Specified by:

valueProperty in interface Parameter<T>

See Also:

getValue(), setValue(T)

setValue

public void setValue(T value)

Description copied from interface: Parameter

Set the value of this parameter

Specified by:

setValue in interface Parameter<T>

withValue

public U withValue(T value)

toContent

public java.lang.String toContent()

Description copied from interface: Parameter

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

Specified by:

toContent in interface Parameter<T>

Specified by:

toContent in interface VElement

Returns:

the content string

parseContent

public java.util.List<java.lang.String> parseContent(java.lang.String content)

Description copied from interface: VElement

Parse content line into calendar element. If element contains children VElement.parseContent(String) is invoked recursively to parse child elements also

Specified by:

parseContent in interface VElement

Parameters:

content - calendar content string to parse

Returns:

log of information and error messages

parameterType

public ParameterType parameterType()

PARAMETER TYPE

The enumerated type of the parameter.

Specified by:

parameterType in interface Parameter<T>

Returns:

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

compareTo

public int compareTo(Parameter<T> test)

Specified by:

compareTo in interface java.lang.Comparable<Parameter<T>>

errors

public java.util.List<java.lang.String> errors()

Description copied from interface: VElement

Produces a list of error messages indicating problems with calendar element VElement.errors() is invoked recursively to return errors of child elements in addition to errors in parent

Specified by:

errors in interface VElement

Returns: