biweekly.io.scribe.property

Class DateStartScribe

java.lang.Object

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

biweekly.io.scribe.property.DateOrDateTimePropertyScribe<DateStart>

biweekly.io.scribe.property.DateStartScribe

public class DateStartScribe
extends DateOrDateTimePropertyScribe<DateStart>

Marshals DateStart properties.

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
DateStartScribe()

Method Summary

Methods

Modifier and Type	Method and Description
protected ICalParameters	_prepareParameters(DateStart property, WriteContext context) Sanitizes a property's parameters before the property is written.
protected JCalValue	_writeJson(DateStart property, WriteContext context) Marshals a property's value to a JSON data stream (jCal).
protected String	_writeText(DateStart property, WriteContext context) Marshals a property's value to a string.
protected void	_writeXml(DateStart property, XCalElement element, WriteContext context) Marshals a property's value to an XML element (xCal).
protected DateStart	newInstance(ICalDate date)

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

_dataType, _parseJson, _parseText, _parseXml

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

_defaultDataType, 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

DateStartScribe

public DateStartScribe()

Method Detail

_prepareParameters

protected ICalParameters _prepareParameters(DateStart property,
                                WriteContext context)

Description copied from class: ICalPropertyScribe

Sanitizes a property's parameters before the property is written.

This method should be overridden by child classes that wish to tweak the property's parameters before the property is written. The default implementation of this method returns the property's parameters unmodified.

Overrides:

_prepareParameters in class DateOrDateTimePropertyScribe<DateStart>

Parameters:

property - the property to write

context - the context

Returns:

the sanitized parameters (this should be a *copy* of the property's parameters if modifications were made)

_writeText

protected String _writeText(DateStart property,
                WriteContext context)

Description copied from class: ICalPropertyScribe

Marshals a property's value to a string.

Overrides:

_writeText in class DateOrDateTimePropertyScribe<DateStart>

Parameters:

property - the property

context - the write context

Returns:

the marshalled value

_writeXml

protected void _writeXml(DateStart property,
             XCalElement element,
             WriteContext context)

Description copied from class: ICalPropertyScribe

Marshals a property's value to an XML element (xCal).

This method should be overridden by child classes that wish to support xCal. The default implementation of this method will append one child element to the property's XML element. The child element's name will be that of the property's data type (retrieved using the ICalPropertyScribe.dataType(T, biweekly.ICalVersion) method), and the child element's text content will be set to the property's marshalled plain-text value (retrieved using the ICalPropertyScribe.writeText(T, biweekly.io.WriteContext) method).

Overrides:

_writeXml in class DateOrDateTimePropertyScribe<DateStart>

Parameters:

property - the property

element - the property's XML element

context - the context

_writeJson

protected JCalValue _writeJson(DateStart property,
                   WriteContext context)

Description copied from class: ICalPropertyScribe

Marshals a property's value to 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 create a jCard property that has a single JSON string value (generated by the ICalPropertyScribe.writeText(T, biweekly.io.WriteContext) method).

Overrides:

_writeJson in class DateOrDateTimePropertyScribe<DateStart>

Parameters:

property - the property

context - the context

Returns:

the marshalled value

newInstance

protected DateStart newInstance(ICalDate date)

Specified by:

newInstance in class DateOrDateTimePropertyScribe<DateStart>