ezvcard.io.json

Class JCardSerializer

java.lang.Object

com.fasterxml.jackson.databind.JsonSerializer<T>

com.fasterxml.jackson.databind.ser.std.StdSerializer<VCard>

ezvcard.io.json.JCardSerializer

All Implemented Interfaces:

com.fasterxml.jackson.databind.jsonFormatVisitors.JsonFormatVisitable, com.fasterxml.jackson.databind.jsonschema.SchemaAware, com.fasterxml.jackson.databind.ser.ContextualSerializer, Serializable

public class JCardSerializer
extends com.fasterxml.jackson.databind.ser.std.StdSerializer<VCard>
implements com.fasterxml.jackson.databind.ser.ContextualSerializer

Serializes jCards within the jackson-databind framework.

Author:

Buddy Gorven

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.databind.JsonSerializer

com.fasterxml.jackson.databind.JsonSerializer.None

Field Summary

Fields inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer

_handledType

Constructor Summary

Constructors

Constructor and Description
JCardSerializer()

Method Summary

Modifier and Type	Method and Description
JCardSerializer	createContextual(com.fasterxml.jackson.databind.SerializerProvider prov, com.fasterxml.jackson.databind.BeanProperty property)
ScribeIndex	getScribeIndex() Gets the scribe index.
boolean	isAddProdId() Gets whether a ProductId property will be added to the vCard that marks it as having been generated by this library.
boolean	isVersionStrict() Gets whether properties that do not support jCard will be excluded from the written vCard.
void	registerScribe(VCardPropertyScribe<? extends VCardProperty> scribe) Registers a property scribe.
void	serialize(VCard value, JsonGenerator gen, com.fasterxml.jackson.databind.SerializerProvider serializers)
void	setAddProdId(boolean addProdId) Sets whether to add a ProductId property to the vCard that marks it as having been generated by this library.
void	setScribeIndex(ScribeIndex index) Sets the scribe index.
void	setVersionStrict(boolean versionStrict) Sets whether properties that do not support jCard will be excluded from the written vCard.

Methods inherited from class com.fasterxml.jackson.databind.ser.std.StdSerializer

_neitherNull, _nonEmpty, acceptJsonFormatVisitor, createSchemaNode, createSchemaNode, findAnnotatedContentSerializer, findContextualConvertingSerializer, findConvertingContentSerializer, findFormatFeature, findFormatOverrides, findIncludeOverrides, findPropertyFilter, getSchema, getSchema, handledType, isDefaultSerializer, visitArrayFormat, visitArrayFormat, visitFloatFormat, visitIntFormat, visitIntFormat, visitStringFormat, visitStringFormat, wrapAndThrow, wrapAndThrow

Methods inherited from class com.fasterxml.jackson.databind.JsonSerializer

getDelegatee, isEmpty, isEmpty, isUnwrappingSerializer, properties, replaceDelegatee, serializeWithType, unwrappingSerializer, usesObjectId, withFilterId

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JCardSerializer

public JCardSerializer()

Method Detail

serialize

public void serialize(VCard value,
                      JsonGenerator gen,
                      com.fasterxml.jackson.databind.SerializerProvider serializers)
               throws IOException,
                      JsonProcessingException

Specified by:

serialize in class com.fasterxml.jackson.databind.ser.std.StdSerializer<VCard>

Throws:

IOException

JsonProcessingException

createContextual

public JCardSerializer createContextual(com.fasterxml.jackson.databind.SerializerProvider prov,
                                        com.fasterxml.jackson.databind.BeanProperty property)
                                 throws com.fasterxml.jackson.databind.JsonMappingException

Specified by:

createContextual in interface com.fasterxml.jackson.databind.ser.ContextualSerializer

Throws:

com.fasterxml.jackson.databind.JsonMappingException

isAddProdId

public boolean isAddProdId()

Gets whether a ProductId property will be added to the vCard that marks it as having been generated by this library.

Returns:

true if the property will be added, false if not (defaults to true)

setAddProdId

public void setAddProdId(boolean addProdId)

Sets whether to add a ProductId property to the vCard that marks it as having been generated by this library.

Parameters:

addProdId - true to add the property, false not to (defaults to true)

isVersionStrict

public boolean isVersionStrict()

Gets whether properties that do not support jCard will be excluded from the written vCard. jCard only supports properties defined in the vCard version 4.0 specification.

Returns:

true if the properties will be excluded, false if not (defaults to true)

setVersionStrict

public void setVersionStrict(boolean versionStrict)

Sets whether properties that do not support jCard will be excluded from the written vCard. jCard only supports properties defined in the vCard version 4.0 specification.

Parameters:

versionStrict - true to exclude such properties, false not to (defaults to true)

registerScribe

public void registerScribe(VCardPropertyScribe<? extends VCardProperty> scribe)

Registers a property scribe. This is the same as calling:

getScribeIndex().register(scribe)

Parameters:

scribe - the scribe to register

getScribeIndex

public ScribeIndex getScribeIndex()

Gets the scribe index.

Returns:

the scribe index

setScribeIndex

public void setScribeIndex(ScribeIndex index)

Sets the scribe index.

Parameters:

index - the scribe index