public class ClientPidMapScribe extends VCardPropertyScribe<ClientPidMap>
ClientPidMap properties.VCardPropertyScribe.DateWriterclazz, propertyName, qname| Constructor and Description |
|---|
ClientPidMapScribe() |
| Modifier and Type | Method and Description |
|---|---|
protected VCardDataType |
_defaultDataType(VCardVersion version)
Determines the property's default data type.
|
protected ClientPidMap |
_parseJson(JCardValue value,
VCardDataType dataType,
VCardParameters parameters,
ParseContext context)
Unmarshals a property from a JSON data stream (jCard).
|
protected ClientPidMap |
_parseText(String value,
VCardDataType dataType,
VCardParameters parameters,
ParseContext context)
Unmarshals a property from a plain-text vCard.
|
protected ClientPidMap |
_parseXml(XCardElement element,
VCardParameters parameters,
ParseContext context)
Unmarshals a property from an XML document (xCard).
|
protected JCardValue |
_writeJson(ClientPidMap property)
Marshals a property's value to a JSON data stream (jCard).
|
protected String |
_writeText(ClientPidMap property,
WriteContext context)
Marshals a property's value to a string.
|
protected void |
_writeXml(ClientPidMap property,
XCardElement parent)
Marshals a property's value to an XML element (xCard).
|
_dataType, _parseHtml, _prepareParameters, dataType, date, date, defaultDataType, escape, getPropertyClass, getPropertyName, getQName, handlePrefParam, missingXmlElements, missingXmlElements, parseHtml, parseJson, parseText, parseXml, prepareParameters, writeJson, writeText, writeXmlpublic ClientPidMapScribe()
protected VCardDataType _defaultDataType(VCardVersion version)
VCardPropertyScribeDetermines the property's default data type.
When writing a plain-text vCard, if the data type of a property instance
(as determined by the VCardPropertyScribe.dataType(T, ezvcard.VCardVersion) method) matches the default data
type, then a VALUE parameter will *not* be written.
When parsing a plain-text vCard, if a property has no VALUE parameter,
then the property's default data type will be passed into the
VCardPropertyScribe.parseText(java.lang.String, ezvcard.VCardDataType, ezvcard.parameter.VCardParameters, ezvcard.io.ParseContext) method.
_defaultDataType in class VCardPropertyScribe<ClientPidMap>version - the vCard versionprotected String _writeText(ClientPidMap property, WriteContext context)
VCardPropertyScribe_writeText in class VCardPropertyScribe<ClientPidMap>property - the propertycontext - contains information about the vCard being written, such
as the target versionprotected ClientPidMap _parseText(String value, VCardDataType dataType, VCardParameters parameters, ParseContext context)
VCardPropertyScribe_parseText in class VCardPropertyScribe<ClientPidMap>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(ClientPidMap 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 VCardPropertyScribe<ClientPidMap>property - the propertyparent - the property's XML elementprotected ClientPidMap _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 VCardPropertyScribe<ClientPidMap>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(ClientPidMap 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 VCardPropertyScribe<ClientPidMap>property - the propertyprotected ClientPidMap _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 VCardPropertyScribe<ClientPidMap>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 contextCopyright © 2012–2026 Michael Angstadt. All rights reserved.