biweekly.io.scribe.property

Class AudioAlarmScribe

java.lang.Object

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

biweekly.io.scribe.property.VCalAlarmPropertyScribe<AudioAlarm>

biweekly.io.scribe.property.AudioAlarmScribe

public class AudioAlarmScribe
extends VCalAlarmPropertyScribe<AudioAlarm>

Marshals AudioAlarm 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
AudioAlarmScribe()

Method Summary

Methods

Modifier and Type	Method and Description
protected ICalDataType	_dataType(AudioAlarm property, ICalVersion version) Determines the data type of a property instance.
protected Action	action() Determines what kind of Action property this vCal alarm property maps to, and returns a new instance of this property.
protected AudioAlarm	create(ICalDataType dataType, com.github.mangstadt.vinnie.io.VObjectPropertyValues.SemiStructuredValueIterator it) Creates a new instance of the property and populates it with the portion of data that is specific to this vCal alarm property.
protected void	toVAlarm(VAlarm valarm, AudioAlarm property) Populates a VAlarm component with data that is unique to this specific kind of vCal alarm property.
protected List<String>	writeData(AudioAlarm property) Generates the part of the property value that will be included after the part of the value that is common to all vCal alarm properties.

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

_parseText, _writeText, getSupportedVersions, toVAlarm

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

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

AudioAlarmScribe

public AudioAlarmScribe()

Method Detail

_dataType

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

Parameters:

property - the property

version - the version of the iCalendar object being generated

Returns:

the data type or null if unknown

writeData

protected List<String> writeData(AudioAlarm property)

Description copied from class: VCalAlarmPropertyScribe

Generates the part of the property value that will be included after the part of the value that is common to all vCal alarm properties.

Specified by:

writeData in class VCalAlarmPropertyScribe<AudioAlarm>

Parameters:

property - the property

Returns:

the values

create

protected AudioAlarm create(ICalDataType dataType,
                com.github.mangstadt.vinnie.io.VObjectPropertyValues.SemiStructuredValueIterator it)

Description copied from class: VCalAlarmPropertyScribe

Creates a new instance of the property and populates it with the portion of data that is specific to this vCal alarm property.

Specified by:

create in class VCalAlarmPropertyScribe<AudioAlarm>

Parameters:

dataType - the data type

it - an iterator to the property value that is positioned at the "value" portion of the property value (after the values that are common to all vCal alarm properties)

Returns:

the new property

toVAlarm

protected void toVAlarm(VAlarm valarm,
            AudioAlarm property)

Description copied from class: VCalAlarmPropertyScribe

Populates a VAlarm component with data that is unique to this specific kind of vCal alarm property.

Specified by:

toVAlarm in class VCalAlarmPropertyScribe<AudioAlarm>

Parameters:

valarm - the component

property - the property

action

protected Action action()

Description copied from class: VCalAlarmPropertyScribe

Determines what kind of Action property this vCal alarm property maps to, and returns a new instance of this property.

Specified by:

action in class VCalAlarmPropertyScribe<AudioAlarm>

Returns:

a new Action property