Package org.codehaus.jackson.map.ser.std

Class ToStringSerializer

java.lang.Object

org.codehaus.jackson.map.JsonSerializer<Object>

org.codehaus.jackson.map.ser.std.SerializerBase<Object>

org.codehaus.jackson.map.ser.std.ToStringSerializer

All Implemented Interfaces:

SchemaAware

Direct Known Subclasses:

ToStringSerializer

public class ToStringSerializer
extends SerializerBase<Object>

Simple general purpose serializer, useful for any type for which Object.toString() returns the desired JSON value.

Nested Class Summary

Nested classes/interfaces inherited from class org.codehaus.jackson.map.JsonSerializer

JsonSerializer.None

Field Summary

Fields

Modifier and Type	Field	Description
static final ToStringSerializer	instance	Singleton instance to use.

Fields inherited from class org.codehaus.jackson.map.ser.std.SerializerBase

_handledType

Constructor Summary

Constructors

Constructor	Description
ToStringSerializer()	Note: usually you should NOT create new instances, but instead use instance which is stateless and fully thread-safe.

Method Summary

Modifier and Type	Method	Description
JsonNode	getSchema(SerializerProvider provider, Type typeHint)	Note: since Jackson 1.9, default implementation claims type is "string"
void	serialize(Object value, JsonGenerator jgen, SerializerProvider provider)	Method that can be called to ask implementation to serialize values of type this serializer handles.
void	serializeWithType(Object value, JsonGenerator jgen, SerializerProvider provider, 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.

Methods inherited from class org.codehaus.jackson.map.ser.std.SerializerBase

createObjectNode, createSchemaNode, createSchemaNode, handledType, isDefaultSerializer, wrapAndThrow, wrapAndThrow, wrapAndThrow, wrapAndThrow

Methods inherited from class org.codehaus.jackson.map.JsonSerializer

isUnwrappingSerializer, unwrappingSerializer

Methods inherited from class java.lang.Object

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

Field Details

instance

public static final ToStringSerializer instance

Singleton instance to use.

Constructor Details

ToStringSerializer

public ToStringSerializer()

Note: usually you should NOT create new instances, but instead use instance which is stateless and fully thread-safe. However, there are cases where constructor is needed; for example, when using explicit serializer annotations like JsonSerialize.using().

Method Details

serialize

public void serialize(Object value,
 JsonGenerator jgen,
 SerializerProvider provider)
               throws IOException,
JsonGenerationException

Description copied from class: JsonSerializer

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

Specified by:

serialize in class SerializerBase<Object>

Parameters:

value - Value to serialize; can not be null.

jgen - Generator used to output resulting Json content

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

Throws:

IOException

JsonGenerationException

serializeWithType

public void serializeWithType(Object value,
 JsonGenerator jgen,
 SerializerProvider provider,
 TypeSerializer typeSer)
                       throws IOException,
JsonGenerationException

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

Parameters:

value - Value to serialize; can not be null.

jgen - Generator used to output resulting Json content

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

typeSer - Type serializer to use for including type information

Throws:

IOException

JsonGenerationException

getSchema

public JsonNode getSchema(SerializerProvider provider,
 Type typeHint)
                   throws JsonMappingException

Description copied from class: SerializerBase

Note: since Jackson 1.9, default implementation claims type is "string"

Specified by:

getSchema in interface SchemaAware

Overrides:

getSchema in class SerializerBase<Object>

Parameters:

provider - The serializer provider.

typeHint - A hint about the type.

Returns:

Json-schema for this serializer.

Throws:

JsonMappingException