jackson-databind 2.16.0 · com.fasterxml.jackson.databind.ser.std.ArraySerializerBase

Modifier and Type	Field and Description
protected final BeanProperty	_property
protected final Boolean	_unwrapSingle Setting for specific local override for "unwrap single element arrays": true for enable unwrapping, false for preventing it, `null` for using global configuration.

Constructor Summary

Access	Constructor and Description
protected	ArraySerializerBase(Class<T> cls)
protected	ArraySerializerBase(Class<T> cls, BeanProperty property) Deprecated Since 2.6 Use either variant that just takes type (non-contextual), or, copy constructor that allows passing of property.
protected	ArraySerializerBase(ArraySerializerBase<?> src) Deprecated as a consequence of `ArraySerializerBase` being deprecated.
protected	ArraySerializerBase(ArraySerializerBase<?> src, BeanProperty property, Boolean unwrapSingle) Deprecated as a consequence of `ArraySerializerBase` being deprecated.
protected	ArraySerializerBase(ArraySerializerBase<?> src, BeanProperty property) Deprecated Since 2.6

Method Summary

Modifier and Type	Method and Description
protected final boolean	_shouldUnwrapSingle(SerializerProvider provider)
public abstract JsonSerializer<?>	_withResolved(BeanProperty prop, Boolean unwrapSingle)
public JsonSerializer<?>	createContextual(SerializerProvider Serializer provider to use for accessing config, other serializers serializers, BeanProperty Method or field that represents the property (and is used to access value to serialize). Should be available; but there may be cases where caller cannot provide it and null is passed instead (in which case impls usually pass 'this' serializer as is) property) Implements com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual. Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property.
public void	serialize(T Value to serialize; can not be null. value, JsonGenerator Generator used to output resulting Json content gen, SerializerProvider Provider that can be used to get serializers for serializing Objects value contains, if any. provider) Implements abstract com.fasterxml.jackson.databind.ser.std.StdSerializer.serialize. Method that can be called to ask implementation to serialize values of type this serializer handles.
protected abstract void	serializeContents(T value, JsonGenerator jgen, SerializerProvider provider)
public final void	serializeWithType(T Value to serialize; can not be null. value, JsonGenerator Generator used to output resulting Json content g, SerializerProvider Provider that can be used to get serializers for serializing Objects value contains, if any. provider, TypeSerializer Type serializer to use for including type information typeSer) Overrides com.fasterxml.jackson.databind.JsonSerializer.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.

Inherited from com.fasterxml.jackson.databind.ser.ContainerSerializer:: _withValueTypeSerializer getContentSerializer getContentType hasContentTypeAnnotation hasSingleElement withValueTypeSerializer

Field Detail

_property	back to summary
protected final BeanProperty _property

_unwrapSingle	back to summary
protected final Boolean _unwrapSingle Setting for specific local override for "unwrap single element arrays": true for enable unwrapping, false for preventing it, `null` for using global configuration. Since 2.6

_unwrapSingle

back to summary

protected final Boolean _unwrapSingle

Setting for specific local override for "unwrap single element arrays": true for enable unwrapping, false for preventing it, `null` for using global configuration.

Since: 2.6

Constructor Detail

ArraySerializerBase	back to summary
protected ArraySerializerBase(Class<T> cls)

ArraySerializerBase	back to summary
protected ArraySerializerBase(Class<T> cls, BeanProperty property) Deprecated Since 2.6 Use either variant that just takes type (non-contextual), or, copy constructor that allows passing of property. Annotations @Deprecated

ArraySerializerBase

back to summary

protected ArraySerializerBase(Class<T> cls, BeanProperty property)

Deprecated

Since 2.6

Use either variant that just takes type (non-contextual), or, copy constructor that allows passing of property.

Annotations

@Deprecated

ArraySerializerBase	back to summary
protected ArraySerializerBase(ArraySerializerBase<?> src) Deprecated as a consequence of `ArraySerializerBase` being deprecated. See corresponding docs for further information.

ArraySerializerBase	back to summary
protected ArraySerializerBase(ArraySerializerBase<?> src, BeanProperty property, Boolean unwrapSingle) Deprecated as a consequence of `ArraySerializerBase` being deprecated. See corresponding docs for further information. Since 2.6

ArraySerializerBase	back to summary
protected ArraySerializerBase(ArraySerializerBase<?> src, BeanProperty property) Deprecated Since 2.6 Annotations @Deprecated

Method Detail

_shouldUnwrapSingle	back to summary
protected final boolean _shouldUnwrapSingle(SerializerProvider provider) Since 2.9

_withResolved	back to summary
public abstract JsonSerializer<?> _withResolved(BeanProperty prop, Boolean unwrapSingle) Since 2.6

createContextual	back to summary
public JsonSerializer<?> createContextual(SerializerProvider serializers, BeanProperty property) throws JsonMappingException Implements com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual. Doc from com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual. Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property. 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. Parameters serializers:SerializerProvider Serializer provider to use for accessing config, other serializers property:BeanProperty Method or field that represents the property (and is used to access value to serialize). Should be available; but there may be cases where caller cannot provide it and null is passed instead (in which case impls usually pass 'this' serializer as is) Returns:JsonSerializer<?> Serializer to use for serializing values of specified property; may be this instance or a new instance. Annotations @Override

createContextual

back to summary

public JsonSerializer<?> createContextual(SerializerProvider serializers, BeanProperty property) throws JsonMappingException

Implements com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual.

Doc from com.fasterxml.jackson.databind.ser.ContextualSerializer.createContextual.

Method called to see if a different (or differently configured) serializer is needed to serialize values of specified property. 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.

Parameters

serializers:SerializerProvider: Serializer provider to use for accessing config, other serializers
property:BeanProperty: Method or field that represents the property (and is used to access value to serialize). Should be available; but there may be cases where caller cannot provide it and null is passed instead (in which case impls usually pass 'this' serializer as is)

Returns:JsonSerializer<?>

Serializer to use for serializing values of specified property; may be this instance or a new instance.

Annotations

@Override

serialize	back to summary
public void serialize(T value, JsonGenerator gen, SerializerProvider provider) throws IOException Implements abstract com.fasterxml.jackson.databind.ser.std.StdSerializer.serialize. Doc from com.fasterxml.jackson.databind.JsonSerializer.serialize. Method that can be called to ask implementation to serialize values of type this serializer handles. Parameters value:T Value to serialize; can not be null. gen:JsonGenerator Generator used to output resulting Json content provider:SerializerProvider Provider that can be used to get serializers for serializing Objects value contains, if any. Annotations @Override

serialize

back to summary

public void serialize(T value, JsonGenerator gen, SerializerProvider provider) throws IOException

Implements abstract com.fasterxml.jackson.databind.ser.std.StdSerializer.serialize.

Doc from com.fasterxml.jackson.databind.JsonSerializer.serialize.

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

Parameters

value:T: Value to serialize; can not be null.
gen:JsonGenerator: Generator used to output resulting Json content
provider:SerializerProvider: Provider that can be used to get serializers for serializing Objects value contains, if any.

Annotations

@Override

serializeContents	back to summary
protected abstract void serializeContents(T value, JsonGenerator jgen, SerializerProvider provider) throws IOException

serializeWithType back to summary

serializeWithType	back to summary
public final void serializeWithType(T value, JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer) throws IOException Overrides com.fasterxml.jackson.databind.JsonSerializer.serializeWithType. Doc from com.fasterxml.jackson.databind.JsonSerializer.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. Parameters value:T Value to serialize; can not be null. g:JsonGenerator Generator used to output resulting Json content provider:SerializerProvider Provider that can be used to get serializers for serializing Objects value contains, if any. typeSer:TypeSerializer Type serializer to use for including type information Annotations @Override

public final void serializeWithType(T value, JsonGenerator g, SerializerProvider provider, TypeSerializer typeSer) throws IOException

Overrides com.fasterxml.jackson.databind.JsonSerializer.serializeWithType.

Doc from com.fasterxml.jackson.databind.JsonSerializer.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.

Parameters

value:T: Value to serialize; can not be null.
g:JsonGenerator: Generator used to output resulting Json content
provider:SerializerProvider: Provider that can be used to get serializers for serializing Objects value contains, if any.
typeSer:TypeSerializer: Type serializer to use for including type information

Annotations

@Override

public abstract Class ArraySerializerBase<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail