biweekly.io.scribe.property

Class RawPropertyScribe

java.lang.Object

biweekly.io.scribe.property.ICalPropertyScribe<RawProperty>

biweekly.io.scribe.property.RawPropertyScribe

public class RawPropertyScribe
extends ICalPropertyScribe<RawProperty>

Marshals properties that do not have a scribe associated with them.

Author:

Michael Angstadt

Nested Class Summary

Nested classes/interfaces inherited from class biweekly.io.scribe.property.ICalPropertyScribe

ICalPropertyScribe.DateParser, ICalPropertyScribe.DateWriter, ICalPropertyScribe.ListCallback<T>, ICalPropertyScribe.Result<T>, ICalPropertyScribe.SemiStructuredIterator, ICalPropertyScribe.Splitter, ICalPropertyScribe.StructuredIterator

Field Summary

Fields inherited from class biweekly.io.scribe.property.ICalPropertyScribe

clazz, propertyName, qname

Constructor Summary

Constructors

Constructor and Description
RawPropertyScribe(String propertyName)

Method Summary

Methods

Modifier and Type	Method and Description
protected ICalDataType	_dataType(RawProperty property, ICalVersion version) Determines the data type of a property instance.
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.

Methods inherited from class biweekly.io.scribe.property.ICalPropertyScribe

_defaultDataType, _parseJson, _prepareParameters, _writeJson, _writeXml, dataType, date, date, date, date, date, defaultDataType, escape, getPropertyClass, getPropertyName, getQName, getSupportedVersions, handleTzidParameter, isInObservance, list, list, list, list, missingXmlElements, missingXmlElements, object, object, parseJson, parseText, parseXml, prepareParameters, semistructured, semistructured, splitter, structured, structured, structured, unescape, writeJson, writeText, writeXml

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RawPropertyScribe

public RawPropertyScribe(String propertyName)

Method Detail

_dataType

protected ICalDataType _dataType(RawProperty property,
                     ICalVersion version)

Description copied from class: ICalPropertyScribe

Determines 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.

Overrides:

_dataType in class ICalPropertyScribe<RawProperty>

Parameters:

property - the property

version - the version of the iCalendar object being generated

Returns:

the data type or null if unknown

_writeText

protected String _writeText(RawProperty property,
                WriteContext context)

Description copied from class: ICalPropertyScribe

Marshals a property's value to a string.

Specified by:

_writeText in class ICalPropertyScribe<RawProperty>

Parameters:

property - the property

context - the write context

Returns:

the marshalled value

_parseText

protected RawProperty _parseText(String value,
                     ICalDataType dataType,
                     ICalParameters parameters,
                     ParseContext context)

Description copied from class: ICalPropertyScribe

Unmarshals a property from a plain-text iCalendar data stream.

Specified by:

_parseText in class ICalPropertyScribe<RawProperty>

Parameters:

value - the value as read off the wire

dataType - 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 context

Returns:

the unmarshalled property object

_parseXml

protected RawProperty _parseXml(XCalElement element,
                    ICalParameters parameters,
                    ParseContext context)

Description copied from class: ICalPropertyScribe

Unmarshals 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.

Overrides:

_parseXml in class ICalPropertyScribe<RawProperty>

Parameters:

element - the property's XML element

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 context

Returns:

the unmarshalled property object