ezvcard.io.scribe

Class ImagePropertyScribe<T extends ImageProperty>

java.lang.Object

ezvcard.io.scribe.VCardPropertyScribe<T>

ezvcard.io.scribe.BinaryPropertyScribe<T,ImageType>

ezvcard.io.scribe.ImagePropertyScribe<T>

Type Parameters:

T - the property class

Direct Known Subclasses:

LogoScribe, PhotoScribe

public abstract class ImagePropertyScribe<T extends ImageProperty>
extends BinaryPropertyScribe<T,ImageType>

Marshals properties that contain images.

Author:

Michael Angstadt

Nested Class Summary

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

VCardPropertyScribe.DateWriter

Field Summary

Fields inherited from class ezvcard.io.scribe.VCardPropertyScribe

clazz, propertyName, qname

Constructor Summary

Constructors

Constructor and Description
ImagePropertyScribe(Class<T> clazz, String propertyName)

Method Summary

Modifier and Type	Method and Description
protected ImageType	_mediaTypeFromFileExtension(String extension) Searches for a MediaTypeParameter object, given a file extension.
protected ImageType	_mediaTypeFromMediaTypeParameter(String mediaType) Builds a MediaTypeParameter object based on the value of the MEDIATYPE parameter or data URI of 4.0 vCards.
protected ImageType	_mediaTypeFromTypeParameter(String type) Builds a MediaTypeParameter object based on the value of the TYPE parameter in 2.1/3.0 vCards.
protected T	_parseHtml(HCardElement element, ParseContext context) Unmarshals the property from an hCard (HTML document).

Methods inherited from class ezvcard.io.scribe.BinaryPropertyScribe

_dataType, _defaultDataType, _newInstance, _newInstance, _parseJson, _parseText, _parseXml, _prepareParameters, _writeJson, _writeText, _writeXml, cannotUnmarshalValue, getFileExtension, parse, parseContentTypeFromParameters, parseContentTypeFromValueAndParameters

Methods inherited from class ezvcard.io.scribe.VCardPropertyScribe

dataType, date, date, defaultDataType, escape, getPropertyClass, getPropertyName, getQName, handlePrefParam, missingXmlElements, missingXmlElements, parseHtml, 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

ImagePropertyScribe

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

Method Detail

_mediaTypeFromTypeParameter

protected ImageType _mediaTypeFromTypeParameter(String type)

Description copied from class: BinaryPropertyScribe

Builds a MediaTypeParameter object based on the value of the TYPE parameter in 2.1/3.0 vCards.

Specified by:

_mediaTypeFromTypeParameter in class BinaryPropertyScribe<T extends ImageProperty,ImageType>

Parameters:

type - the TYPE value (e.g. "JPEG")

Returns:

the media type object

_mediaTypeFromMediaTypeParameter

protected ImageType _mediaTypeFromMediaTypeParameter(String mediaType)

Description copied from class: BinaryPropertyScribe

Builds a MediaTypeParameter object based on the value of the MEDIATYPE parameter or data URI of 4.0 vCards.

Specified by:

_mediaTypeFromMediaTypeParameter in class BinaryPropertyScribe<T extends ImageProperty,ImageType>

Parameters:

mediaType - the media type string (e.g. "image/jpeg")

Returns:

the media type object

_mediaTypeFromFileExtension

protected ImageType _mediaTypeFromFileExtension(String extension)

Description copied from class: BinaryPropertyScribe

Searches for a MediaTypeParameter object, given a file extension.

Specified by:

_mediaTypeFromFileExtension in class BinaryPropertyScribe<T extends ImageProperty,ImageType>

Parameters:

extension - the file extension (e.g. "jpg")

Returns:

the media type object or null if not found

_parseHtml

protected T _parseHtml(HCardElement element,
                       ParseContext context)

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.parameter.VCardParameters, ezvcard.io.ParseContext) method.

Overrides:

_parseHtml in class BinaryPropertyScribe<T extends ImageProperty,ImageType>

Parameters:

element - the property's HTML element

context - the parse context

Returns:

the unmarshalled property object