Module tools.jackson.databind

Package tools.jackson.databind.util

Class JSONWrappedObject

java.lang.Object

tools.jackson.databind.util.JSONWrappedObject

All Implemented Interfaces:

JacksonSerializable

public class JSONWrappedObject
extends Object
implements JacksonSerializable

General-purpose wrapper class that can be used to decorate serialized value with arbitrary literal prefix and suffix. This can be used for example to construct arbitrary Javascript values (similar to how basic function name and parenthesis are used with JSONP).

See Also:

• JSONPObject

Nested Class Summary

Nested classes/interfaces inherited from interface tools.jackson.databind.JacksonSerializable

JacksonSerializable.Base

Field Summary

Fields

Modifier and Type	Field	Description
protected final String	_prefix	Literal String to output before serialized value.
protected final JavaType	_serializationType	Optional static type to use for serialization; if null, runtime type is used.
protected final String	_suffix	Literal String to output after serialized value.
protected final Object	_value	Value to be serialized as JSONP padded; can be null.

Constructor Summary

Constructors

Constructor	Description
JSONWrappedObject(String prefix, String suffix, Object value)
JSONWrappedObject(String prefix, String suffix, Object value, JavaType asType)	Constructor that should be used when specific serialization type to use is important, and needs to be passed instead of just using runtime (type-erased) type of the value.

Method Summary

Modifier and Type	Method	Description
String	getPrefix()
JavaType	getSerializationType()
String	getSuffix()
Object	getValue()
void	serialize(JsonGenerator g, SerializationContext provider)	Serialization method called when no additional type information is to be included in serialization.
void	serializeWithType(JsonGenerator g, SerializationContext provider, TypeSerializer typeSer)	Serialization method called when additional type information is expected to be included in serialization, for deserialization to use.

Methods inherited from class java.lang.Object

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

Field Details

_prefix

protected final String _prefix

Literal String to output before serialized value. Will not be quoted when serializing value.

_suffix

protected final String _suffix

Literal String to output after serialized value. Will not be quoted when serializing value.

_value

protected final Object _value

Value to be serialized as JSONP padded; can be null.

_serializationType

protected final JavaType _serializationType

Optional static type to use for serialization; if null, runtime type is used. Can be used to specify declared type which defines serializer to use, as well as aspects of extra type information to include (if any).

Constructor Details

JSONWrappedObject

public JSONWrappedObject(String prefix,
 String suffix,
 Object value)

JSONWrappedObject

public JSONWrappedObject(String prefix,
 String suffix,
 Object value,
 JavaType asType)

Constructor that should be used when specific serialization type to use is important, and needs to be passed instead of just using runtime (type-erased) type of the value.

Method Details

serializeWithType

public void serializeWithType(JsonGenerator g,
 SerializationContext provider,
 TypeSerializer typeSer)
                       throws JacksonException

Description copied from interface: JacksonSerializable

Serialization method called when additional type information is expected to be included in serialization, for deserialization to use.

Usually implementation consists of a call to TypeSerializer.writeTypePrefix(tools.jackson.core.JsonGenerator, tools.jackson.databind.SerializationContext, tools.jackson.core.type.WritableTypeId) followed by serialization of contents, followed by a call to TypeSerializer.writeTypeSuffix(tools.jackson.core.JsonGenerator, tools.jackson.databind.SerializationContext, tools.jackson.core.type.WritableTypeId)). Details of the type id argument to pass depend on shape of JSON Object used (Array, Object or scalar like String/Number/Boolean).

Note that some types (most notably, "natural" types: String, Integer, Double and Boolean) never include type information.

Specified by:

serializeWithType in interface JacksonSerializable

Throws:

JacksonException

serialize

public void serialize(JsonGenerator g,
 SerializationContext provider)
               throws JacksonException

Description copied from interface: JacksonSerializable

Serialization method called when no additional type information is to be included in serialization.

Specified by:

serialize in interface JacksonSerializable

Throws:

JacksonException

getPrefix

public String getPrefix()

getSuffix

public String getSuffix()

getValue

public Object getValue()

getSerializationType

public JavaType getSerializationType()