biweekly.io.scribe.property

Class AttendeeScribe

java.lang.Object

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

biweekly.io.scribe.property.AttendeeScribe

public class AttendeeScribe
extends ICalPropertyScribe<Attendee>

Marshals Attendee properties.

Author:

Michael Angstadt

Nested Class Summary

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

ICalPropertyScribe.DateParser, ICalPropertyScribe.DateWriter, ICalPropertyScribe.Result<T>

Field Summary

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

clazz, propertyName, qname

Constructor Summary

Constructors

Constructor and Description
AttendeeScribe()

Method Summary

Modifier and Type	Method and Description
protected ICalDataType	_dataType(Attendee property, ICalVersion version) Determines the data type of a property instance.
protected ICalDataType	_defaultDataType(ICalVersion version) Determines the default data type of this property.
protected Attendee	_parseText(String value, ICalDataType dataType, ICalParameters parameters, ParseContext context) Unmarshals a property from a plain-text iCalendar data stream.
protected ICalParameters	_prepareParameters(Attendee property, WriteContext context) Sanitizes a property's parameters before the property is written.
protected String	_writeText(Attendee property, WriteContext context) Marshals a property's value to a string.

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

_parseJson, _parseXml, _writeJson, _writeXml, dataType, date, date, date, date, date, defaultDataType, getPropertyClass, getPropertyName, getQName, getSupportedVersions, handleTzidParameter, isInObservance, missingXmlElements, missingXmlElements, parseJson, parseText, parseXml, prepareParameters, writeJson, writeText, writeXml

Methods inherited from class java.lang.Object

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

Constructor Detail

AttendeeScribe

public AttendeeScribe()

Method Detail

_defaultDataType

protected ICalDataType _defaultDataType(ICalVersion version)

Description copied from class: ICalPropertyScribe

Determines the default data type of this property.

This method should be overridden by child classes if a property's default data type changes depending the iCalendar version. The default implementation of this method returns the data type that was passed into the ICalPropertyScribe.ICalPropertyScribe(Class, String, ICalDataType) constructor. Null is returned if this constructor was not invoked.

Overrides:

_defaultDataType in class ICalPropertyScribe<Attendee>

Parameters:

version - the version of the iCalendar object being generated

Returns:

the data type or null if unknown

_dataType

protected ICalDataType _dataType(Attendee 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<Attendee>

Parameters:

property - the property

version - the version of the iCalendar object being generated

Returns:

the data type or null if unknown

_prepareParameters

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

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 Attendee _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<Attendee>

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(Attendee property,
                            WriteContext context)

Description copied from class: ICalPropertyScribe

Marshals a property's value to a string.

Specified by:

_writeText in class ICalPropertyScribe<Attendee>

Parameters:

property - the property

context - the write context

Returns:

the marshalled value