com.fasterxml.jackson.jr.ob.api

Class MapBuilder

java.lang.Object

com.fasterxml.jackson.jr.ob.api.MapBuilder

Direct Known Subclasses:

MapBuilder.Default

public abstract class MapBuilder
extends Object

Helper class that is used for constructing Maps to map JSON Object values in.

Objects server both as "factories" for creating new builders (blueprint style), and as actual builders. For each distinct read operation, newBuilder(int) will be called at least once; this instance may be used and reused multiple times, as calling start() will reset the state so that more Lists may be built.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MapBuilder.Default Default MapBuilder implementation which builds either HashMap or LinkedHashMap instances (depending on JSON.Feature.PRESERVE_FIELD_ORDERING).

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	_checkDups
protected int	_features
protected Class<?>	_mapType Optional Map implementation class, used when specific implementation is desired.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	MapBuilder(int features, Class<?> type)

Method Summary

Modifier and Type	Method and Description
abstract Map<String,Object>	build()
static MapBuilder	defaultImpl() Factory method for getting a blueprint instance of the default MapBuilder implementation.
Map<String,Object>	emptyMap() Specialized method that is called when an empty list needs to be constructed; this may be a new list, or an immutable shared List, depending on implementation.
boolean	isEnabled(JSON.Feature f)
MapBuilder	newBuilder()
abstract MapBuilder	newBuilder(Class<?> mapImpl)
abstract MapBuilder	newBuilder(int features)
abstract MapBuilder	put(String key, Object value)
Map<String,Object>	singletonMap(String key, Object value) Specialized method that is called when an empty list needs to be constructed; this may be a new list, or an immutable shared List, depending on implementation.
abstract MapBuilder	start()

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

_checkDups

protected final boolean _checkDups

_mapType

protected final Class<?> _mapType

Optional Map implementation class, used when specific implementation is desired.

Constructor Detail

MapBuilder

protected MapBuilder(int features,
                     Class<?> type)

Method Detail

defaultImpl

public static MapBuilder defaultImpl()

Factory method for getting a blueprint instance of the default MapBuilder implementation.

newBuilder

public abstract MapBuilder newBuilder(int features)

newBuilder

public abstract MapBuilder newBuilder(Class<?> mapImpl)

newBuilder

public MapBuilder newBuilder()

isEnabled

public final boolean isEnabled(JSON.Feature f)

start

public abstract MapBuilder start()

put

public abstract MapBuilder put(String key,
                               Object value)

build

public abstract Map<String,Object> build()

emptyMap

public Map<String,Object> emptyMap()
                            throws JSONObjectException

Specialized method that is called when an empty list needs to be constructed; this may be a new list, or an immutable shared List, depending on implementation.

Default implementation simply calls:

  start().build();

which assumes that a builder has been constructed with newBuilder(int)

Throws:

JSONObjectException

singletonMap

public Map<String,Object> singletonMap(String key,
                                       Object value)
                                throws JSONObjectException

Specialized method that is called when an empty list needs to be constructed; this may be a new list, or an immutable shared List, depending on implementation.

Default implementation simply calls:

  start().put(key, value).build();

Throws:

JSONObjectException