Top Fields Constructors Methods
com.fasterxml.jackson.datatype.guava.ser

public Class TableSerializer

extends ContainerSerializer<Table<?, ?, ?>>
implements ContextualSerializer
Class Inheritance
All Implemented Interfaces
com.fasterxml.jackson.databind.ser.ContextualSerializer
Imports
java.io.IOException, java.util.Map, .Set, com.fasterxml.jackson.core.*, com.fasterxml.jackson.core.type.WritableTypeId, com.fasterxml.jackson.databind.*, com.fasterxml.jackson.databind.jsontype.TypeSerializer, com.fasterxml.jackson.databind.ser.ContainerSerializer, .ContextualSerializer, com.fasterxml.jackson.databind.ser.std.MapSerializer, com.fasterxml.jackson.databind.type.MapType, .TypeFactory, com.google.common.collect.Table

References Deprecated

ContainerSerializer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Authors
stevenmhood (via hyandell) - Initial implementation, tatu - Some refactoring to streamline code

Field Summary

Modifier and TypeField and Description
private final JsonSerializer<Object>
_columnSerializer

private final BeanProperty
_property

private final MapSerializer
_rowMapSerializer

References Deprecated MapSerializer is deprecated or references (maybe indirectly) at least one deprecated element.
private final JsonSerializer<Object>
_rowSerializer

private final JavaType
_type

Type declaration that defines parameters; may be a supertype of actual type of property being serialized.

private final JsonSerializer<Object>
_valueSerializer

private final TypeSerializer
_valueTypeSerializer

private static final long
serialVersionUID

Hides com.fasterxml.jackson.databind.ser.std.StdSerializer.serialVersionUID.

Constructor Summary

AccessConstructor and Description
public
TableSerializer(final JavaType type)

protected
TableSerializer(final TableSerializer src, final BeanProperty property, final TypeFactory typeFactory, final JsonSerializer<?> rowKeySerializer, final JsonSerializer<?> columnKeySerializer, final TypeSerializer valueTypeSerializer, final JsonSerializer<?> valueSerializer)
References Deprecated TableSerializer is deprecated or references (maybe indirectly) at least one deprecated element.

protected
TableSerializer(final TableSerializer src, TypeSerializer typeSer)
References Deprecated TableSerializer is deprecated or references (maybe indirectly) at least one deprecated element.

Method Summary

Modifier and TypeMethod and Description
protected ContainerSerializer<?>
_withValueTypeSerializer(final TypeSerializer typeSer)

Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer._withValueTypeSerializer.

References Deprecated ContainerSerializer is deprecated or references (maybe indirectly) at least one deprecated element.

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 JsonSerializer<?>
createContextual(final SerializerProvider
Serializer provider to use for accessing config, other serializers
provider, final 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 JsonSerializer<?>
getContentSerializer()

Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer.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 com.fasterxml.jackson.databind.ser.ContainerSerializer.getContentType.

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

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

Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer.hasSingleElement.

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

public boolean
isEmpty(SerializerProvider provider, Table<?, ?, ?> table)

Overrides com.fasterxml.jackson.databind.JsonSerializer.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 to serialize; can not be null.
value, final JsonGenerator
Generator used to output resulting Json content
gen, final 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.

private final void
serializeFields(final Table<?, ?, ?> table, final JsonGenerator jgen, final SerializerProvider provider)

public void
serializeWithType(final Table<?, ?, ?>
Value to serialize; can not be null.
value, final JsonGenerator
Generator used to output resulting Json content
gen, final SerializerProvider
Provider that can be used to get serializers for serializing Objects value contains, if any.
provider, final 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.

protected TableSerializer
withResolved(final BeanProperty property, final TypeFactory typeFactory, final JsonSerializer<?> rowKeySer, final JsonSerializer<?> columnKeySer, final TypeSerializer vts, final JsonSerializer<?> valueSer)
References Deprecated TableSerializer is deprecated or references (maybe indirectly) at least one deprecated element.

Inherited from com.fasterxml.jackson.databind.ser.ContainerSerializer:
hasContentTypeAnnotationwithValueTypeSerializer

Field Detail

_columnSerializerback to summary
private final JsonSerializer<Object> _columnSerializer
_propertyback to summary
private final BeanProperty _property
_rowMapSerializerback to summary
private final MapSerializer _rowMapSerializer

References Deprecated

MapSerializer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

_rowSerializerback to summary
private final JsonSerializer<Object> _rowSerializer
_typeback to summary
private final JavaType _type

Type declaration that defines parameters; may be a supertype of actual type of property being serialized.

_valueSerializerback to summary
private final JsonSerializer<Object> _valueSerializer
_valueTypeSerializerback to summary
private final TypeSerializer _valueTypeSerializer
serialVersionUIDback to summary
private static final long serialVersionUID

Hides com.fasterxml.jackson.databind.ser.std.StdSerializer.serialVersionUID.

Constructor Detail

TableSerializerback to summary
public TableSerializer(final JavaType type)
TableSerializerback to summary
protected TableSerializer(final TableSerializer src, final BeanProperty property, final TypeFactory typeFactory, final JsonSerializer<?> rowKeySerializer, final JsonSerializer<?> columnKeySerializer, final TypeSerializer valueTypeSerializer, final JsonSerializer<?> valueSerializer)

References Deprecated

TableSerializer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Annotations
@SuppressWarnings:unchecked
TableSerializerback to summary
protected TableSerializer(final TableSerializer src, TypeSerializer typeSer)

References Deprecated

TableSerializer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

Method Detail

_withValueTypeSerializerback to summary
protected ContainerSerializer<?> _withValueTypeSerializer(final TypeSerializer typeSer)

Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer._withValueTypeSerializer.

Doc from com.fasterxml.jackson.databind.ser.ContainerSerializer._withValueTypeSerializer.

References Deprecated

ContainerSerializer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.

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
createContextualback to summary
public JsonSerializer<?> createContextual(final SerializerProvider provider, final 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
provider: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
getContentSerializerback to summary
public JsonSerializer<?> getContentSerializer()

Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer.getContentSerializer.

Doc from com.fasterxml.jackson.databind.ser.ContainerSerializer.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 com.fasterxml.jackson.databind.SerializerProvider#findContentValueSerializer.

Annotations
@Override
getContentTypeback to summary
public JavaType getContentType()

Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer.getContentType.

Doc from com.fasterxml.jackson.databind.ser.ContainerSerializer.getContentType.

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

Annotations
@Override
hasSingleElementback to summary
public boolean hasSingleElement(final Table<?, ?, ?> table)

Implements abstract com.fasterxml.jackson.databind.ser.ContainerSerializer.hasSingleElement.

Doc from com.fasterxml.jackson.databind.ser.ContainerSerializer.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 as of now (2.9) 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
isEmptyback to summary
public boolean isEmpty(SerializerProvider provider, Table<?, ?, ?> table)

Overrides com.fasterxml.jackson.databind.JsonSerializer.isEmpty.

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

Note

replaces isEmpty(Object), which was deprecated in 2.5

Annotations
@Override
serializeback to summary
public void serialize(final Table<?, ?, ?> value, final JsonGenerator gen, final 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:Table<?, ?, ?>

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
serializeFieldsback to summary
private final void serializeFields(final Table<?, ?, ?> table, final JsonGenerator jgen, final SerializerProvider provider) throws IOException
serializeWithTypeback to summary
public void serializeWithType(final Table<?, ?, ?> value, final JsonGenerator gen, final SerializerProvider provider, final 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:Table<?, ?, ?>

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.

typeSer:TypeSerializer

Type serializer to use for including type information

Annotations
@Override
withResolvedback to summary
protected TableSerializer withResolved(final BeanProperty property, final TypeFactory typeFactory, final JsonSerializer<?> rowKeySer, final JsonSerializer<?> columnKeySer, final TypeSerializer vts, final JsonSerializer<?> valueSer)

References Deprecated

TableSerializer is deprecated or references (maybe indirectly) at least one deprecated element.

See corresponding docs for further information.