com.fasterxml.jackson.jr.ob

Class JSON

java.lang.Object

com.fasterxml.jackson.jr.ob.JSON

All Implemented Interfaces:

Versioned

public class JSON
extends Object
implements Versioned

Main entry point for functionality.

Note that instances are fully immutable, and thereby thread-safe.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JSON.Feature Simple on/off (enabled/disabled) features for JSON; used for simple configuration aspects.

Field Summary

Fields

Modifier and Type	Field and Description
protected int	_features
protected JsonFactory	_jsonFactory Underlying JSON factory used for creating Streaming parsers and generators.
protected PrettyPrinter	_prettyPrinter
protected JSONReader	_reader Blueprint instance of the reader to use for reading JSON as simple Objects.
protected TreeCodec	_treeCodec Optional handler for TreeNode values: if defined, we can read and write TreeNode instances that codec supports.
protected JSONWriter	_writer Blueprint isntance of the writer to use for writing JSON given simple Objects.
static JSON	std Singleton instance with standard, default configuration.

Constructor Summary

Constructors

Modifier	Constructor and Description
	JSON()
protected	JSON(int features, JsonFactory jsonF, TreeCodec trees)
protected	JSON(int features, JsonFactory jsonF, TreeCodec trees, JSONReader r, JSONWriter w, PrettyPrinter pp)

Method Summary

Methods

Modifier and Type	Method and Description
protected void	_close(Closeable cl)
protected void	_close(Closeable cl, Exception e)
protected <T> T	_closeWithError(Closeable cl, Exception e)
protected JsonGenerator	_config(JsonGenerator g)
protected JsonParser	_config(JsonParser p)
protected JSONReader	_defaultReader(int features, TreeCodec tc, TypeDetector td)
protected TypeDetector	_defaultTypeDetector(int features)
protected JSONWriter	_defaultWriter(int features, TreeCodec tc, TypeDetector td)
protected JsonParser	_initForReading(JsonParser p)
protected void	_noTreeCodec(String msg)
protected JsonParser	_parser(Object source)
protected JSONReader	_readerForOperation(JsonParser p)
protected JSON	_with(int features) Internal mutant factory method used for constructing
protected JSON	_with(int features, JsonFactory jsonF, TreeCodec trees, JSONReader reader, JSONWriter writer, PrettyPrinter pp)
protected void	_writeAndClose(Object value, JsonGenerator g)
protected JSONWriter	_writerForOperation(JsonGenerator gen)
Object	anyFrom(Object source) Read method that will take given JSON Source (of one of supported types), read contents and map it to one of simple mappings (Map for JSON Objects, List for JSON Arrays, String for JSON Strings, null for JSON null, Boolean for JSON booleans and Number for JSON numbers.
Object[]	arrayFrom(Object source)
<T> T[]	arrayOfFrom(Class<T> type, Object source)
byte[]	asBytes(Object value)
ObjectCodec	asCodec() Convenience method for constructing an adapter that uses this instance as a ObjectCodec
String	asString(Object value)
<T> T	beanFrom(Class<T> type, Object source)
JSONComposer<byte[]>	composeBytes()
<C extends Collection<Object>> CollectionComposer<?,C>	composeCollection(C collection)
CollectionComposer<?,List<Object>>	composeList()
MapComposer<?>	composeMap()
MapComposer<?>	composeMap(Map<String,Object> map)
JSONComposer<String>	composeString()
JSONComposer<OutputStream>	composeTo(File f)
JSONComposer<OutputStream>	composeTo(OutputStream out)
JSONComposer<OutputStream>	composeTo(Writer w)
JSONComposer<OutputStream>	composeUsing(JsonGenerator gen)
<T extends TreeNode> T	createArrayNode() Convenience method, equivalent to:
<T extends TreeNode> T	createObjectNode() Convenience method, equivalent to:
JsonFactory	getStreamingFactory()
TreeCodec	getTreeCodec()
boolean	isEnabled(JSON.Feature f)
List<Object>	listFrom(Object source)
<T> List<T>	listOfFrom(Class<T> type, Object source)
<T> Map<T,Object>	mapFrom(Object source)
<T extends TreeNode> TreeNode	treeFrom(Object source) Method for reading content as a JSON Tree (of type that configured TreeCodec, see with(TreeCodec)) supports.
Version	version()
JSON	with(CollectionBuilder b) Mutant factory for constructing an instance with specified CollectionBuilder, and returning new instance (or, if there would be no change, this instance).
JSON	with(JSON.Feature... features) Mutant factory for constructing an instance with specified features enabled.
JSON	with(JSON.Feature feature, boolean state) Mutant factory for constructing an instance with specified feature enabled or disabled (depending on state), and returning an instance with that setting; this may either be this instance (if feature already had specified state), or a newly constructed instance.
JSON	with(JsonFactory f)
JSON	with(JSONReader r) Mutant factory for constructing an instance with specified JSONReader, and returning new instance (or, if there would be no change, this instance).
JSON	with(JSONWriter w) Mutant factory for constructing an instance with specified JSONWriter, and returning new instance (or, if there would be no change, this instance).
JSON	with(MapBuilder b) Mutant factory for constructing an instance with specified MapBuilder, and returning new instance (or, if there would be no change, this instance).
JSON	with(PrettyPrinter pp) Mutant factory for constructing an instance with specified PrettyPrinter, and returning new instance (or, if there would be no change, this instance).
JSON	with(TreeCodec c) Mutant factory for constructing an instance with specified TreeCodec, and returning new instance (or, if there would be no change, this instance).
JSON	without(JSON.Feature... features) Mutant factory for constructing an instance with specified features disabled.
void	write(Object value, File f)
void	write(Object value, JsonGenerator gen)
void	write(Object value, OutputStream out)
void	write(Object value, Writer w)

Methods inherited from class java.lang.Object

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

Field Detail

std

public static final JSON std

Singleton instance with standard, default configuration. May be used with direct references like:

   String json = JSON.std.asString(map);

_jsonFactory

protected final JsonFactory _jsonFactory

Underlying JSON factory used for creating Streaming parsers and generators.

_treeCodec

protected final TreeCodec _treeCodec

Optional handler for TreeNode values: if defined, we can read and write TreeNode instances that codec supports.

_reader

protected final JSONReader _reader

Blueprint instance of the reader to use for reading JSON as simple Objects.

_writer

protected final JSONWriter _writer

Blueprint isntance of the writer to use for writing JSON given simple Objects.

_features

protected final int _features

_prettyPrinter

protected final PrettyPrinter _prettyPrinter

Constructor Detail

JSON

public JSON()

JSON

protected JSON(int features,
    JsonFactory jsonF,
    TreeCodec trees)

JSON

protected JSON(int features,
    JsonFactory jsonF,
    TreeCodec trees,
    JSONReader r,
    JSONWriter w,
    PrettyPrinter pp)

Method Detail

_defaultTypeDetector

protected TypeDetector _defaultTypeDetector(int features)

_defaultReader

protected JSONReader _defaultReader(int features,
                        TreeCodec tc,
                        TypeDetector td)

_defaultWriter

protected JSONWriter _defaultWriter(int features,
                        TreeCodec tc,
                        TypeDetector td)

asCodec

public ObjectCodec asCodec()

Convenience method for constructing an adapter that uses this instance as a ObjectCodec

version

public Version version()

Specified by:

version in interface Versioned

with

public JSON with(JsonFactory f)

with

public JSON with(TreeCodec c)

Mutant factory for constructing an instance with specified TreeCodec, and returning new instance (or, if there would be no change, this instance).

with

public JSON with(JSONReader r)

Mutant factory for constructing an instance with specified JSONReader, and returning new instance (or, if there would be no change, this instance).

with

public JSON with(JSONWriter w)

Mutant factory for constructing an instance with specified JSONWriter, and returning new instance (or, if there would be no change, this instance).

with

public JSON with(PrettyPrinter pp)

Mutant factory for constructing an instance with specified PrettyPrinter, and returning new instance (or, if there would be no change, this instance).

with

public JSON with(MapBuilder b)

Mutant factory for constructing an instance with specified MapBuilder, and returning new instance (or, if there would be no change, this instance).

with

public JSON with(CollectionBuilder b)

Mutant factory for constructing an instance with specified CollectionBuilder, and returning new instance (or, if there would be no change, this instance).

with

public JSON with(JSON.Feature feature,
        boolean state)

Mutant factory for constructing an instance with specified feature enabled or disabled (depending on state), and returning an instance with that setting; this may either be this instance (if feature already had specified state), or a newly constructed instance.

with

public JSON with(JSON.Feature... features)

Mutant factory for constructing an instance with specified features enabled.

without

public JSON without(JSON.Feature... features)

Mutant factory for constructing an instance with specified features disabled.

_with

protected final JSON _with(int features)

Internal mutant factory method used for constructing

_with

protected final JSON _with(int features,
         JsonFactory jsonF,
         TreeCodec trees,
         JSONReader reader,
         JSONWriter writer,
         PrettyPrinter pp)

getTreeCodec

public TreeCodec getTreeCodec()

getStreamingFactory

public JsonFactory getStreamingFactory()

isEnabled

public final boolean isEnabled(JSON.Feature f)

asString

public String asString(Object value)
                throws IOException,
                       JSONObjectException

Throws:

IOException

JSONObjectException

asBytes

public byte[] asBytes(Object value)
               throws IOException,
                      JSONObjectException

Throws:

IOException

JSONObjectException

write

public void write(Object value,
         JsonGenerator gen)
           throws IOException,
                  JSONObjectException

Throws:

IOException

JSONObjectException

write

public void write(Object value,
         OutputStream out)
           throws IOException,
                  JSONObjectException

Throws:

IOException

JSONObjectException

write

public void write(Object value,
         Writer w)
           throws IOException,
                  JSONObjectException

Throws:

IOException

JSONObjectException

write

public void write(Object value,
         File f)
           throws IOException,
                  JSONObjectException

Throws:

IOException

JSONObjectException

composeUsing

public JSONComposer<OutputStream> composeUsing(JsonGenerator gen)
                                        throws IOException,
                                               JSONObjectException

Throws:

IOException

JSONObjectException

composeTo

public JSONComposer<OutputStream> composeTo(OutputStream out)
                                     throws IOException,
                                            JSONObjectException

Throws:

IOException

JSONObjectException

composeTo

public JSONComposer<OutputStream> composeTo(Writer w)
                                     throws IOException,
                                            JSONObjectException

Throws:

IOException

JSONObjectException

composeTo

public JSONComposer<OutputStream> composeTo(File f)
                                     throws IOException,
                                            JSONObjectException

Throws:

IOException

JSONObjectException

composeString

public JSONComposer<String> composeString()
                                   throws IOException,
                                          JSONObjectException

Throws:

IOException

JSONObjectException

composeBytes

public JSONComposer<byte[]> composeBytes()
                                  throws IOException,
                                         JSONObjectException

Throws:

IOException

JSONObjectException

composeList

public CollectionComposer<?,List<Object>> composeList()

composeCollection

public <C extends Collection<Object>> CollectionComposer<?,C> composeCollection(C collection)

composeMap

public MapComposer<?> composeMap()

composeMap

public MapComposer<?> composeMap(Map<String,Object> map)

listFrom

public List<Object> listFrom(Object source)
                      throws IOException,
                             JSONObjectException

Throws:

IOException

JSONObjectException

listOfFrom

public <T> List<T> listOfFrom(Class<T> type,
                     Object source)
                   throws IOException,
                          JSONObjectException

Throws:

IOException

JSONObjectException

arrayFrom

public Object[] arrayFrom(Object source)
                   throws IOException,
                          JSONObjectException

Throws:

IOException

JSONObjectException

arrayOfFrom

public <T> T[] arrayOfFrom(Class<T> type,
                  Object source)
                throws IOException,
                       JSONObjectException

Throws:

IOException

JSONObjectException

mapFrom

public <T> Map<T,Object> mapFrom(Object source)
                      throws IOException,
                             JSONObjectException

Throws:

IOException

JSONObjectException

beanFrom

public <T> T beanFrom(Class<T> type,
             Object source)
           throws IOException,
                  JSONObjectException

Throws:

IOException

JSONObjectException

anyFrom

public Object anyFrom(Object source)
               throws IOException

Read method that will take given JSON Source (of one of supported types), read contents and map it to one of simple mappings (Map for JSON Objects, List for JSON Arrays, String for JSON Strings, null for JSON null, Boolean for JSON booleans and Number for JSON numbers.

Supported source types include:

• InputStream
• Reader
• File
• URL
• String
• byte[]
• char[]

Throws:

IOException

treeFrom

public <T extends TreeNode> TreeNode treeFrom(Object source)
                  throws IOException,
                         JSONObjectException

Method for reading content as a JSON Tree (of type that configured TreeCodec, see with(TreeCodec)) supports.

Throws:

IOException

JSONObjectException

Since:

2.8

createArrayNode

public <T extends TreeNode> T createArrayNode()

Convenience method, equivalent to:

   getTreeCodec().createArrayNode();

Note that for call to succeed a TreeCodec must have been configured with this instance using with(TreeCodec) method.

Since:

2.8

createObjectNode

public <T extends TreeNode> T createObjectNode()

Convenience method, equivalent to:

   getTreeCodec().createObjectNode();

Note that for call to succeed a TreeCodec must have been configured with this instance using with(TreeCodec) method.

Since:

2.8

_writeAndClose

protected final void _writeAndClose(Object value,
                  JsonGenerator g)
                             throws IOException

Throws:

IOException

_writerForOperation

protected JSONWriter _writerForOperation(JsonGenerator gen)

_readerForOperation

protected JSONReader _readerForOperation(JsonParser p)

_parser

protected JsonParser _parser(Object source)
                      throws IOException,
                             JSONObjectException

Throws:

IOException

JSONObjectException

_initForReading

protected JsonParser _initForReading(JsonParser p)
                              throws IOException

Throws:

IOException

_config

protected JsonGenerator _config(JsonGenerator g)

_config

protected JsonParser _config(JsonParser p)

_close

protected void _close(Closeable cl)

_close

protected void _close(Closeable cl,
          Exception e)
               throws IOException

Throws:

IOException

_closeWithError

protected <T> T _closeWithError(Closeable cl,
                    Exception e)
                     throws IOException

Throws:

IOException

Since:

2.8.2

_noTreeCodec

protected void _noTreeCodec(String msg)