public class JCardModule extends SimpleModule
Module for jackson-databind that serializes and deserializes jCards.
Example:
ObjectMapper mapper = new ObjectMapper(); mapper.registerModule(new JCardModule()); VCard result = mapper.readValue(..., VCard.class);
Module.SetupContext
_abstractTypes, _deserializerModifier, _deserializers, _hasExplicitName, _keyDeserializers, _keySerializers, _mixins, _name, _namingStrategy, _serializerModifier, _serializers, _subtypes, _valueInstantiators, _version
Constructor and Description |
---|
JCardModule()
Creates the module.
|
Modifier and Type | Method and Description |
---|---|
ScribeIndex |
getScribeIndex()
Gets the scribe index used by the serializer and deserializer.
|
boolean |
isAddProdId()
Gets whether a
ProductId property will be added to each
serialized 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
each serialized vCard.
|
void |
registerScribe(VCardPropertyScribe<? extends VCardProperty> scribe)
Registers a property scribe.
|
void |
setAddProdId(boolean addProdId)
Sets whether to add a
ProductId property to each serialized vCard
that marks it as having been generated by this library. |
void |
setScribeIndex(ScribeIndex index)
Sets the scribe index for the serializer and deserializer to use.
|
void |
setVersionStrict(boolean versionStrict)
Sets whether properties that do not support jCard will be excluded from
each serialized vCard.
|
_checkNotNull, addAbstractTypeMapping, addDeserializer, addKeyDeserializer, addKeySerializer, addSerializer, addSerializer, addValueInstantiator, getModuleName, getTypeId, registerSubtypes, registerSubtypes, registerSubtypes, setAbstractTypes, setDeserializerModifier, setDeserializers, setKeyDeserializers, setKeySerializers, setMixInAnnotation, setNamingStrategy, setSerializerModifier, setSerializers, setupModule, setValueInstantiators, version
getDependencies
public JCardModule()
public boolean isAddProdId()
ProductId
property will be added to each
serialized vCard that marks it as having been generated by this library.public void setAddProdId(boolean addProdId)
ProductId
property to each serialized vCard
that marks it as having been generated by this library.addProdId
- true to add the property, false not to (defaults to
true)public boolean isVersionStrict()
public void setVersionStrict(boolean versionStrict)
versionStrict
- true to exclude such properties, false not to
(defaults to true)public void registerScribe(VCardPropertyScribe<? extends VCardProperty> scribe)
Registers a property scribe. This is the same as calling:
getScribeIndex().register(scribe)
scribe
- the scribe to registerpublic ScribeIndex getScribeIndex()
public void setScribeIndex(ScribeIndex index)
index
- the scribe indexCopyright © 2012–2023 Michael Angstadt. All rights reserved.