Module tools.jackson.databind

Package tools.jackson.databind.ser.jdk

Class MapProperty

java.lang.Object

tools.jackson.databind.introspect.ConcreteBeanPropertyBase

tools.jackson.databind.ser.PropertyWriter

tools.jackson.databind.ser.jdk.MapProperty

All Implemented Interfaces:

tools.jackson.core.util.Named, BeanProperty, FullyNamed

public class MapProperty
extends PropertyWriter

Helper class needed to support flexible filtering of Map properties with generic JSON Filter functionality. Since Maps are not handled as a collection of properties by Jackson (unlike POJOs), bit more wrapping is required.

Nested Class Summary

Nested classes/interfaces inherited from interface tools.jackson.databind.BeanProperty

BeanProperty.Bogus, BeanProperty.Std

Nested classes/interfaces inherited from interface tools.jackson.core.util.Named

tools.jackson.core.util.Named.StringAsNamed

Field Summary

Fields

Modifier and Type	Field	Description
protected Object	_key
protected ValueSerializer<Object>	_keySerializer
protected final BeanProperty	_property
protected final TypeSerializer	_typeSerializer
protected Object	_value
protected ValueSerializer<Object>	_valueSerializer

Fields inherited from class tools.jackson.databind.introspect.ConcreteBeanPropertyBase

_aliases, _metadata

Fields inherited from interface tools.jackson.databind.BeanProperty

EMPTY_FORMAT, EMPTY_INCLUDE

Constructor Summary

Constructors

Constructor	Description
MapProperty(TypeSerializer typeSer, BeanProperty prop)

Method Summary

Modifier and Type	Method	Description
void	depositSchemaProperty(JsonObjectFormatVisitor objectVisitor, SerializationContext ctxt)	Traversal method used for things like JSON Schema generation, or POJO introspection.
JsonInclude.Value	findPropertyInclusion(MapperConfig<?> config, Class<?> baseType)	Convenience method that is roughly equivalent to
<A extends Annotation> A	getAnnotation(Class<A> acls)	Method for accessing annotations directly declared for property that this writer is associated with.
<A extends Annotation> A	getContextAnnotation(Class<A> acls)	Method for accessing annotations declared in context of the property that this writer is associated with; usually this means annotations on enclosing class for property.
PropertyName	getFullName()
AnnotatedMember	getMember()	Method for accessing primary physical entity that represents the property; annotated field, method or constructor property.
String	getName()
JavaType	getType()	Method to get declared type of the property.
Object	getValue()
PropertyName	getWrapperName()	If property is indicated to be wrapped, name of wrapper element to use.
void	reset(Object key, Object value, ValueSerializer<Object> keySer, ValueSerializer<Object> valueSer)	Initialization method that needs to be called before passing property to filter.
void	serializeAsElement(Object map, tools.jackson.core.JsonGenerator gen, SerializationContext ctxt)	Serialization method called when output is to be done as an array, that is, not using property names.
void	serializeAsOmittedElement(Object value, tools.jackson.core.JsonGenerator gen, SerializationContext ctxt)	Serialization method called when doing tabular (positional) output from databind, but then value is to be omitted.
void	serializeAsOmittedProperty(Object map, tools.jackson.core.JsonGenerator gen, SerializationContext ctxt)	Serialization method that filter needs to call in cases where a property value (key, value) is to be filtered, but the underlying data format requires a placeholder of some kind.
void	serializeAsProperty(Object map, tools.jackson.core.JsonGenerator gen, SerializationContext ctxt)	The main serialization method called by filter when property is to be written as an Object property.
void	setValue(Object v)

Methods inherited from class tools.jackson.databind.ser.PropertyWriter

findAnnotation

Methods inherited from class tools.jackson.databind.introspect.ConcreteBeanPropertyBase

findAliases, findFormatOverrides, findPropertyFormat, getMetadata, isRequired, isVirtual

Methods inherited from class java.lang.Object

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

Methods inherited from interface tools.jackson.databind.util.FullyNamed

hasName

Field Details

_typeSerializer

protected final TypeSerializer _typeSerializer

_property

protected final BeanProperty _property

_key

protected Object _key

_value

protected Object _value

_keySerializer

protected ValueSerializer<Object> _keySerializer

_valueSerializer

protected ValueSerializer<Object> _valueSerializer

Constructor Details

MapProperty

public MapProperty(TypeSerializer typeSer,
 BeanProperty prop)

Method Details

reset

public void reset(Object key,
 Object value,
 ValueSerializer<Object> keySer,
 ValueSerializer<Object> valueSer)

Initialization method that needs to be called before passing property to filter.

getName

public String getName()

Specified by:

getName in interface tools.jackson.core.util.Named

Specified by:

getName in class PropertyWriter

getValue

public Object getValue()

setValue

public void setValue(Object v)

getFullName

public PropertyName getFullName()

Specified by:

getFullName in interface FullyNamed

Specified by:

getFullName in class PropertyWriter

getAnnotation

public <A extends Annotation> A getAnnotation(Class<A> acls)

Description copied from class: PropertyWriter

Method for accessing annotations directly declared for property that this writer is associated with.

Specified by:

getAnnotation in interface BeanProperty

Specified by:

getAnnotation in class PropertyWriter

getContextAnnotation

public <A extends Annotation> A getContextAnnotation(Class<A> acls)

Description copied from class: PropertyWriter

Method for accessing annotations declared in context of the property that this writer is associated with; usually this means annotations on enclosing class for property.

Specified by:

getContextAnnotation in interface BeanProperty

Specified by:

getContextAnnotation in class PropertyWriter

findPropertyInclusion

public JsonInclude.Value findPropertyInclusion(MapperConfig<?> config,
 Class<?> baseType)

Description copied from interface: BeanProperty

Convenience method that is roughly equivalent to

   return config.getAnnotationIntrospector().findPropertyInclusion(getMember());

but also considers global default settings for inclusion

serializeAsProperty

public void serializeAsProperty(Object map,
 tools.jackson.core.JsonGenerator gen,
 SerializationContext ctxt)

Description copied from class: PropertyWriter

The main serialization method called by filter when property is to be written as an Object property.

Specified by:

serializeAsProperty in class PropertyWriter

serializeAsOmittedProperty

public void serializeAsOmittedProperty(Object map,
 tools.jackson.core.JsonGenerator gen,
 SerializationContext ctxt)

Description copied from class: PropertyWriter

Serialization method that filter needs to call in cases where a property value (key, value) is to be filtered, but the underlying data format requires a placeholder of some kind. This is usually the case for tabular (positional) data formats such as CSV.

Specified by:

serializeAsOmittedProperty in class PropertyWriter

serializeAsElement

public void serializeAsElement(Object map,
 tools.jackson.core.JsonGenerator gen,
 SerializationContext ctxt)

Description copied from class: PropertyWriter

Serialization method called when output is to be done as an array, that is, not using property names. This is needed when serializing container (Collection, array) types, or POJOs using tabular ("as array") output format.

Note that this mode of operation is independent of underlying data format; so it is typically NOT called for fully tabular formats such as CSV, where logical output is still as form of POJOs.

Specified by:

serializeAsElement in class PropertyWriter

serializeAsOmittedElement

public void serializeAsOmittedElement(Object value,
 tools.jackson.core.JsonGenerator gen,
 SerializationContext ctxt)

Description copied from class: PropertyWriter

Serialization method called when doing tabular (positional) output from databind, but then value is to be omitted. This requires output of a placeholder value of some sort; often similar to PropertyWriter.serializeAsOmittedProperty(java.lang.Object, tools.jackson.core.JsonGenerator, tools.jackson.databind.SerializationContext).

Specified by:

serializeAsOmittedElement in class PropertyWriter

depositSchemaProperty

public void depositSchemaProperty(JsonObjectFormatVisitor objectVisitor,
 SerializationContext ctxt)

Description copied from class: PropertyWriter

Traversal method used for things like JSON Schema generation, or POJO introspection.

Specified by:

depositSchemaProperty in interface BeanProperty

Specified by:

depositSchemaProperty in class PropertyWriter

Parameters:

objectVisitor - Visitor to used as the callback handler

getType

public JavaType getType()

Description copied from interface: BeanProperty

Method to get declared type of the property.

getWrapperName

public PropertyName getWrapperName()

Description copied from interface: BeanProperty

If property is indicated to be wrapped, name of wrapper element to use.

getMember

public AnnotatedMember getMember()

Description copied from interface: BeanProperty

Method for accessing primary physical entity that represents the property; annotated field, method or constructor property.