Jackson 3.0.1 · tools.jackson.datatype.guava.ser.TableSerializer

Modifier and Type	Field and Description
private final ValueSerializer<Object>	_columnSerializer
private final MapSerializer	_rowMapSerializer
private final ValueSerializer<Object>	_rowSerializer
private final JavaType	_type Type declaration that defines parameters; may be a supertype of actual type of property being serialized.
private final ValueSerializer<Object>	_valueSerializer
private final TypeSerializer	_valueTypeSerializer

Access	Constructor and Description
public	TableSerializer(JavaType type)
protected	TableSerializer(final TableSerializer src, final BeanProperty property, final TypeFactory typeFactory, final ValueSerializer<?> rowKeySerializer, final ValueSerializer<?> columnKeySerializer, final TypeSerializer valueTypeSerializer, final ValueSerializer<?> valueSerializer)
protected	TableSerializer(final TableSerializer src, TypeSerializer typeSer)

Method Summary

Modifier and Type	Method and Description
protected StdContainerSerializer<?>	_withValueTypeSerializer(final TypeSerializer typeSer) 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 ValueSerializer<?>	createContextual(final SerializationContext ctxt, final 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).
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.
public boolean	hasSingleElement(final Table<?, ?, ?> table) Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.hasSingleElement. Method called to determine if the given value (of type handled by this serializer) contains exactly one element.
public boolean	isEmpty(SerializationContext ctxt, Table<?, ?, ?> table) 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(final Table<?, ?, ?> value, final JsonGenerator gen, final 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 final void	serializeEntries(final Table<?, ?, ?> table, final JsonGenerator g, final SerializationContext ctxt)
public void	serializeWithType(final Table<?, ?, ?> value, final JsonGenerator g, final SerializationContext ctxt, final 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 TableSerializer	withResolved(final BeanProperty property, final TypeFactory typeFactory, final ValueSerializer<?> rowKeySer, final ValueSerializer<?> columnKeySer, final TypeSerializer vts, final ValueSerializer<?> valueSer)

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

_columnSerializer	back to summary
private final ValueSerializer<Object> _columnSerializer

_rowMapSerializer	back to summary
private final MapSerializer _rowMapSerializer

_rowSerializer	back to summary
private final ValueSerializer<Object> _rowSerializer

_type	back to summary
private final JavaType _type Type declaration that defines parameters; may be a supertype of actual type of property being serialized.

_valueSerializer	back to summary
private final ValueSerializer<Object> _valueSerializer

_valueTypeSerializer	back to summary
private final TypeSerializer _valueTypeSerializer

TableSerializer	back to summary
public TableSerializer(JavaType type)

TableSerializer	back to summary
protected TableSerializer(final TableSerializer src, final BeanProperty property, final TypeFactory typeFactory, final ValueSerializer<?> rowKeySerializer, final ValueSerializer<?> columnKeySerializer, final TypeSerializer valueTypeSerializer, final ValueSerializer<?> valueSerializer) Annotations @SuppressWarnings:unchecked

TableSerializer	back to summary
protected TableSerializer(final TableSerializer src, TypeSerializer typeSer)

Method Detail

_withValueTypeSerializer back to summary

_withValueTypeSerializer	back to summary
protected StdContainerSerializer<?> _withValueTypeSerializer(final TypeSerializer typeSer) 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(final TypeSerializer typeSer)

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

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

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

hasSingleElement back to summary

hasSingleElement	back to summary
public boolean hasSingleElement(final Table<?, ?, ?> table) Implements abstract tools.jackson.databind.ser.std.StdContainerSerializer.hasSingleElement. Doc from tools.jackson.databind.ser.std.StdContainerSerializer.hasSingleElement. Method called to determine if the given value (of type handled by this serializer) contains exactly one element. Note although it might seem sensible to instead define something like "getElementCount()" method, this would not work well for containers that do not keep track of size (like linked lists may not). Note, too, that this method is only called by serializer itself; and specifically is not used for non-array/collection types like `Map` or `Map.Entry` instances. Annotations @Override

public boolean hasSingleElement(final Table<?, ?, ?> table)

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

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

Method called to determine if the given value (of type handled by this serializer) contains exactly one element.

Note

although it might seem sensible to instead define something like "getElementCount()" method, this would not work well for containers that do not keep track of size (like linked lists may not).

Note, too, that this method is only called by serializer itself; and specifically is not used for non-array/collection types like Map or Map.Entry instances.

Annotations

@Override

isEmpty	back to summary
public boolean isEmpty(SerializationContext ctxt, Table<?, ?, ?> table) 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 boolean isEmpty(SerializationContext ctxt, Table<?, ?, ?> table)

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(final Table<?, ?, ?> value, final JsonGenerator gen, final 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(final Table<?, ?, ?> value, final JsonGenerator gen, final 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

serializeEntries	back to summary
private final void serializeEntries(final Table<?, ?, ?> table, final JsonGenerator g, final SerializationContext ctxt) throws JacksonException

serializeWithType back to summary

serializeWithType	back to summary
public void serializeWithType(final Table<?, ?, ?> value, final JsonGenerator g, final SerializationContext ctxt, final 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(final Table<?, ?, ?> value, final JsonGenerator g, final SerializationContext ctxt, final 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 TableSerializer withResolved(final BeanProperty property, final TypeFactory typeFactory, final ValueSerializer<?> rowKeySer, final ValueSerializer<?> columnKeySer, final TypeSerializer vts, final ValueSerializer<?> valueSer)

public Class TableSerializer

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail