ObjectReader (Jackson JSON Processor)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.codehaus.jackson.map
Class ObjectReader

java.lang.Object
  org.codehaus.jackson.ObjectCodec
      org.codehaus.jackson.map.ObjectReader

All Implemented Interfaces:: Versioned

public class ObjectReader
extends ObjectCodec
implements Versioned
extends ObjectCodec
implements Versioned

Builder object that can be used for per-serialization configuration of deserialization parameters, such as root type to use or object to update (instead of constructing new instance). Uses "fluid" (aka builder) pattern so that instances are immutable (and thus fully thread-safe with no external synchronization); new instances are constructed for different configurations. Instances are initially constructed by ObjectMapper and can be reused.

Since:: 1.6
Author:: tatu

Field Summary
`protected DeserializationConfig`	`_config` General serialization configuration settings; while immutable, can use copy-constructor to create modified instances as necessary.
`protected InjectableValues`	`_injectableValues` Values that can be injected during deserialization, if any.
`protected JsonFactory`	`_jsonFactory` Factory used for constructing `JsonGenerator`s
`protected DeserializerProvider`	`_provider`
`protected ConcurrentHashMap<JavaType,JsonDeserializer<Object>>`	`_rootDeserializers` Root-level cached deserializers
`protected FormatSchema`	`_schema` When using data format that uses a schema, schema is passed to parser.
`protected boolean`	`_unwrapRoot` Flag that indicates whether root values are expected to be unwrapped or not
`protected Object`	`_valueToUpdate` Instance to update with data binding; if any.
`protected JavaType`	`_valueType` Declared type of value to instantiate during deserialization.

Constructor Summary
`protected`	`ObjectReader(ObjectMapper mapper, DeserializationConfig config)` Constructor used by `ObjectMapper` for initial instantiation
`protected`	`ObjectReader(ObjectMapper mapper, DeserializationConfig config, JavaType valueType, Object valueToUpdate, FormatSchema schema, InjectableValues injectableValues)`
`protected`	`ObjectReader(ObjectReader base, DeserializationConfig config, JavaType valueType, Object valueToUpdate, FormatSchema schema, InjectableValues injectableValues)` Copy constructor used for building variations.

Method Summary

protected Object _bind(JsonParser jp)
Actual implementation of value reading+binding operation.

protected Object _bindAndClose(JsonParser jp)

protected JsonNode _bindAndCloseAsTree(JsonParser jp)

protected JsonNode _bindAsTree(JsonParser jp)

protected DeserializationContext _createDeserializationContext(JsonParser jp, DeserializationConfig cfg)

protected JsonDeserializer<Object> _findRootDeserializer(DeserializationConfig cfg, JavaType valueType)
Method called to locate deserializer for the passed root-level value.

protected static JsonToken _initForReading(JsonParser jp)

protected Object _unwrapAndDeserialize(JsonParser jp, DeserializationContext ctxt, JavaType rootType, JsonDeserializer<Object> deser)

JsonNode createArrayNode()
Method for construct root level Array nodes for Tree Model instances.

JsonNode createObjectNode()
Method for construct root level Object nodes for Tree Model instances.

JsonNode readTree(InputStream in)
Method that reads content from given input source, using configuration of this reader, and binds it as JSON Tree.

JsonNode readTree(JsonParser jp)
Convenience method that binds content read using given parser, using configuration of this reader, except that content is bound as JSON tree instead of configured root value type.

JsonNode readTree(Reader r)
Method that reads content from given input source, using configuration of this reader, and binds it as JSON Tree.

JsonNode readTree(String content)
Method that reads content from given JSON input String, using configuration of this reader, and binds it as JSON Tree.





<T> T

readValue(byte[] src)
Method that binds content read from given byte array, using configuration of this reader.





<T> T

readValue(byte[] src,
          int offset,
          int length)

Method that binds content read from given byte array, using configuration of this reader.





<T> T

readValue(File src)





<T> T

readValue(InputStream src)
Method that binds content read from given input source, using configuration of this reader.





<T> T

readValue(JsonNode src)
Convenience method for converting results from given JSON tree into given value type.





<T> T

readValue(JsonParser jp)
Method that binds content read using given parser, using configuration of this reader, including expected result type.





<T> T

readValue(JsonParser jp,
          Class<T> valueType)





<T> T

readValue(JsonParser jp,
          JavaType valueType)





<T> T

readValue(JsonParser jp,
          TypeReference<?> valueTypeRef)





<T> T

readValue(Reader src)
Method that binds content read from given input source, using configuration of this reader.





<T> T

readValue(String src)
Method that binds content read from given JSON string, using configuration of this reader.





<T> T

readValue(URL src)
Method that binds content read from given input source, using configuration of this reader.





<T> MappingIterator<T>

readValues(byte[] src,
           int offset,
           int length)

Method for reading sequence of Objects from parser stream.





<T> MappingIterator<T>

readValues(File src)
Method for reading sequence of Objects from parser stream.





<T> MappingIterator<T>

readValues(InputStream src)
Method for reading sequence of Objects from parser stream.





<T> MappingIterator<T>

readValues(JsonParser jp)
Method for reading sequence of Objects from parser stream.





<T> Iterator<T>

readValues(JsonParser jp,
           Class<T> valueType)

Convenience method that is equivalent to:





<T> Iterator<T>

readValues(JsonParser jp,
           JavaType valueType)

Convenience method that is equivalent to:





<T> Iterator<T>

readValues(JsonParser jp,
           TypeReference<?> valueTypeRef)

Convenience method that is equivalent to:





<T> MappingIterator<T>

readValues(Reader src)
Method for reading sequence of Objects from parser stream.





<T> MappingIterator<T>

readValues(String json)
Method for reading sequence of Objects from parser stream.





<T> MappingIterator<T>

readValues(URL src)
Method for reading sequence of Objects from parser stream.

JsonParser treeAsTokens(JsonNode n)
Method for constructing a JsonParser for reading contents of a JSON tree, as if it was external serialized JSON content.





<T> T

treeToValue(JsonNode n,
            Class<T> valueType)

Convenience method for converting given JSON tree into instance of specified value type.

Version version()
Method that will return version information stored in and read from jar that contains this class.

ObjectReader withInjectableValues(InjectableValues injectableValues)
Method for constructing a new instance with configuration that uses passed InjectableValues to provide injectable values.

ObjectReader withNodeFactory(JsonNodeFactory f)
Method for constructing a new reader instance with configuration that uses passed JsonNodeFactory for constructing JsonNode instances.

ObjectReader withSchema(FormatSchema schema)
Method for constructing a new instance with configuration that passes specified FormatSchema to JsonParser that is constructed for parsing content.

ObjectReader withType(Class<?> valueType)
Method for constructing a new reader instance that is configured to data bind into specified type.

ObjectReader withType(JavaType valueType)
Method for constructing a new reader instance that is configured to data bind into specified type.

ObjectReader withType(Type valueType)
Method for constructing a new reader instance that is configured to data bind into specified type.

ObjectReader withType(TypeReference<?> valueTypeRef)
Method for constructing a new reader instance that is configured to data bind into specified type.

ObjectReader withValueToUpdate(Object value)
Method for constructing a new instance with configuration that updates passed Object (as root value), instead of constructing a new value.

void writeTree(JsonGenerator jgen, JsonNode rootNode)
NOTE: NOT implemented for ObjectReader.

void writeValue(JsonGenerator jgen, Object value)
Method to serialize given Java Object, using generator provided.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Field Detail

_config

protected final DeserializationConfig _config

General serialization configuration settings; while immutable, can use copy-constructor to create modified instances as necessary.

_unwrapRoot

protected final boolean _unwrapRoot

Flag that indicates whether root values are expected to be unwrapped or not

Since:: 1.9

_rootDeserializers

protected final ConcurrentHashMap<JavaType,JsonDeserializer<Object>> _rootDeserializers

Root-level cached deserializers

_provider

protected final DeserializerProvider _provider

_jsonFactory

protected final JsonFactory _jsonFactory

Factory used for constructing JsonGenerators

_valueType

protected final JavaType _valueType

Declared type of value to instantiate during deserialization. Defines which deserializer to use; as well as base type of instance to construct if an updatable value is not configured to be used (subject to changes by embedded type information, for polymorphic types). If _valueToUpdate is non-null, only used for locating deserializer.

_valueToUpdate

protected final Object _valueToUpdate

Instance to update with data binding; if any. If null, a new instance is created, if non-null, properties of this value object will be updated instead. Note that value can be of almost any type, except not ArrayType; array types can not be modified because array size is immutable.

_schema

protected final FormatSchema _schema

When using data format that uses a schema, schema is passed to parser.

Since:: 1.8

_injectableValues

protected final InjectableValues _injectableValues

Values that can be injected during deserialization, if any.

Since:: 1.9

Constructor Detail

ObjectReader

protected ObjectReader(ObjectMapper mapper,
                       DeserializationConfig config)

Constructor used by ObjectMapper for initial instantiation

Since:: 1.8

ObjectReader

protected ObjectReader(ObjectMapper mapper,
                       DeserializationConfig config,
                       JavaType valueType,
                       Object valueToUpdate,
                       FormatSchema schema,
                       InjectableValues injectableValues)

ObjectReader

protected ObjectReader(ObjectReader base,
                       DeserializationConfig config,
                       JavaType valueType,
                       Object valueToUpdate,
                       FormatSchema schema,
                       InjectableValues injectableValues)

Copy constructor used for building variations.

Method Detail

version

public Version version()

Method that will return version information stored in and read from jar that contains this class.

Specified by:: version in interface Versioned

Since:: 1.6