com.fasterxml.jackson.jr.ob.impl

Class JSONReader

java.lang.Object

com.fasterxml.jackson.jr.ob.impl.JSONReader

public class JSONReader
extends Object

Root-level helper object that handles initial delegation to actual readers (which are ValueReaders), but does not handle any of reading itself (despite name).

Life-cycle is such that initial instance (called blueprint) is constructed first (including possible configuration using mutant factory methods). This blueprint object acts as a factory, and is never used for direct reading; instead, per-call instance is created by calling perOperationInstance(int, com.fasterxml.jackson.core.JsonParser).

Field Summary

Fields

Modifier and Type	Field and Description
protected CollectionBuilder	_collectionBuilder Handler that takes care of constructing Maps as needed
protected int	_features
protected MapBuilder	_mapBuilder Handler that takes care of constructing Maps as needed
protected JsonParser	_parser
protected ValueReaderLocator	_readerLocator Object that is used to find value readers dynamically.
protected TreeCodec	_treeCodec

Constructor Summary

Constructors

Modifier	Constructor and Description
	JSONReader(int features, ValueReaderLocator td, TreeCodec treeCodec, CollectionBuilder lb, MapBuilder mb) Constructor used for creating the blueprint instances.
protected	JSONReader(JSONReader base, int features, ValueReaderLocator td, JsonParser p) Constructor used for per-operation (non-blueprint) instance.

Method Summary

Modifier and Type	Method and Description
protected CollectionBuilder	_collectionBuilder(Class<?> collType)
protected MapBuilder	_mapBuilder(Class<?> mapType)
protected TreeCodec	_treeCodec()
protected JSONReader	_with(int features, ValueReaderLocator td, TreeCodec tc, CollectionBuilder lb, MapBuilder mb) Overridable method that all mutant factories call if a new instance is to be constructed
boolean	arraysAsLists()
JSONReader	perOperationInstance(int features, JsonParser p)
Object[]	readArray() Method for reading a JSON Array from input and building a Object[] out of it.
<T> T[]	readArrayOf(Class<T> type)
<T> T	readBean(Class<T> type) Method for reading a JSON Object from input and building a Bean of specified type out of it; Bean has to conform to standard Java Bean specification by having setters for passing JSON Object properties.
List<Object>	readList() Method for reading a JSON Array from input and building a List out of it.
<T> List<T>	readListOf(Class<T> type) Method for reading a JSON Array from input and building a List out of it, binding values into specified type.
Map<Object,Object>	readMap() Method for reading a JSON Object from input and building a Map out of it.
<T> Map<String,T>	readMapOf(Class<T> type) Method for reading a JSON Object from input and building a Map out of it, binding values into specified type.
Object	readValue() Method for reading a "simple" Object of type indicated by JSON content: Map for JSON Object, Map for JSON Array (or, Object[] if so configured), String for JSON String value and so on.
JSONReader	with(CollectionBuilder lb)
JSONReader	with(MapBuilder mb)
JSONReader	with(ReaderWriterProvider rwp)
JSONReader	withCacheCheck(int features)

Methods inherited from class java.lang.Object

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

Field Detail

_features

protected final int _features

_treeCodec

protected final TreeCodec _treeCodec

_readerLocator

protected final ValueReaderLocator _readerLocator

Object that is used to find value readers dynamically.

_mapBuilder

protected final MapBuilder _mapBuilder

Handler that takes care of constructing Maps as needed

_collectionBuilder

protected final CollectionBuilder _collectionBuilder

Handler that takes care of constructing Maps as needed

_parser

protected final JsonParser _parser

Constructor Detail

JSONReader

public JSONReader(int features,
                  ValueReaderLocator td,
                  TreeCodec treeCodec,
                  CollectionBuilder lb,
                  MapBuilder mb)

Constructor used for creating the blueprint instances.

JSONReader

protected JSONReader(JSONReader base,
                     int features,
                     ValueReaderLocator td,
                     JsonParser p)

Constructor used for per-operation (non-blueprint) instance.

Method Detail

withCacheCheck

public JSONReader withCacheCheck(int features)

with

public JSONReader with(MapBuilder mb)

with

public JSONReader with(CollectionBuilder lb)

with

public JSONReader with(ReaderWriterProvider rwp)

_with

protected JSONReader _with(int features,
                           ValueReaderLocator td,
                           TreeCodec tc,
                           CollectionBuilder lb,
                           MapBuilder mb)

Overridable method that all mutant factories call if a new instance is to be constructed

perOperationInstance

public JSONReader perOperationInstance(int features,
                                       JsonParser p)

arraysAsLists

public boolean arraysAsLists()

Since:

2.8

readValue

public Object readValue()
                 throws IOException

Method for reading a "simple" Object of type indicated by JSON content: Map for JSON Object, Map for JSON Array (or, Object[] if so configured), String for JSON String value and so on.

Throws:

IOException

readMap

public Map<Object,Object> readMap()
                           throws IOException

Method for reading a JSON Object from input and building a Map out of it. Note that if input does NOT contain a JSON Object, JSONObjectException will be thrown.

Throws:

IOException

readList

public List<Object> readList()
                      throws IOException

Method for reading a JSON Array from input and building a List out of it. Note that if input does NOT contain a JSON Array, JSONObjectException will be thrown.

Throws:

IOException

readArray

public Object[] readArray()
                   throws IOException

Method for reading a JSON Array from input and building a Object[] out of it. Note that if input does NOT contain a JSON Array, JSONObjectException will be thrown.

Throws:

IOException

readBean

public <T> T readBean(Class<T> type)
               throws IOException

Method for reading a JSON Object from input and building a Bean of specified type out of it; Bean has to conform to standard Java Bean specification by having setters for passing JSON Object properties.

Throws:

IOException

readArrayOf

public <T> T[] readArrayOf(Class<T> type)
                    throws IOException

Throws:

IOException

readListOf

public <T> List<T> readListOf(Class<T> type)
                       throws IOException

Method for reading a JSON Array from input and building a List out of it, binding values into specified type. Note that if input does NOT contain a JSON Array, JSONObjectException will be thrown.

Throws:

IOException

readMapOf

public <T> Map<String,T> readMapOf(Class<T> type)
                            throws IOException

Method for reading a JSON Object from input and building a Map out of it, binding values into specified type. Note that if input does NOT contain a JSON Object, JSONObjectException will be thrown.

Throws:

IOException

Since:

2.10

_treeCodec

protected TreeCodec _treeCodec()
                        throws JSONObjectException

Throws:

JSONObjectException

_mapBuilder

protected MapBuilder _mapBuilder(Class<?> mapType)

_collectionBuilder

protected CollectionBuilder _collectionBuilder(Class<?> collType)