public class RawPropertyScribe extends ICalPropertyScribe<RawProperty>
RawProperty properties.ICalPropertyScribe.DateParser, ICalPropertyScribe.DateWriter, ICalPropertyScribe.Result<T>clazz, propertyName, qname| Constructor and Description |
|---|
RawPropertyScribe(String propertyName) |
| Modifier and Type | Method and Description |
|---|---|
protected ICalDataType |
_dataType(RawProperty property,
ICalVersion version)
Determines the data type of a property instance.
|
protected RawProperty |
_parseJson(JCalValue value,
ICalDataType dataType,
ICalParameters parameters,
ParseContext context)
Unmarshals a property from a JSON data stream (jCal).
|
protected RawProperty |
_parseText(String value,
ICalDataType dataType,
ICalParameters parameters,
ParseContext context)
Unmarshals a property from a plain-text iCalendar data stream.
|
protected RawProperty |
_parseXml(XCalElement element,
ICalParameters parameters,
ParseContext context)
Unmarshals a property from an XML document (xCal).
|
protected String |
_writeText(RawProperty property,
WriteContext context)
Marshals a property's value to a string.
|
_defaultDataType, _prepareParameters, _writeJson, _writeXml, dataType, date, date, date, date, date, defaultDataType, getPropertyClass, getPropertyName, getQName, getSupportedVersions, handleTzidParameter, isInObservance, missingXmlElements, missingXmlElements, parseJson, parseText, parseXml, prepareParameters, writeJson, writeText, writeXmlpublic RawPropertyScribe(String propertyName)
protected ICalDataType _dataType(RawProperty property, ICalVersion version)
ICalPropertyScribeDetermines the data type of a property instance.
This method should be overridden by child classes if a property's data type changes depending on its value. The default implementation of this method returns the property's default data type.
_dataType in class ICalPropertyScribe<RawProperty>property - the propertyversion - the version of the iCalendar object being generatedprotected String _writeText(RawProperty property, WriteContext context)
ICalPropertyScribe_writeText in class ICalPropertyScribe<RawProperty>property - the propertycontext - the write contextprotected RawProperty _parseText(String value, ICalDataType dataType, ICalParameters parameters, ParseContext context)
ICalPropertyScribe_parseText in class ICalPropertyScribe<RawProperty>value - the value as read off the wiredataType - the data type of the property value. The property's VALUE
parameter is used to determine the data type. If the property has no
VALUE parameter, then this parameter will be set to the property's
default datatype. Note that the VALUE parameter is removed from the
property's parameter list after it has been read.parameters - the parsed parameters. These parameters will be
assigned to the property object once this method returns. Therefore, do
not assign any parameters to the property object itself whilst inside of
this method, or else they will be overwritten.context - the parse contextprotected RawProperty _parseXml(XCalElement element, ICalParameters parameters, ParseContext context)
ICalPropertyScribeUnmarshals a property from an XML document (xCal).
This method should be overridden by child classes that wish to support
xCal. The default implementation of this method will find the first child
element with the xCal namespace. The element's name will be used as the
property's data type and its text content will be passed into the
ICalPropertyScribe._parseText(java.lang.String, biweekly.ICalDataType, biweekly.parameter.ICalParameters, biweekly.io.ParseContext) method. If no such child element is found, then the
parent element's text content will be passed into ICalPropertyScribe._parseText(java.lang.String, biweekly.ICalDataType, biweekly.parameter.ICalParameters, biweekly.io.ParseContext) and
the data type will be null.
_parseXml in class ICalPropertyScribe<RawProperty>element - the property's XML elementparameters - the parsed parameters. These parameters will be
assigned to the property object once this method returns. Therefore, do
not assign any parameters to the property object itself whilst inside of
this method, or else they will be overwritten.context - the contextprotected RawProperty _parseJson(JCalValue value, ICalDataType dataType, ICalParameters parameters, ParseContext context)
ICalPropertyScribeUnmarshals a property from a JSON data stream (jCal).
This method should be overridden by child classes that wish to support
jCal. The default implementation of this method will convert the jCal
property value to a string and pass it into the ICalPropertyScribe._parseText(java.lang.String, biweekly.ICalDataType, biweekly.parameter.ICalParameters, biweekly.io.ParseContext)
method.
The following paragraphs describe the way in which this method's default implementation converts a jCal value to a string:
If the jCal value consists of a single, non-array, non-object value, then
the value is converted to a string. Special characters (backslashes,
commas, and semicolons) are escaped in order to simulate what the value
might look like in a plain-text iCalendar object.
["x-foo", {}, "text", "the;value"] --> "the\;value"
["x-foo", {}, "text", 2] --> "2"
If the jCal value consists of multiple, non-array, non-object values,
then all the values are appended together in a single string, separated
by commas. Special characters (backslashes, commas, and semicolons) are
escaped for each value in order to prevent commas from being treated as
delimiters, and to simulate what the value might look like in a
plain-text iCalendar object.
["x-foo", {}, "text", "one", "two,three"] -->
"one,two\,three"
If the jCal value is a single array, then this array is treated as a
"structured value", and converted its plain-text representation. Special
characters (backslashes, commas, and semicolons) are escaped for each
value in order to prevent commas and semicolons from being treated as
delimiters.
["x-foo", {}, "text", ["one", ["two", "three"], "four;five"]]
--> "one;two,three;four\;five"
If the jCal value starts with a JSON object, then the object is converted
to a format identical to the one used in the RRULE and EXRULE properties.
Special characters (backslashes, commas, semicolons, and equal signs) are
escaped for each value in order to preserve the syntax of the string
value.
["x-foo", {}, "text", {"one": 1, "two": [2, 2.5]}] --> "ONE=1;TWO=2,2.5"
For all other cases, behavior is undefined.
_parseJson in class ICalPropertyScribe<RawProperty>value - the property's JSON valuedataType - the data typeparameters - the parsed parameters. These parameters will be
assigned to the property object once this method returns. Therefore, do
not assign any parameters to the property object itself whilst inside of
this method, or else they will be overwritten.context - the contextCopyright © 2013–2024 Michael Angstadt. All rights reserved.