Module tools.jackson.databind

Package tools.jackson.databind.ser.std

Class ToStringSerializerBase

java.lang.Object

tools.jackson.databind.ValueSerializer<T>

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

tools.jackson.databind.ser.std.ToStringSerializerBase

All Implemented Interfaces:

JsonFormatVisitable

Direct Known Subclasses:

ToStringSerializer, ZoneIdSerializer

public abstract class ToStringSerializerBase
extends StdSerializer<Object>

Intermediate base class that serves as base for standard ToStringSerializer as well as for custom subtypes that want to add processing for converting from value to output into its String representation (whereas standard version simply calls value object's toString() method).

Nested Class Summary

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

ValueSerializer.None

Field Summary

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

_handledType

Constructor Summary

Constructors

Constructor	Description
ToStringSerializerBase(Class<?> handledType)

Method Summary

Modifier and Type	Method	Description
void	acceptJsonFormatVisitor(JsonFormatVisitorWrapper visitor, JavaType typeHint)	Default implementation specifies no format.
boolean	isEmpty(SerializationContext prov, Object value)	Method called to check whether given serializable value is considered "empty" value (for purposes of suppressing serialization of empty values).
void	serialize(Object value, JsonGenerator gen, SerializationContext provider)	Method that can be called to ask implementation to serialize values of type this serializer handles.
void	serializeWithType(Object value, JsonGenerator g, SerializationContext ctxt, TypeSerializer typeSer)	Default implementation will write type prefix, call regular serialization method (since assumption is that value itself does not need JSON Array or Object start/end markers), and then write type suffix.
abstract String	valueToString(Object value)

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

Constructor Details

ToStringSerializerBase

public ToStringSerializerBase(Class<?> handledType)

Method Details

isEmpty

public boolean isEmpty(SerializationContext prov,
 Object 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<Object>

serialize

public void serialize(Object value,
 JsonGenerator gen,
 SerializationContext provider)
               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<Object>

Parameters:

value - Value to serialize; can not be null.

gen - Generator used to output resulting Json content

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

Throws:

JacksonException

serializeWithType

public void serializeWithType(Object value,
 JsonGenerator g,
 SerializationContext ctxt,
 TypeSerializer typeSer)
                       throws JacksonException

Default implementation will write type prefix, call regular serialization method (since assumption is that value itself does not need JSON Array or Object start/end markers), and then write type suffix. This should work for most cases; some sub-classes may want to change this behavior.

Overrides:

serializeWithType in class ValueSerializer<Object>

Parameters:

value - Value to serialize; can not be null.

g - Generator used to output resulting Json content

ctxt - 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<Object>

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

valueToString

public abstract String valueToString(Object value)