Jackson 3.0.1 · tools.jackson.datatype.hppc.ser.ContainerSerializerBase

Modifier and Type	Field and Description
protected final String	_schemeElementType

Access	Constructor and Description
protected	ContainerSerializerBase(Class<T> type, String schemaElementType)
protected	ContainerSerializerBase(JavaType type, String schemaElementType)
protected	ContainerSerializerBase(ContainerSerializerBase<?> src)

Method Summary

Modifier and Type	Method and Description
protected StdContainerSerializer<?>	_withValueTypeSerializer(TypeSerializer vts) Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer._withValueTypeSerializer. Method that needs to be implemented to allow construction of a new serializer object with given `TypeSerializer`, used when addition type information is to be embedded.
public abstract void	acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) Redeclares tools.jackson.databind.jsonFormatVisitors.JsonFormatVisitable.acceptJsonFormatVisitor. Overrides tools.jackson.databind.ser.std.StdSerializer.acceptJsonFormatVisitor. Default implementation specifies no format.
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 ValueSerializer<?>	getSerializer(JavaType type)
public abstract boolean	isEmpty(SerializationContext ctxt, T value) Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.isEmpty. Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).
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.
protected abstract void	serializeContents(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.

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

_schemeElementType	back to summary
protected final String _schemeElementType

ContainerSerializerBase	back to summary
protected ContainerSerializerBase(Class<T> type, String schemaElementType)

ContainerSerializerBase	back to summary
protected ContainerSerializerBase(JavaType type, String schemaElementType)

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

Method Detail

_withValueTypeSerializer back to summary

_withValueTypeSerializer	back to summary
protected StdContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts) Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer._withValueTypeSerializer. Doc from tools.jackson.databind.ser.std.StdContainerSerializer._withValueTypeSerializer. Method that needs to be implemented to allow construction of a new serializer object with given `TypeSerializer`, used when addition type information is to be embedded. Annotations @Override

protected StdContainerSerializer<?> _withValueTypeSerializer(TypeSerializer vts)

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

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

Method that needs to be implemented to allow construction of a new serializer object with given TypeSerializer, used when addition type information is to be embedded.

Annotations

@Override

acceptJsonFormatVisitor	back to summary
public abstract void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint) Redeclares tools.jackson.databind.jsonFormatVisitors.JsonFormatVisitable.acceptJsonFormatVisitor. Overrides tools.jackson.databind.ser.std.StdSerializer.acceptJsonFormatVisitor. Doc from tools.jackson.databind.ser.std.StdSerializer.acceptJsonFormatVisitor. Default implementation specifies no format. This behavior is usually overriden by custom serializers. Annotations @Override

acceptJsonFormatVisitor

back to summary

public abstract void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)

Redeclares tools.jackson.databind.jsonFormatVisitors.JsonFormatVisitable.acceptJsonFormatVisitor.

Overrides tools.jackson.databind.ser.std.StdSerializer.acceptJsonFormatVisitor.

Doc from tools.jackson.databind.ser.std.StdSerializer.acceptJsonFormatVisitor.

Default implementation specifies no format. This behavior is usually overriden by custom serializers.

Annotations

@Override

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

getSerializer	back to summary
protected ValueSerializer<?> getSerializer(JavaType type)

isEmpty	back to summary
public abstract boolean isEmpty(SerializationContext ctxt, T value) Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.isEmpty. Doc from tools.jackson.databind.ValueSerializer.isEmpty. Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values). Default implementation will consider only null values to be empty. Annotations @Override

isEmpty

back to summary

public abstract boolean isEmpty(SerializationContext ctxt, T value)

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

Doc from tools.jackson.databind.ValueSerializer.isEmpty.

Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).

Default implementation will consider only null values to be empty.

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

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

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

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

public abstract Class ContainerSerializerBase<T>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail