JSONReader (jackson-jr-objects 2.18.1 API)

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.jr.ob.impl.ValueReaderLocator, com.fasterxml.jackson.core.TreeCodec, com.fasterxml.jackson.core.JsonParser).

Field Summary

Fields
Modifier and Type	Field and Description
`protected CollectionBuilder`	`_collectionBuilder` Handler that takes care of constructing `Map`s as needed
`protected int`	`_features`
`protected MapBuilder`	`_mapBuilder` Handler that takes care of constructing `Map`s as needed
`protected JsonParser`	`_parser` Parser used by this reader instance.
`protected ValueReaderLocator`	`_readerLocator` Object that is used to find value readers dynamically.
`protected Object[]`	`_setterBuffer` Minor performance optimization: `Object[1]` reused to avoid Reflection having to allocate it for every "setter" call.
`protected TreeCodec`	`_treeCodec` Configured `TreeCodec` that is needed if values of type `TreeNode` are to be read.

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected CollectionBuilder`	`_collectionBuilder(Class<?> collType)`
`protected MapBuilder`	`_mapBuilder(Class<?> mapType)`
`protected JSONReader`	`_with(CollectionBuilder lb, MapBuilder mb)` Overridable method that all mutant factories call if a new instance is to be constructed
`boolean`	`arraysAsLists()`
`int`	`features()`
`boolean`	`isEnabled(JSON.Feature f)`
`JSONReader`	`perOperationInstance(int features, ValueReaderLocator loc, TreeCodec tc, 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<String,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`.
`TreeNode`	`readTree()`
`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`	`withCacheCheck(int features)`

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

- Field Detail
  - _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
  - _features
```
protected final int _features
```
  - _treeCodec
```
protected final TreeCodec _treeCodec
```
    Configured TreeCodec that is needed if values of type TreeNode are to be read.
  - _readerLocator
```
protected final ValueReaderLocator _readerLocator
```
    Object that is used to find value readers dynamically.
  - _parser
```
protected final JsonParser _parser
```
    Parser used by this reader instance.
  - _setterBuffer
```
protected final Object[] _setterBuffer
```
    Minor performance optimization: Object[1] reused to avoid Reflection having to allocate it for every "setter" call.
    
    Since:
    
    2.13
- Constructor Detail
  - JSONReader
```
public JSONReader(CollectionBuilder lb,
                  MapBuilder mb)
```
    Constructor used for creating the blueprint instances.
  - JSONReader
```
protected JSONReader(JSONReader base,
                     int features,
                     ValueReaderLocator loc,
                     TreeCodec tc,
                     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
```
protected JSONReader _with(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,
                                       ValueReaderLocator loc,
                                       TreeCodec tc,
                                       JsonParser p)
```
  - arraysAsLists
```
public boolean arraysAsLists()
```
    Since:
    
    2.8
  - isEnabled
```
public boolean isEnabled(JSON.Feature f)
```
    Since:
    
    2.11
  - features
```
public int features()
```
    Since:
    
    2.13
  - 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<String,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
  - readTree
```
public TreeNode readTree()
                  throws IOException
```
    Throws:
    
    IOException
    
    Since:
    
    2.11
  - _mapBuilder
```
protected MapBuilder _mapBuilder(Class<?> mapType)
```
  - _collectionBuilder
```
protected CollectionBuilder _collectionBuilder(Class<?> collType)
```

Class JSONReader

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

_mapBuilder

_collectionBuilder

_features

_treeCodec

_readerLocator

_parser

_setterBuffer

Constructor Detail

JSONReader

JSONReader

Method Detail

withCacheCheck

with

with

_with

perOperationInstance

arraysAsLists

isEnabled

features

readValue

readMap

readList

readArray

readBean

readArrayOf

readListOf

readMapOf

readTree

_mapBuilder

_collectionBuilder