biweekly.io.scribe.property

Class OrganizerScribe

java.lang.Object

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

biweekly.io.scribe.property.OrganizerScribe

public class OrganizerScribe
extends ICalPropertyScribe<Organizer>

Marshals Organizer 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
OrganizerScribe()

Method Summary

Methods

Modifier and Type	Method and Description
protected Organizer	_parseText(String value, ICalDataType dataType, ICalParameters parameters, ParseContext context) Unmarshals a property from a plain-text iCalendar data stream.
protected ICalParameters	_prepareParameters(Organizer property, WriteContext context) Sanitizes a property's parameters before the property is written.
protected String	_writeText(Organizer property, WriteContext context) Marshals a property's value to a string.
Set<ICalVersion>	getSupportedVersions() Gets the iCalendar versions that support this property.

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

_dataType, _defaultDataType, _parseJson, _parseXml, _writeJson, _writeXml, dataType, date, date, date, date, date, defaultDataType, escape, getPropertyClass, getPropertyName, getQName, 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

OrganizerScribe

public OrganizerScribe()

Method Detail

_prepareParameters

protected ICalParameters _prepareParameters(Organizer 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 ICalPropertyScribe<Organizer>

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)

_parseText

protected Organizer _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<Organizer>

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

_writeText

protected String _writeText(Organizer property,
                WriteContext context)

Description copied from class: ICalPropertyScribe

Marshals a property's value to a string.

Specified by:

_writeText in class ICalPropertyScribe<Organizer>

Parameters:

property - the property

context - the write context

Returns:

the marshalled value

getSupportedVersions

public Set<ICalVersion> getSupportedVersions()

Description copied from class: ICalPropertyScribe

Gets the iCalendar versions that support this property. This method returns all iCalendar versions unless overridden by the child scribe.

Overrides:

getSupportedVersions in class ICalPropertyScribe<Organizer>

Returns:

the iCalendar versions