Jackson 3.0.1 · tools.jackson.datatype.primitive_collections_base.ser.map.RefRefMapSerializer

Field Summary

Modifier and Type	Field and Description
protected final Set<String>	_ignoredEntries Set of entries to omit during serialization, if any
protected final ValueSerializer<Object>	_keySerializer
private final JavaType	_keyType
private final JavaType	_type
protected final ValueSerializer<Object>	_valueSerializer
private final JavaType	_valueType
private final TypeSerializer	_valueTypeSerializer

Inherited from tools.jackson.databind.ser.std.StdContainerSerializer:: _dynamicValueSerializers _property

Constructor Summary

Access	Constructor and Description
public	RefRefMapSerializer(JavaType type, Class<? super T> mapClass, ValueSerializer<Object> keySerializer, TypeSerializer vts, ValueSerializer<Object> valueSerializer, Set<String> ignoredEntries)
protected	RefRefMapSerializer(RefRefMapSerializer<?> src, BeanProperty property, ValueSerializer<?> keySerializer, TypeSerializer vts, ValueSerializer<?> valueSerializer, Set<String> ignoredEntries)

Method Summary

Modifier and Type	Method and Description
private ValueSerializer<Object>	_findSerializer(SerializationContext ctxt, Object value)
public ValueSerializer<?>	createContextual(SerializationContext ctxt, BeanProperty property) Overrides tools.jackson.databind.ValueSerializer.createContextual. Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property (or, for root values, in which case `null` is passed).
protected abstract void	forEachKeyValue(T value, BiConsumer<Object, Object> action)
public ValueSerializer<?>	getContentSerializer() Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.getContentSerializer. Accessor for serializer used for serializing contents (List and array elements, Map values etc) of the container for which this serializer is used, if it is known statically.
public JavaType	getContentType() Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.getContentType. Accessor for finding declared (static) element type for type this serializer is used for.
protected JavaType	getKeyType()
public void	serialize(T value, JsonGenerator gen, SerializationContext ctxt) Implements abstract tools.jackson.databind.ser.std.StdSerializer.serialize. Method that can be called to ask implementation to serialize values of type this serializer handles.
private void	serializeFields(T value, JsonGenerator gen, SerializationContext ctxt)
public void	serializeWithType(T value, JsonGenerator gen, SerializationContext ctxt, TypeSerializer typeSer) Overrides tools.jackson.databind.ValueSerializer.serializeWithType. Method that can be called to ask implementation to serialize values of type this serializer handles, using specified type serializer for embedding necessary type information.
protected abstract RefRefMapSerializer<?>	withResolved(BeanProperty property, ValueSerializer<?> keySer, TypeSerializer vts, ValueSerializer<?> valueSer, Set<String> ignored)

Inherited from tools.jackson.databind.ser.std.StdContainerSerializer:: _findAndAddDynamic _findAndAddDynamic _withValueTypeSerializer hasSingleElement isEmpty withValueTypeSerializer

Field Detail

_ignoredEntries	back to summary
protected final Set<String> _ignoredEntries Set of entries to omit during serialization, if any

_keySerializer	back to summary
protected final ValueSerializer<Object> _keySerializer

_keyType	back to summary
private final JavaType _keyType

_type	back to summary
private final JavaType _type

_valueSerializer	back to summary
protected final ValueSerializer<Object> _valueSerializer

_valueType	back to summary
private final JavaType _valueType

_valueTypeSerializer	back to summary
private final TypeSerializer _valueTypeSerializer

Constructor Detail

RefRefMapSerializer	back to summary
public RefRefMapSerializer(JavaType type, Class<? super T> mapClass, ValueSerializer<Object> keySerializer, TypeSerializer vts, ValueSerializer<Object> valueSerializer, Set<String> ignoredEntries)

RefRefMapSerializer	back to summary
protected RefRefMapSerializer(RefRefMapSerializer<?> src, BeanProperty property, ValueSerializer<?> keySerializer, TypeSerializer vts, ValueSerializer<?> valueSerializer, Set<String> ignoredEntries) Annotations @SuppressWarnings:unchecked

Method Detail

_findSerializer	back to summary
private ValueSerializer<Object> _findSerializer(SerializationContext ctxt, Object value)

createContextual	back to summary
public ValueSerializer<?> createContextual(SerializationContext ctxt, BeanProperty property) Overrides tools.jackson.databind.ValueSerializer.createContextual. Doc from tools.jackson.databind.ValueSerializer.createContextual. Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property (or, for root values, in which case `null` is passed). Note that instance that this method is called on is typically shared one and as a result method should NOT modify this instance but rather construct and return a new instance. This instance should only be returned as-is, in case it is already suitable for use. Note that method is only called once per POJO property, and for the first usage as root value serializer; it is not called for every serialization, as doing that would have significant performance impact; most serializers cache contextual instances for future use. Annotations @Override

createContextual

back to summary

public ValueSerializer<?> createContextual(SerializationContext ctxt, BeanProperty property)

Overrides tools.jackson.databind.ValueSerializer.createContextual.

Doc from tools.jackson.databind.ValueSerializer.createContextual.

Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property (or, for root values, in which case `null` is passed). Note that instance that this method is called on is typically shared one and as a result method should NOT modify this instance but rather construct and return a new instance. This instance should only be returned as-is, in case it is already suitable for use.

Note that method is only called once per POJO property, and for the first usage as root value serializer; it is not called for every serialization, as doing that would have significant performance impact; most serializers cache contextual instances for future use.

Annotations

@Override

forEachKeyValue	back to summary
protected abstract void forEachKeyValue(T value, BiConsumer<Object, Object> action)

getContentSerializer back to summary

getContentSerializer	back to summary
public ValueSerializer<?> getContentSerializer() Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.getContentSerializer. Doc from tools.jackson.databind.ser.std.StdContainerSerializer.getContentSerializer. Accessor for serializer used for serializing contents (List and array elements, Map values etc) of the container for which this serializer is used, if it is known statically. Note that for dynamic types this may return null; if so, caller has to instead use `getContentType()` and `tools.jackson.databind.SerializationContext#findContentValueSerializer`. Annotations @Override

public ValueSerializer<?> getContentSerializer()

Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.getContentSerializer.

Doc from tools.jackson.databind.ser.std.StdContainerSerializer.getContentSerializer.

Accessor for serializer used for serializing contents (List and array elements, Map values etc) of the container for which this serializer is used, if it is known statically. Note that for dynamic types this may return null; if so, caller has to instead use getContentType() and tools.jackson.databind.SerializationContext#findContentValueSerializer.

Annotations

@Override

getContentType	back to summary
public JavaType getContentType() Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.getContentType. Doc from tools.jackson.databind.ser.std.StdContainerSerializer.getContentType. Accessor for finding declared (static) element type for type this serializer is used for. Annotations @Override

getContentType

back to summary

public JavaType getContentType()

Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.getContentType.

Doc from tools.jackson.databind.ser.std.StdContainerSerializer.getContentType.

Accessor for finding declared (static) element type for type this serializer is used for.

Annotations

@Override

getKeyType	back to summary
protected JavaType getKeyType()

serialize	back to summary
public void serialize(T value, JsonGenerator gen, SerializationContext ctxt) throws JacksonException Implements abstract tools.jackson.databind.ser.std.StdSerializer.serialize. Doc from tools.jackson.databind.ValueSerializer.serialize. Method that can be called to ask implementation to serialize values of type this serializer handles. Annotations @Override

serialize

back to summary

public void serialize(T value, JsonGenerator gen, SerializationContext ctxt) throws JacksonException

Implements abstract tools.jackson.databind.ser.std.StdSerializer.serialize.

Doc from tools.jackson.databind.ValueSerializer.serialize.

Method that can be called to ask implementation to serialize values of type this serializer handles.

Annotations

@Override

serializeFields	back to summary
private void serializeFields(T value, JsonGenerator gen, SerializationContext ctxt)

serializeWithType back to summary

serializeWithType	back to summary
public void serializeWithType(T value, JsonGenerator gen, SerializationContext ctxt, TypeSerializer typeSer) throws JacksonException Overrides tools.jackson.databind.ValueSerializer.serializeWithType. Doc from tools.jackson.databind.ValueSerializer.serializeWithType. Method that can be called to ask implementation to serialize values of type this serializer handles, using specified type serializer for embedding necessary type information. Default implementation will throw `UnsupportedOperationException` to indicate that proper type handling needs to be implemented. For simple datatypes written as a single scalar value (JSON String, Number, Boolean), implementation would look like: // note: method to call depends on whether this type is serialized as JSON scalar, object or Array! typeSer.writeTypePrefixForScalar(value, gen); serialize(value, gen, provider); typeSer.writeTypeSuffixForScalar(value, gen); and implementations for type serialized as JSON Arrays or Objects would differ slightly, as `START-ARRAY`/`END-ARRAY` and `START-OBJECT`/`END-OBJECT` pairs need to be properly handled with respect to serializing of contents. Annotations @Override

public void serializeWithType(T value, JsonGenerator gen, SerializationContext ctxt, TypeSerializer typeSer) throws JacksonException

Overrides tools.jackson.databind.ValueSerializer.serializeWithType.

Doc from tools.jackson.databind.ValueSerializer.serializeWithType.

Method that can be called to ask implementation to serialize values of type this serializer handles, using specified type serializer for embedding necessary type information.

Default implementation will throw UnsupportedOperationException to indicate that proper type handling needs to be implemented.

For simple datatypes written as a single scalar value (JSON String, Number, Boolean), implementation would look like:

  // note: method to call depends on whether this type is serialized as JSON scalar, object or Array!
  typeSer.writeTypePrefixForScalar(value, gen);
  serialize(value, gen, provider);
  typeSer.writeTypeSuffixForScalar(value, gen);

and implementations for type serialized as JSON Arrays or Objects would differ slightly, as START-ARRAY/END-ARRAY and START-OBJECT/END-OBJECT pairs need to be properly handled with respect to serializing of contents.

Annotations

@Override

withResolved	back to summary
protected abstract RefRefMapSerializer<?> withResolved(BeanProperty property, ValueSerializer<?> keySer, TypeSerializer vts, ValueSerializer<?> valueSer, Set<String> ignored)

public abstract Class RefRefMapSerializer<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail