ezvcard.io.scribe
Class EmailScribe

java.lang.Object
  ezvcard.io.scribe.VCardPropertyScribe<T>
      ezvcard.io.scribe.SimplePropertyScribe<T>
          ezvcard.io.scribe.StringPropertyScribe<Email>
              ezvcard.io.scribe.EmailScribe

public class EmailScribe
extends StringPropertyScribe<Email>

Marshals Email properties.

Author:

Michael Angstadt

Nested Class Summary

Nested classes/interfaces inherited from class ezvcard.io.scribe.VCardPropertyScribe

VCardPropertyScribe.DateWriter, VCardPropertyScribe.Result<T extends VCardProperty>, VCardPropertyScribe.SemiStructuredIterator, VCardPropertyScribe.Splitter, VCardPropertyScribe.StructuredIterator

Field Summary

Fields inherited from class ezvcard.io.scribe.SimplePropertyScribe

dataType

Fields inherited from class ezvcard.io.scribe.VCardPropertyScribe

clazz, propertyName, qname

Constructor Summary

EmailScribe()

Method Summary

protected Email	_parseHtml(HCardElement element, List<String> warnings) Unmarshals the property from an hCard (HTML document).
protected Email	_parseValue(String value) Parses the property from a string.
protected void	_prepareParameters(Email property, VCardParameters copy, VCardVersion version, VCard vcard) Sanitizes a property's parameters before the property is written.

Methods inherited from class ezvcard.io.scribe.StringPropertyScribe

_writeValue

Methods inherited from class ezvcard.io.scribe.SimplePropertyScribe

_defaultDataType, _parseJson, _parseText, _parseXml, _writeJson, _writeText, _writeXml

Methods inherited from class ezvcard.io.scribe.VCardPropertyScribe

_dataType, dataType, date, date, defaultDataType, escape, getPropertyClass, getPropertyName, getQName, handlePrefParam, list, list, list, missingXmlElements, missingXmlElements, parseHtml, parseJson, parseText, parseXml, prepareParameters, semistructured, semistructured, split, 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

EmailScribe

public EmailScribe()

Method Detail

_prepareParameters

protected void _prepareParameters(Email property,
                                  VCardParameters copy,
                                  VCardVersion version,
                                  VCard vcard)

Description copied from class: VCardPropertyScribe

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 does nothing.

Overrides:

_prepareParameters in class VCardPropertyScribe<Email>

Parameters:

property - the property

copy - the list of parameters to make modifications to (it is a copy of the property's parameters)

version - the version of the vCard that is being generated

vcard - the vCard that the property belongs to

_parseValue

protected Email _parseValue(String value)

Description copied from class: SimplePropertyScribe

Parses the property from a string.

Specified by:

_parseValue in class SimplePropertyScribe<Email>

Parameters:

value - the property value

Returns:

the parsed property object

_parseHtml

protected Email _parseHtml(HCardElement element,
                           List<String> warnings)

Description copied from class: VCardPropertyScribe

Unmarshals the property from an hCard (HTML document).

This method should be overridden by child classes that wish to support hCard. The default implementation of this method will retrieve the HTML element's hCard value (as described in HCardElement.value()), and pass it into the VCardPropertyScribe._parseText(java.lang.String, ezvcard.VCardDataType, ezvcard.VCardVersion, ezvcard.parameter.VCardParameters, java.util.List) method.

Overrides:

_parseHtml in class SimplePropertyScribe<Email>

Parameters:

element - the property's HTML element

warnings - allows the programmer to alert the user to any note-worthy (but non-critical) issues that occurred during the unmarshalling process