public class KeyScribe extends BinaryPropertyScribe<Key,KeyType>
Key properties.VCardPropertyScribe.DateWriterclazz, propertyName, qname| Constructor and Description |
|---|
KeyScribe() |
| Modifier and Type | Method and Description |
|---|---|
protected VCardDataType |
_dataType(Key property,
VCardVersion version)
Determines the data type of a property instance.
|
protected KeyType |
_mediaTypeFromFileExtension(String extension)
Searches for a
MediaTypeParameter object, given a file extension. |
protected KeyType |
_mediaTypeFromMediaTypeParameter(String mediaType)
Builds a
MediaTypeParameter object based on the value of the
MEDIATYPE parameter or data URI of 4.0 vCards. |
protected KeyType |
_mediaTypeFromTypeParameter(String type)
Builds a
MediaTypeParameter object based on the value of the TYPE
parameter in 2.1/3.0 vCards. |
protected Key |
_newInstance(byte[] data,
KeyType contentType)
Creates a new instance of the property object from binary data.
|
protected Key |
_newInstance(String uri,
KeyType contentType)
Creates a new instance of the property object from a URI.
|
protected Key |
_parseJson(JCardValue value,
VCardDataType dataType,
VCardParameters parameters,
ParseContext context)
Unmarshals a property from a JSON data stream (jCard).
|
protected Key |
_parseText(String value,
VCardDataType dataType,
VCardParameters parameters,
ParseContext context)
Unmarshals a property from a plain-text vCard.
|
protected Key |
_parseXml(XCardElement element,
VCardParameters parameters,
ParseContext context)
Unmarshals a property from an XML document (xCard).
|
protected void |
_prepareParameters(Key property,
VCardParameters copy,
VCardVersion version,
VCard vcard)
Sanitizes a property's parameters before the property is written.
|
protected JCardValue |
_writeJson(Key property)
Marshals a property's value to a JSON data stream (jCard).
|
protected String |
_writeText(Key property,
WriteContext context)
Marshals a property's value to a string.
|
protected void |
_writeXml(Key property,
XCardElement parent)
Marshals a property's value to an XML element (xCard).
|
protected Key |
cannotUnmarshalValue(String value,
VCardVersion version,
KeyType contentType)
Called if the unmarshalling code cannot determine how to unmarshal the
value.
|
_defaultDataType, _parseHtml, getFileExtension, parse, parseContentTypeFromParameters, parseContentTypeFromValueAndParameterscalendar, dataType, date, date, date, defaultDataType, escape, getPropertyClass, getPropertyName, getQName, handlePrefParam, missingXmlElements, missingXmlElements, parseHtml, parseJson, parseText, parseXml, prepareParameters, writeJson, writeText, writeXmlpublic KeyScribe()
protected VCardDataType _dataType(Key property, VCardVersion version)
VCardPropertyScribeDetermines 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 calls VCardPropertyScribe._defaultDataType(ezvcard.VCardVersion).
_dataType in class BinaryPropertyScribe<Key,KeyType>property - the propertyversion - the version of the vCard that is being generatedprotected void _prepareParameters(Key property, VCardParameters copy, VCardVersion version, VCard vcard)
VCardPropertyScribeSanitizes 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.
_prepareParameters in class BinaryPropertyScribe<Key,KeyType>property - the propertycopy - 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 generatedvcard - the vCard that the property belongs toprotected String _writeText(Key property, WriteContext context)
VCardPropertyScribe_writeText in class BinaryPropertyScribe<Key,KeyType>property - the propertycontext - contains information about the vCard being written, such
as the target versionprotected Key _parseText(String value, VCardDataType dataType, VCardParameters parameters, ParseContext context)
VCardPropertyScribe_parseText in class BinaryPropertyScribe<Key,KeyType>value - the value as read off the wiredataType - 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, as determined by the VCardPropertyScribe.defaultDataType(ezvcard.VCardVersion) method.
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 contextprotected void _writeXml(Key property, XCardElement parent)
VCardPropertyScribeMarshals a property's value to an XML element (xCard).
This method should be overridden by child classes that wish to support
xCard. The default implementation of this method will append one child
element to the property's XML element. The child element's name will be
that of the property's data type (retrieved using the VCardPropertyScribe.dataType(T, ezvcard.VCardVersion)
method), and the child element's text content will be set to the
property's marshalled plain-text value (retrieved using the
VCardPropertyScribe.writeText(T, ezvcard.io.text.WriteContext) method).
_writeXml in class BinaryPropertyScribe<Key,KeyType>property - the propertyparent - the property's XML elementprotected Key _parseXml(XCardElement element, VCardParameters parameters, ParseContext context)
VCardPropertyScribeUnmarshals a property from an XML document (xCard).
This method should be overridden by child classes that wish to support
xCard. The default implementation of this method will find the first
child element with the xCard namespace. The element's name will be used
as the property's data type and its text content (escaped for inclusion
in a text-based vCard, e.g. escaping comma characters) will be passed
into the VCardPropertyScribe._parseText(java.lang.String, ezvcard.VCardDataType, ezvcard.parameter.VCardParameters, ezvcard.io.ParseContext) method. If no such child element is found,
then the parent element's text content will be passed into
VCardPropertyScribe._parseText(java.lang.String, ezvcard.VCardDataType, ezvcard.parameter.VCardParameters, ezvcard.io.ParseContext) and the data type will be null.
_parseXml in class BinaryPropertyScribe<Key,KeyType>element - the property's XML elementparameters - 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 contextprotected JCardValue _writeJson(Key property)
VCardPropertyScribeMarshals a property's value to a JSON data stream (jCard).
This method should be overridden by child classes that wish to support
jCard. The default implementation of this method will create a jCard
property that has a single JSON string value (generated by the
VCardPropertyScribe.writeText(T, ezvcard.io.text.WriteContext) method).
_writeJson in class BinaryPropertyScribe<Key,KeyType>property - the propertyprotected Key _parseJson(JCardValue value, VCardDataType dataType, VCardParameters parameters, ParseContext context)
VCardPropertyScribeUnmarshals a property from a JSON data stream (jCard).
This method should be overridden by child classes that wish to support
jCard. The default implementation of this method will convert the jCard
property value to a string and pass it into the VCardPropertyScribe._parseText(java.lang.String, ezvcard.VCardDataType, ezvcard.parameter.VCardParameters, ezvcard.io.ParseContext)
method.
The following paragraphs describe the way in which this method's default implementation converts a jCard value to a string:
If the jCard value consists of a single, non-array, non-object value,
then the value is converted to a string. Special characters (backslashes,
commas, and semicolons) are escaped in order to simulate what the value
might look like in a plain-text vCard.
["x-foo", {}, "text", "the;value"] --> "the\;value"
["x-foo", {}, "text", 2] --> "2"
If the jCard value consists of multiple, non-array, non-object values,
then all the values are appended together in a single string, separated
by commas. Special characters (backslashes, commas, and semicolons) are
escaped for each value in order to prevent commas from being treated as
delimiters, and to simulate what the value might look like in a
plain-text vCard.
["x-foo", {}, "text", "one", "two,three"] -->
"one,two\,three"
If the jCard value is a single array, then this array is treated as a
"structured value", and converted its plain-text representation. Special
characters (backslashes, commas, and semicolons) are escaped for each
value in order to prevent commas and semicolons from being treated as
delimiters.
["x-foo", {}, "text", ["one", ["two", "three"], "four;five"]]
--> "one;two,three;four\;five"
If the jCard value starts with a JSON object, then it is converted to an
empty string (JSON objects are not supported by this method).
["x-foo", , "text", {"one": 1}] --> ""}
For all other cases, behavior is undefined.
_parseJson in class BinaryPropertyScribe<Key,KeyType>value - the property's JSON valuedataType - the data typeparameters - 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 contextprotected KeyType _mediaTypeFromTypeParameter(String type)
BinaryPropertyScribeMediaTypeParameter object based on the value of the TYPE
parameter in 2.1/3.0 vCards._mediaTypeFromTypeParameter in class BinaryPropertyScribe<Key,KeyType>type - the TYPE value (e.g. "JPEG")protected KeyType _mediaTypeFromMediaTypeParameter(String mediaType)
BinaryPropertyScribeMediaTypeParameter object based on the value of the
MEDIATYPE parameter or data URI of 4.0 vCards._mediaTypeFromMediaTypeParameter in class BinaryPropertyScribe<Key,KeyType>mediaType - the media type string (e.g. "image/jpeg")protected KeyType _mediaTypeFromFileExtension(String extension)
BinaryPropertyScribeMediaTypeParameter object, given a file extension._mediaTypeFromFileExtension in class BinaryPropertyScribe<Key,KeyType>extension - the file extension (e.g. "jpg")protected Key _newInstance(String uri, KeyType contentType)
BinaryPropertyScribe_newInstance in class BinaryPropertyScribe<Key,KeyType>uri - the URIcontentType - the content type or null if unknownprotected Key _newInstance(byte[] data, KeyType contentType)
BinaryPropertyScribe_newInstance in class BinaryPropertyScribe<Key,KeyType>data - the datacontentType - the content type or null if unknownprotected Key cannotUnmarshalValue(String value, VCardVersion version, KeyType contentType)
BinaryPropertyScribecannotUnmarshalValue in class BinaryPropertyScribe<Key,KeyType>value - the valueversion - the version of the vCardcontentType - the content type of the resource of null if unknownCopyright © 2012–2020 Michael Angstadt. All rights reserved.