biweekly.property.marshaller
Class ListPropertyMarshaller<T extends ListProperty<V>,V>

java.lang.Object
  extended by biweekly.property.marshaller.ICalPropertyMarshaller<T>
      extended by biweekly.property.marshaller.ListPropertyMarshaller<T,V>
Direct Known Subclasses:
ExceptionDatesMarshaller, TextListPropertyMarshaller

public abstract class ListPropertyMarshaller<T extends ListProperty<V>,V>
extends ICalPropertyMarshaller<T>

Marshals properties that contain a list of values.

Author:
Michael Angstadt

Nested Class Summary
 
Nested classes/interfaces inherited from class biweekly.property.marshaller.ICalPropertyMarshaller
ICalPropertyMarshaller.DateParser, ICalPropertyMarshaller.DateWriter, ICalPropertyMarshaller.Result<T>, ICalPropertyMarshaller.Splitter
 
Field Summary
protected  Value dataType
           
 
Fields inherited from class biweekly.property.marshaller.ICalPropertyMarshaller
clazz, propertyName, qname
 
Constructor Summary
ListPropertyMarshaller(Class<T> clazz, String propertyName)
           
ListPropertyMarshaller(Class<T> clazz, String propertyName, Value dataType)
           
 
Method Summary
protected  T _parseText(String value, ICalParameters parameters, List<String> warnings)
          Unmarshals a property's value.
protected  T _parseXml(XCalElement element, ICalParameters parameters, List<String> warnings)
          Unmarshals a property's value from an XML document (xCal).
protected  String _writeText(T property)
          Marshals a property's value to a string.
protected  void _writeXml(T property, XCalElement element)
          Marshals a property's value to an XML element (xCal).
protected abstract  T newInstance(ICalParameters parameters)
           
protected abstract  V readValue(String value, ICalParameters parameters, List<String> warnings)
           
protected abstract  String writeValue(T property, V value)
           
 
Methods inherited from class biweekly.property.marshaller.ICalPropertyMarshaller
_prepareParameters, date, date, escape, getPropertyClass, getPropertyName, getQName, parseComponent, parseList, parseText, parseXml, prepareParameters, split, unescape, writeText, writeXml
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

dataType

protected Value dataType
Constructor Detail

ListPropertyMarshaller

public ListPropertyMarshaller(Class<T> clazz,
                              String propertyName)

ListPropertyMarshaller

public ListPropertyMarshaller(Class<T> clazz,
                              String propertyName,
                              Value dataType)
Method Detail

_writeText

protected String _writeText(T property)
Description copied from class: ICalPropertyMarshaller
Marshals a property's value to a string.

Specified by:
_writeText in class ICalPropertyMarshaller<T extends ListProperty<V>>
Parameters:
property - the property
Returns:
the marshalled value

_parseText

protected T _parseText(String value,
                       ICalParameters parameters,
                       List<String> warnings)
Description copied from class: ICalPropertyMarshaller
Unmarshals a property's value.

Specified by:
_parseText in class ICalPropertyMarshaller<T extends ListProperty<V>>
Parameters:
value - the value
parameters - the property's parameters
warnings - allows the programmer to alert the user to any note-worthy (but non-critical) issues that occurred during the unmarshalling process
Returns:
the unmarshalled property object

_writeXml

protected void _writeXml(T property,
                         XCalElement element)
Description copied from class: ICalPropertyMarshaller
Marshals a property's value to an XML element (xCal).

Overrides:
_writeXml in class ICalPropertyMarshaller<T extends ListProperty<V>>
Parameters:
property - the property
element - the XML element

_parseXml

protected T _parseXml(XCalElement element,
                      ICalParameters parameters,
                      List<String> warnings)
Description copied from class: ICalPropertyMarshaller
Unmarshals a property's value from an XML document (xCal).

Overrides:
_parseXml in class ICalPropertyMarshaller<T extends ListProperty<V>>
Parameters:
element - the property's XML element
parameters - the property's parameters
warnings - allows the programmer to alert the user to any note-worthy (but non-critical) issues that occurred during the unmarshalling process
Returns:
the unmarshalled property object

newInstance

protected abstract T newInstance(ICalParameters parameters)

writeValue

protected abstract String writeValue(T property,
                                     V value)

readValue

protected abstract V readValue(String value,
                               ICalParameters parameters,
                               List<String> warnings)


Copyright © 2013 Michael Angstadt. All Rights Reserved.