Module tools.jackson.databind

Package tools.jackson.databind.ser.jackson

Class JacksonSerializableSerializer

java.lang.Object

tools.jackson.databind.ValueSerializer<T>

tools.jackson.databind.ser.std.StdSerializer<JacksonSerializable>

tools.jackson.databind.ser.jackson.JacksonSerializableSerializer

All Implemented Interfaces:

JsonFormatVisitable

public class JacksonSerializableSerializer
extends StdSerializer<JacksonSerializable>

Generic handler for types that implement JacksonSerializable.

Note: given that this is used for anything that implements interface, cannot be checked for direct class equivalence.

NOTE: in Jackson 2.x was named JsonSerializableSerializer

Nested Class Summary

Nested classes/interfaces inherited from class tools.jackson.databind.ValueSerializer

ValueSerializer.None

Field Summary

Fields

Modifier and Type	Field	Description
static final JacksonSerializableSerializer	instance

Fields inherited from class tools.jackson.databind.ser.std.StdSerializer

_handledType

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	JacksonSerializableSerializer()

Method Summary

Modifier and Type	Method	Description
void	acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)	Default implementation specifies no format.
boolean	isEmpty(SerializationContext serializers, JacksonSerializable value)	Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).
void	serialize(JacksonSerializable value, JsonGenerator gen, SerializationContext serializers)	Method that can be called to ask implementation to serialize values of type this serializer handles.
final void	serializeWithType(JacksonSerializable value, JsonGenerator gen, SerializationContext serializers, TypeSerializer typeSer)	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.

Methods inherited from class tools.jackson.databind.ser.std.StdSerializer

_neitherNull, _nonEmpty, _wrapIOFailure, acceptJsonFormatVisitorForBinary, createSchemaNode, createSchemaNode, findAnnotatedContentSerializer, findContextualConvertingSerializer, findFormatFeature, findFormatOverrides, findIncludeOverrides, findPropertyFilter, handledType, isDefaultSerializer, visitArrayFormat, visitArrayFormat, visitFloatFormat, visitIntFormat, visitIntFormat, visitStringFormat, visitStringFormat, wrapAndThrow, wrapAndThrow

Methods inherited from class tools.jackson.databind.ValueSerializer

createContextual, getDelegatee, isUnwrappingSerializer, properties, replaceDelegatee, resolve, unwrappingSerializer, usesObjectId, withFilterId, withFormatOverrides, withIgnoredProperties

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

instance

public static final JacksonSerializableSerializer instance

Constructor Details

JacksonSerializableSerializer

protected JacksonSerializableSerializer()

Method Details

isEmpty

public boolean isEmpty(SerializationContext serializers,
 JacksonSerializable value)

Description copied from class: ValueSerializer

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.

Overrides:

isEmpty in class ValueSerializer<JacksonSerializable>

serialize

public void serialize(JacksonSerializable value,
 JsonGenerator gen,
 SerializationContext serializers)
               throws JacksonException

Description copied from class: ValueSerializer

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

Specified by:

serialize in class StdSerializer<JacksonSerializable>

Parameters:

value - Value to serialize; can not be null.

gen - Generator used to output resulting Json content

serializers - Context that can be used to get serializers for serializing Objects value contains, if any.

Throws:

JacksonException

serializeWithType

public final void serializeWithType(JacksonSerializable value,
 JsonGenerator gen,
 SerializationContext serializers,
 TypeSerializer typeSer)
                             throws JacksonException

Description copied from class: ValueSerializer

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.

Overrides:

serializeWithType in class ValueSerializer<JacksonSerializable>

Parameters:

value - Value to serialize; can not be null.

gen - Generator used to output resulting Json content

serializers - Context that can be used to get serializers for serializing Objects value contains, if any.

typeSer - Type serializer to use for including type information

Throws:

JacksonException

acceptJsonFormatVisitor

public void acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor,
 JavaType typeHint)

Description copied from class: StdSerializer

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

Specified by:

acceptJsonFormatVisitor in interface JsonFormatVisitable

Overrides:

acceptJsonFormatVisitor in class StdSerializer<JacksonSerializable>

typeHint - Type of element (entity like property) being visited