Module tools.jackson.core

Package tools.jackson.core.json

Class ByteSourceJsonBootstrapper

java.lang.Object

tools.jackson.core.json.ByteSourceJsonBootstrapper

public final class ByteSourceJsonBootstrapper
extends Object

This class is used to determine the encoding of byte stream that is to contain JSON content. Rules are fairly simple, and defined in JSON specification (RFC-4627 or newer), except for BOM handling, which is a property of underlying streams.

Field Summary

Fields

Modifier and Type	Field	Description
static final byte	UTF8_BOM_1
static final byte	UTF8_BOM_2
static final byte	UTF8_BOM_3

Constructor Summary

Constructors

Constructor	Description
ByteSourceJsonBootstrapper(IOContext ctxt, byte[] inputBuffer, int inputStart, int inputLen)
ByteSourceJsonBootstrapper(IOContext ctxt, InputStream in)

Method Summary

Modifier and Type	Method	Description
JsonParser	constructParser(ObjectReadContext readCtxt, int streamReadFeatures, int formatReadFeatures, ByteQuadsCanonicalizer rootByteSymbols, CharsToNameCanonicalizer rootCharSymbols, int factoryFeatures)
Reader	constructReader()
JsonEncoding	detectEncoding()	Method that should be called after constructing an instace.
protected boolean	ensureLoaded(int minimum)
static int	skipUTF8BOM(DataInput input)	Helper method that may be called to see if given DataInput has BOM marker, and if so, to skip it.

Methods inherited from class java.lang.Object

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

Field Details

UTF8_BOM_1

public static final byte UTF8_BOM_1

See Also:

• Constant Field Values

UTF8_BOM_2

public static final byte UTF8_BOM_2

See Also:

• Constant Field Values

UTF8_BOM_3

public static final byte UTF8_BOM_3

See Also:

• Constant Field Values

Constructor Details

ByteSourceJsonBootstrapper

public ByteSourceJsonBootstrapper(IOContext ctxt,
 InputStream in)

ByteSourceJsonBootstrapper

public ByteSourceJsonBootstrapper(IOContext ctxt,
 byte[] inputBuffer,
 int inputStart,
 int inputLen)

Method Details

detectEncoding

public JsonEncoding detectEncoding()
                            throws JacksonException

Method that should be called after constructing an instace. It will figure out encoding that content uses, to allow for instantiating a proper scanner object.

Returns:

JsonEncoding detected, if any; JsonEncoding.UTF8 otherwise

Throws:

JacksonException - If read from underlying input source fails

skipUTF8BOM

public static int skipUTF8BOM(DataInput input)
                       throws JacksonException

Helper method that may be called to see if given DataInput has BOM marker, and if so, to skip it.

Parameters:

input - DataInput to read content from

Returns:

Byte (as unsigned int) read after possible UTF-8 BOM

Throws:

JacksonException - If read from underlying input source fails

constructReader

public Reader constructReader()
                       throws JacksonException

Throws:

JacksonException

constructParser

public JsonParser constructParser(ObjectReadContext readCtxt,
 int streamReadFeatures,
 int formatReadFeatures,
 ByteQuadsCanonicalizer rootByteSymbols,
 CharsToNameCanonicalizer rootCharSymbols,
 int factoryFeatures)
                           throws JacksonException

Throws:

JacksonException

ensureLoaded

protected boolean ensureLoaded(int minimum)
                        throws JacksonException

Throws:

JacksonException