Jackson 3.0.1 · tools.jackson.databind.ser.std.ArraySerializerBase

Field Summary

Modifier and Type	Field and Description
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.

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

Constructor Summary

Access	Constructor and Description
protected	ArraySerializerBase(Class<T> cls)
protected	ArraySerializerBase(ArraySerializerBase<?> src)
protected	ArraySerializerBase(ArraySerializerBase<?> src, BeanProperty property, Boolean unwrapSingle)

Method Summary

Modifier and Type	Method and Description
protected final boolean	_shouldUnwrapSingle(SerializationContext provider)
public abstract ValueSerializer<?>	_withResolved(BeanProperty prop, Boolean unwrapSingle)
public ValueSerializer<?>	createContextual(SerializationContext serializers, 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	serializeContents(T value, JsonGenerator jgen, SerializationContext provider)
public final void	serializeWithType(T value, JsonGenerator g, 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.

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

Field Detail

_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.

Constructor Detail

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

ArraySerializerBase	back to summary
protected ArraySerializerBase(ArraySerializerBase<?> src)

ArraySerializerBase	back to summary
protected ArraySerializerBase(ArraySerializerBase<?> src, BeanProperty property, Boolean unwrapSingle)

Method Detail

_shouldUnwrapSingle	back to summary
protected final boolean _shouldUnwrapSingle(SerializationContext provider)

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

createContextual	back to summary
public ValueSerializer<?> createContextual(SerializationContext serializers, 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 serializers, 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

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

serializeWithType back to summary

serializeWithType	back to summary
public final void serializeWithType(T value, JsonGenerator g, 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 final void serializeWithType(T value, JsonGenerator g, 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.