java.lang.Object
jfxtras.icalendarfx.VElementBase
jfxtras.icalendarfx.VParentBase<U>
jfxtras.icalendarfx.properties.VPropertyBase<T,U>
- Type Parameters:
T
- - type of property valueU
- - type of implementing subclass
- Direct Known Subclasses:
Action
,Attachment
,CalendarScale
,Classification
,FreeBusyTime
,GeographicPosition
,Method
,PercentComplete
,Priority
,ProductIdentifier
,PropBaseDateTime
,PropBaseLanguage
,PropBaseUTC
,PropertyBaseZoneOffset
,RecurrenceRule
,RelatedTo
,RepeatCount
,Sequence
,Status
,TimeTransparency
,TimeZoneIdentifier
,TimeZoneURL
,Trigger
,UniformResourceLocator
,UniqueIdentifier
,Version
Base iCalendar property class
Contains property value, value parameter (ValueType) and other-parameters
Also contains several support methods used by other properties
concrete subclasses
- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class jfxtras.icalendarfx.VElementBase
VElementBase.Message, VElementBase.MessageEffect
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected String
protected final Collection
<ValueType> private StringConverter
<T> protected final ValueType
VALUE TYPE Value Data Types RFC 5545, 3.2.20, page 29 To specify the value for text values in a property or property parameter.private VParent
private List
<NonStandardParameter> NON-STANDARD PARAMETERSprotected String
private final VPropertyElement
private String
private T
private ValueParameter
Fields inherited from class jfxtras.icalendarfx.VParentBase
contentLineGenerator, orderer
Fields inherited from class jfxtras.icalendarfx.VElementBase
BEGIN, END
-
Constructor Summary
ConstructorsModifierConstructorDescriptionprotected
VPropertyBase
(Class<T> valueClass, String contentLine) VPropertyBase
(VPropertyBase<T, U> source) VPropertyBase
(T value) -
Method Summary
Modifier and TypeMethodDescriptionprotected T
boolean
errors()
Produces a list of error messages indicating problems with calendar elementVElement.errors()
is invoked recursively to return errors of child elements in addition to errors in parentprotected StringConverter
<T> STRING CONVERTER Get the property's value string converter.Non-Standard Parametersprotected String
getValue()
PROPERTY VALUE Example: for the property content LOCATION:The park the property value is the string "The park"private Class
<?> VALUE Value Date Types RFC 5545 iCalendar 3.2.10 page 29 To explicitly specify the value type format for a property value.int
hashCode()
private boolean
private boolean
isValueTypeValid
(ValueType value) protected String
name()
The name of the property, such as DESCRIPTION Remains the default value unless set by a non-standard propertyprotected List
<VElementBase.Message> parseContent
(String unfoldedContent) Handle non-standard property nameprotected void
processInLineChild
(List<VElementBase.Message> messages, String childName, String content, Class<? extends VElement> singleLineChildClass) protected void
setConverter
(StringConverter<T> converter) protected void
setConverterByClass
(Class<T> valueClass) void
setNonStandard
(List<NonStandardParameter> nonStandardParams) void
private void
setUnknownValue
(String value) void
Set the value of the propertyvoid
setValueType
(ValueParameter valueType) Set the value typevoid
setValueType
(ValueType value) toString()
protected String
The propery's value converted by string converted to content stringprivate void
valueParamenterConverter
(ValueParameter newValueParameter) withNonStandard
(String... nonStandardParams) NON-STANDARD PARAMETERS Sets the value of theinvalid reference
#NonStandardParameter()
NonStandardParameter
objects.withNonStandard
(List<NonStandardParameter> nonStandardParams) Sets the value of theinvalid reference
#NonStandardParameter()
withNonStandard
(NonStandardParameter... nonStandardParams) Sets the value of theinvalid reference
#NonStandardParameter()
NonStandardParameter
objects.withValueType
(ValueType value) Methods inherited from class jfxtras.icalendarfx.VParentBase
addChild, addChild, addChild, addChildInternal, checkChild, childrenUnmodifiable, collectGetterMap, collectSetterMap, copyChildrenInto, getGetter, getGetters, getSetter, getSetters, orderChild, orderChild, orderChild, parseContent, removeChild, removeChild, replaceChild, replaceChild, withChild
Methods inherited from class jfxtras.icalendarfx.VElementBase
elementName, isContentValid, newEmptyVElement, parse, throwMessageExceptions
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface jfxtras.icalendarfx.VParent
addChild, addChild, addChild, childrenUnmodifiable, orderChild, orderChild, orderChild, removeChild, removeChild, replaceChild, replaceChild
-
Field Details
-
myParent
-
value
-
valueClass
-
propertyName
-
propertyType
-
unknownValue
-
defaultValueType
VALUE TYPE Value Data Types RFC 5545, 3.2.20, page 29 To specify the value for text values in a property or property parameter. This parameter is optional for properties when the default value type is used. Examples: VALUE=DATE-TIME (Date-Time is default value, so it isn't necessary to specify) VALUE=DATE -
allowedValueTypes
-
valueType
-
nonStandardParams
NON-STANDARD PARAMETERS
x-param = x-name "=" param-value *("," param-value)
; A non-standard, experimental parameter. -
actualValueContent
-
converter
-
-
Constructor Details
-
VPropertyBase
protected VPropertyBase() -
VPropertyBase
-
VPropertyBase
-
VPropertyBase
-
-
Method Details
-
setParent
Description copied from interface:VChild
-
getParent
Description copied from interface:VChild
-
getValue
PROPERTY VALUE Example: for the property content LOCATION:The park the property value is the string "The park" -
setValue
Description copied from interface:VProperty
Set the value of the property -
withValue
-
valueContent
The propery's value converted by string converted to content string -
getValueClass
-
name
The name of the property, such as DESCRIPTION Remains the default value unless set by a non-standard property -
getUnknownValue
-
setUnknownValue
-
getValueType
Description copied from interface:VProperty
VALUE Value Date Types RFC 5545 iCalendar 3.2.10 page 29 To explicitly specify the value type format for a property value. Property value type. Optional if default type is used. Example: VALUE=DATE- Specified by:
getValueType
in interfaceVProperty<T>
-
setValueType
Description copied from interface:VProperty
Set the value type- Specified by:
setValueType
in interfaceVProperty<T>
-
setValueType
-
withValueType
-
valueParamenterConverter
-
getNonStandard
Description copied from interface:VProperty
Non-Standard Parameters
x-param = x-name "=" param-value *("," param-value)
; A non-standard, experimental parameter.- Specified by:
getNonStandard
in interfaceVProperty<T>
-
setNonStandard
- Specified by:
setNonStandard
in interfaceVProperty<T>
-
withNonStandard
Sets the value of theinvalid reference
#NonStandardParameter()
- Returns:
- - this class for chaining
-
withNonStandard
NON-STANDARD PARAMETERS Sets the value of theinvalid reference
#NonStandardParameter()
NonStandardParameter
objects.- Returns:
- - this class for chaining
-
withNonStandard
Sets the value of theinvalid reference
#NonStandardParameter()
NonStandardParameter
objects.- Returns:
- - this class for chaining
-
modifiedValue
-
getConverter
STRING CONVERTER Get the property's value string converter. There is a default converter in ValueType associated with the default value type of the property. For most value types that converter is acceptable. However, for the TEXT value type it often needs to be replaced. For example, the value type for TimeZoneIdentifier is TEXT, but the Java object is ZoneId. A different converter is required to make the conversion to ZoneId. -
setConverter
-
isCustomConverter
private boolean isCustomConverter() -
copyValue
-
setConverterByClass
-
parseContent
Handle non-standard property name- Overrides:
parseContent
in classVParentBase<U>
- Parameters:
unfoldedContent
- calendar content string to parse- Returns:
- log of information and error messages
-
processInLineChild
protected void processInLineChild(List<VElementBase.Message> messages, String childName, String content, Class<? extends VElement> singleLineChildClass) - Overrides:
processInLineChild
in classVParentBase<U>
-
errors
Description copied from interface:VElement
Produces a list of error messages indicating problems with calendar elementVElement.errors()
is invoked recursively to return errors of child elements in addition to errors in parent- Specified by:
errors
in interfaceVElement
- Overrides:
errors
in classVParentBase<U>
- Returns:
- - list of error messages
-
isValueTypeValid
-
toString
- Overrides:
toString
in classVParentBase<U>
-
equals
- Overrides:
equals
in classVParentBase<U>
-
hashCode
public int hashCode()- Overrides:
hashCode
in classVParentBase<U>
-