Module tools.jackson.databind

Package tools.jackson.databind.util

Class JSONPObject

java.lang.Object

tools.jackson.databind.util.JSONPObject

All Implemented Interfaces:

JacksonSerializable

public class JSONPObject
extends Object
implements JacksonSerializable

Container class that can be used to wrap any Object instances (including nulls), and will serialize embedded in JSONP wrapping.

See Also:

• JSONWrappedObject

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	_function	JSONP function name to use for serialization
protected final JavaType	_serializationType	Optional static type to use for serialization; if null, runtime type is used.
protected final Object	_value	Value to be serialized as JSONP padded; can be null.

Constructor Summary

Constructors

Constructor	Description
JSONPObject(String function, Object value)
JSONPObject(String function, Object value, JavaType asType)

Method Summary

Modifier and Type	Method	Description
String	getFunction()
JavaType	getSerializationType()
Object	getValue()
void	serialize(tools.jackson.core.JsonGenerator gen, SerializationContext ctxt)	Serialization method called when no additional type information is to be included in serialization.
void	serializeWithType(tools.jackson.core.JsonGenerator gen, SerializationContext ctxt, 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

_function

protected final String _function

JSONP function name to use for serialization

_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

JSONPObject

public JSONPObject(String function,
 Object value)

JSONPObject

public JSONPObject(String function,
 Object value,
 JavaType asType)

Method Details

serializeWithType

public void serializeWithType(tools.jackson.core.JsonGenerator gen,
 SerializationContext ctxt,
 TypeSerializer typeSer)
                       throws tools.jackson.core.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:

tools.jackson.core.JacksonException

serialize

public void serialize(tools.jackson.core.JsonGenerator gen,
 SerializationContext ctxt)
               throws tools.jackson.core.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:

tools.jackson.core.JacksonException

getFunction

public String getFunction()

getValue

public Object getValue()

getSerializationType

public JavaType getSerializationType()