com.fasterxml.jackson.core.base

Class ParserMinimalBase

java.lang.Object

com.fasterxml.jackson.core.JsonParser

com.fasterxml.jackson.core.base.ParserMinimalBase

All Implemented Interfaces:

Versioned, Closeable, AutoCloseable

Direct Known Subclasses:

ParserBase

public abstract class ParserMinimalBase
extends JsonParser

Intermediate base class used by all Jackson JsonParser implementations, but does not add any additional fields that depend on particular method of obtaining input.

Note that 'minimal' here mostly refers to minimal number of fields (size) and functionality that is specific to certain types of parser implementations; but not necessarily to number of methods.

Author:

Tatu Saloranta

Nested Class Summary

Nested classes/interfaces inherited from class com.fasterxml.jackson.core.JsonParser

JsonParser.Feature, JsonParser.NumberType

Field Summary

Fields

Modifier and Type	Field and Description
protected JsonToken	_currToken Last token retrieved via nextToken(), if any.
protected JsonToken	_lastClearedToken Last cleared token, if any: that is, value that was in effect when clearCurrentToken() was called.
protected static int	INT_APOSTROPHE
protected static int	INT_ASTERISK
protected static int	INT_b
protected static int	INT_BACKSLASH
protected static int	INT_COLON
protected static int	INT_COMMA
protected static int	INT_CR
protected static int	INT_f
protected static int	INT_LBRACKET
protected static int	INT_LCURLY
protected static int	INT_LF
protected static int	INT_n
protected static int	INT_QUOTE
protected static int	INT_r
protected static int	INT_RBRACKET
protected static int	INT_RCURLY
protected static int	INT_SLASH
protected static int	INT_SPACE
protected static int	INT_t
protected static int	INT_TAB
protected static int	INT_u

Fields inherited from class com.fasterxml.jackson.core.JsonParser

_features

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ParserMinimalBase()
protected	ParserMinimalBase(int features)

Method Summary

Methods

Modifier and Type	Method and Description
protected JsonParseException	_constructError(String msg, Throwable t)
protected void	_decodeBase64(String str, ByteArrayBuilder builder, Base64Variant b64variant) Helper method that can be used for base64 decoding in cases where encoded content has already been read as a String.
protected static String	_getCharDesc(int ch)
protected abstract void	_handleEOF() Method sub-classes need to implement
protected char	_handleUnrecognizedCharacterEscape(char ch)
protected void	_reportBase64EOF()
protected void	_reportError(String msg)
protected void	_reportInvalidBase64(Base64Variant b64variant, char ch, int bindex, String msg)
protected void	_reportInvalidEOF()
protected void	_reportInvalidEOF(String msg)
protected void	_reportInvalidEOFInValue()
protected void	_reportUnexpectedChar(int ch, String comment)
protected void	_throwInternal()
protected void	_throwInvalidSpace(int i)
protected void	_throwUnquotedSpace(int i, String ctxtDesc) Method called to report a problem with unquoted control character.
protected void	_wrapError(String msg, Throwable t)
void	clearCurrentToken() Method called to "consume" the current token by effectively removing it so that JsonParser.hasCurrentToken() returns false, and JsonParser.getCurrentToken() null).
abstract void	close() Closes the parser so that no further iteration or data access can be made; will also close the underlying input source if parser either owns the input source, or feature JsonParser.Feature.AUTO_CLOSE_SOURCE is enabled.
abstract byte[]	getBinaryValue(Base64Variant b64variant) Method that can be used to read (and consume -- results may not be accessible using other methods after the call) base64-encoded binary data included in the current textual JSON value.
abstract String	getCurrentName() Method that can be called to get the name associated with the current token: for JsonToken.FIELD_NAMEs it will be the same as what JsonParser.getText() returns; for field values it will be preceding field name; and for others (array values, root-level values) null.
JsonToken	getCurrentToken() Accessor to find which token parser currently points to, if any; null will be returned if none.
JsonToken	getLastClearedToken() Method that can be called to get the last token that was cleared using JsonParser.clearCurrentToken().
abstract JsonStreamContext	getParsingContext() Method that can be used to access current parsing context reader is in.
abstract String	getText() Method for accessing textual representation of the current token; if no current token (before first call to JsonParser.nextToken(), or after encountering end-of-input), returns null.
abstract char[]	getTextCharacters() Method similar to JsonParser.getText(), but that will return underlying (unmodifiable) character array that contains textual value, instead of constructing a String object to contain this information.
abstract int	getTextLength() Accessor used with JsonParser.getTextCharacters(), to know length of String stored in returned buffer.
abstract int	getTextOffset() Accessor used with JsonParser.getTextCharacters(), to know offset of the first text content character within buffer.
boolean	getValueAsBoolean(boolean defaultValue) Method that will try to convert value of current token to a boolean.
double	getValueAsDouble(double defaultValue) Method that will try to convert value of current token to a Java double.
int	getValueAsInt(int defaultValue) Method that will try to convert value of current token to a int.
long	getValueAsLong(long defaultValue) Method that will try to convert value of current token to a long.
String	getValueAsString(String defaultValue) Method that will try to convert value of current token to a String.
boolean	hasCurrentToken() Method for checking whether parser currently points to a token (and data for that token is available).
abstract boolean	hasTextCharacters() Method that can be used to determine whether calling of JsonParser.getTextCharacters() would be the most efficient way to access textual content for the event parser currently points to.
abstract boolean	isClosed() Method that can be called to determine whether this parser is closed or not.
abstract JsonToken	nextToken() Main iteration method, which will advance stream enough to determine type of the next token, if any.
JsonToken	nextValue() Iteration method that will advance stream enough to determine type of the next token that is a value type (including JSON Array and Object start/end markers).
abstract void	overrideCurrentName(String name) Method that can be used to change what is considered to be the current (field) name.
JsonParser	skipChildren() Method that will skip all child tokens of an array or object token that the parser currently points to, iff stream points to JsonToken.START_OBJECT or JsonToken.START_ARRAY.
Version	version() Accessor for getting version of the core package, given a parser instance.

Methods inherited from class com.fasterxml.jackson.core.JsonParser

_constructError, _reportUnsupportedOperation, canUseSchema, configure, disable, enable, getBigIntegerValue, getBinaryValue, getBooleanValue, getByteValue, getCodec, getCurrentLocation, getDecimalValue, getDoubleValue, getEmbeddedObject, getFloatValue, getInputSource, getIntValue, getLongValue, getNumberType, getNumberValue, getSchema, getShortValue, getTokenLocation, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsLong, getValueAsString, isEnabled, isExpectedStartArrayToken, nextBooleanValue, nextFieldName, nextIntValue, nextLongValue, nextTextValue, readBinaryValue, readBinaryValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, releaseBuffered, requiresCustomCodec, setCodec, setSchema

Methods inherited from class java.lang.Object

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

Field Detail

INT_TAB

protected static final int INT_TAB

See Also:

Constant Field Values

INT_LF

protected static final int INT_LF

See Also:

Constant Field Values

INT_CR

protected static final int INT_CR

See Also:

Constant Field Values

INT_SPACE

protected static final int INT_SPACE

See Also:

Constant Field Values

INT_LBRACKET

protected static final int INT_LBRACKET

See Also:

Constant Field Values

INT_RBRACKET

protected static final int INT_RBRACKET

See Also:

Constant Field Values

INT_LCURLY

protected static final int INT_LCURLY

See Also:

Constant Field Values

INT_RCURLY

protected static final int INT_RCURLY

See Also:

Constant Field Values

INT_QUOTE

protected static final int INT_QUOTE

See Also:

Constant Field Values

INT_BACKSLASH

protected static final int INT_BACKSLASH

See Also:

Constant Field Values

INT_SLASH

protected static final int INT_SLASH

See Also:

Constant Field Values

INT_COLON

protected static final int INT_COLON

See Also:

Constant Field Values

INT_COMMA

protected static final int INT_COMMA

See Also:

Constant Field Values

INT_ASTERISK

protected static final int INT_ASTERISK

See Also:

Constant Field Values

INT_APOSTROPHE

protected static final int INT_APOSTROPHE

See Also:

Constant Field Values

INT_b

protected static final int INT_b

See Also:

Constant Field Values

INT_f

protected static final int INT_f

See Also:

Constant Field Values

INT_n

protected static final int INT_n

See Also:

Constant Field Values

INT_r

protected static final int INT_r

See Also:

Constant Field Values

INT_t

protected static final int INT_t

See Also:

Constant Field Values

INT_u

protected static final int INT_u

See Also:

Constant Field Values

_currToken

protected JsonToken _currToken

Last token retrieved via nextToken(), if any. Null before the first call to nextToken(), as well as if token has been explicitly cleared (by call to clearCurrentToken())

_lastClearedToken

protected JsonToken _lastClearedToken

Last cleared token, if any: that is, value that was in effect when clearCurrentToken() was called.

Constructor Detail

ParserMinimalBase

protected ParserMinimalBase()

ParserMinimalBase

protected ParserMinimalBase(int features)

Method Detail

version

public Version version()

Description copied from class: JsonParser

Accessor for getting version of the core package, given a parser instance. Left for sub-classes to implement.

Specified by:

version in interface Versioned

Specified by:

version in class JsonParser

nextToken

public abstract JsonToken nextToken()
                             throws IOException,
                                    JsonParseException

Description copied from class: JsonParser

Main iteration method, which will advance stream enough to determine type of the next token, if any. If none remaining (stream has no content other than possible white space before ending), null will be returned.

Specified by:

nextToken in class JsonParser

Returns:

Next token from the stream, if any found, or null to indicate end-of-input

Throws:

IOException

JsonParseException

getCurrentToken

public JsonToken getCurrentToken()

Description copied from class: JsonParser

Accessor to find which token parser currently points to, if any; null will be returned if none. If return value is non-null, data associated with the token is available via other accessor methods.

Specified by:

getCurrentToken in class JsonParser

Returns:

Type of the token this parser currently points to, if any: null before any tokens have been read, and after end-of-input has been encountered, as well as if the current token has been explicitly cleared.

hasCurrentToken

public boolean hasCurrentToken()

Description copied from class: JsonParser

Method for checking whether parser currently points to a token (and data for that token is available). Equivalent to check for parser.getCurrentToken() != null.

Specified by:

hasCurrentToken in class JsonParser

Returns:

True if the parser just returned a valid token via JsonParser.nextToken(); false otherwise (parser was just constructed, encountered end-of-input and returned null from JsonParser.nextToken(), or the token has been consumed)

nextValue

public JsonToken nextValue()
                    throws IOException,
                           JsonParseException

Description copied from class: JsonParser

Iteration method that will advance stream enough to determine type of the next token that is a value type (including JSON Array and Object start/end markers). Or put another way, nextToken() will be called once, and if JsonToken.FIELD_NAME is returned, another time to get the value for the field. Method is most useful for iterating over value entries of JSON objects; field name will still be available by calling JsonParser.getCurrentName() when parser points to the value.

Specified by:

nextValue in class JsonParser

Returns:

Next non-field-name token from the stream, if any found, or null to indicate end-of-input (or, for non-blocking parsers, JsonToken.NOT_AVAILABLE if no tokens were available yet)

Throws:

IOException

JsonParseException

skipChildren

public JsonParser skipChildren()
                        throws IOException,
                               JsonParseException

Description copied from class: JsonParser

Method that will skip all child tokens of an array or object token that the parser currently points to, iff stream points to JsonToken.START_OBJECT or JsonToken.START_ARRAY. If not, it will do nothing. After skipping, stream will point to matching JsonToken.END_OBJECT or JsonToken.END_ARRAY (possibly skipping nested pairs of START/END OBJECT/ARRAY tokens as well as value tokens). The idea is that after calling this method, application will call JsonParser.nextToken() to point to the next available token, if any.

Specified by:

skipChildren in class JsonParser

Throws:

IOException

JsonParseException

_handleEOF

protected abstract void _handleEOF()
                            throws JsonParseException

Method sub-classes need to implement

Throws:

JsonParseException

getCurrentName

public abstract String getCurrentName()
                               throws IOException,
                                      JsonParseException

Description copied from class: JsonParser

Method that can be called to get the name associated with the current token: for JsonToken.FIELD_NAMEs it will be the same as what JsonParser.getText() returns; for field values it will be preceding field name; and for others (array values, root-level values) null.

Specified by:

getCurrentName in class JsonParser

Throws:

IOException

JsonParseException

close

public abstract void close()
                    throws IOException

Description copied from class: JsonParser

Closes the parser so that no further iteration or data access can be made; will also close the underlying input source if parser either owns the input source, or feature JsonParser.Feature.AUTO_CLOSE_SOURCE is enabled. Whether parser owns the input source depends on factory method that was used to construct instance (so check JsonFactory for details, but the general idea is that if caller passes in closable resource (such as InputStream or Reader) parser does NOT own the source; but if it passes a reference (such as File or URL and creates stream or reader it does own them.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Specified by:

close in class JsonParser

Throws:

IOException

isClosed

public abstract boolean isClosed()

Description copied from class: JsonParser

Method that can be called to determine whether this parser is closed or not. If it is closed, no new tokens can be retrieved by calling JsonParser.nextToken() (and the underlying stream may be closed). Closing may be due to an explicit call to JsonParser.close() or because parser has encountered end of input.

Specified by:

isClosed in class JsonParser

getParsingContext

public abstract JsonStreamContext getParsingContext()

Description copied from class: JsonParser

Method that can be used to access current parsing context reader is in. There are 3 different types: root, array and object contexts, with slightly different available information. Contexts are hierarchically nested, and can be used for example for figuring out part of the input document that correspond to specific array or object (for highlighting purposes, or error reporting). Contexts can also be used for simple xpath-like matching of input, if so desired.

Specified by:

getParsingContext in class JsonParser

clearCurrentToken

public void clearCurrentToken()

Description copied from class: JsonParser

Method called to "consume" the current token by effectively removing it so that JsonParser.hasCurrentToken() returns false, and JsonParser.getCurrentToken() null). Cleared token value can still be accessed by calling JsonParser.getLastClearedToken() (if absolutely needed), but usually isn't.

Method was added to be used by the optional data binder, since it has to be able to consume last token used for binding (so that it will not be used again).

Specified by:

clearCurrentToken in class JsonParser

getLastClearedToken

public JsonToken getLastClearedToken()

Description copied from class: JsonParser

Method that can be called to get the last token that was cleared using JsonParser.clearCurrentToken(). This is not necessarily the latest token read. Will return null if no tokens have been cleared, or if parser has been closed.

Specified by:

getLastClearedToken in class JsonParser

overrideCurrentName

public abstract void overrideCurrentName(String name)

Description copied from class: JsonParser

Method that can be used to change what is considered to be the current (field) name. May be needed to support non-JSON data formats or unusual binding conventions; not needed for typical processing.

Note that use of this method should only be done as sort of last resort, as it is a work-around for regular operation.

Specified by:

overrideCurrentName in class JsonParser

Parameters:

name - Name to use as the current name; may be null.

getText

public abstract String getText()
                        throws IOException,
                               JsonParseException

Description copied from class: JsonParser

Method for accessing textual representation of the current token; if no current token (before first call to JsonParser.nextToken(), or after encountering end-of-input), returns null. Method can be called for any token type.

Specified by:

getText in class JsonParser

Throws:

IOException

JsonParseException

getTextCharacters

public abstract char[] getTextCharacters()
                                  throws IOException,
                                         JsonParseException

Description copied from class: JsonParser

Method similar to JsonParser.getText(), but that will return underlying (unmodifiable) character array that contains textual value, instead of constructing a String object to contain this information. Note, however, that:

• Textual contents are not guaranteed to start at index 0 (rather, call JsonParser.getTextOffset()) to know the actual offset
• Length of textual contents may be less than the length of returned buffer: call JsonParser.getTextLength() for actual length of returned content.

Note that caller MUST NOT modify the returned character array in any way -- doing so may corrupt current parser state and render parser instance useless.

The only reason to call this method (over JsonParser.getText()) is to avoid construction of a String object (which will make a copy of contents).

Specified by:

getTextCharacters in class JsonParser

Throws:

IOException

JsonParseException

hasTextCharacters

public abstract boolean hasTextCharacters()

Description copied from class: JsonParser

Method that can be used to determine whether calling of JsonParser.getTextCharacters() would be the most efficient way to access textual content for the event parser currently points to.

Default implementation simply returns false since only actual implementation class has knowledge of its internal buffering state. Implementations are strongly encouraged to properly override this method, to allow efficient copying of content by other code.

Specified by:

hasTextCharacters in class JsonParser

Returns:

True if parser currently has character array that can be efficiently returned via JsonParser.getTextCharacters(); false means that it may or may not exist

getTextLength

public abstract int getTextLength()
                           throws IOException,
                                  JsonParseException

Description copied from class: JsonParser

Accessor used with JsonParser.getTextCharacters(), to know length of String stored in returned buffer.

Specified by:

getTextLength in class JsonParser

Returns:

Number of characters within buffer returned by JsonParser.getTextCharacters() that are part of textual content of the current token.

Throws:

IOException

JsonParseException

getTextOffset

public abstract int getTextOffset()
                           throws IOException,
                                  JsonParseException

Description copied from class: JsonParser

Accessor used with JsonParser.getTextCharacters(), to know offset of the first text content character within buffer.

Specified by:

getTextOffset in class JsonParser

Returns:

Offset of the first character within buffer returned by JsonParser.getTextCharacters() that is part of textual content of the current token.

Throws:

IOException

JsonParseException

getBinaryValue

public abstract byte[] getBinaryValue(Base64Variant b64variant)
                               throws IOException,
                                      JsonParseException

Description copied from class: JsonParser

Method that can be used to read (and consume -- results may not be accessible using other methods after the call) base64-encoded binary data included in the current textual JSON value. It works similar to getting String value via JsonParser.getText() and decoding result (except for decoding part), but should be significantly more performant.

Note that non-decoded textual contents of the current token are not guaranteed to be accessible after this method is called. Current implementation, for example, clears up textual content during decoding. Decoded binary content, however, will be retained until parser is advanced to the next event.

Specified by:

getBinaryValue in class JsonParser

Parameters:

b64variant - Expected variant of base64 encoded content (see Base64Variants for definitions of "standard" variants).

Returns:

Decoded binary data

Throws:

IOException

JsonParseException

getValueAsBoolean

public boolean getValueAsBoolean(boolean defaultValue)
                          throws IOException,
                                 JsonParseException

Description copied from class: JsonParser

Method that will try to convert value of current token to a boolean. JSON booleans map naturally; integer numbers other than 0 map to true, and 0 maps to false and Strings 'true' and 'false' map to corresponding values.

If representation can not be converted to a boolean value (including structured types like Objects and Arrays), specified defaultValue will be returned; no exceptions are thrown.

Overrides:

getValueAsBoolean in class JsonParser

Throws:

IOException

JsonParseException

getValueAsInt

public int getValueAsInt(int defaultValue)
                  throws IOException,
                         JsonParseException

Description copied from class: JsonParser

Method that will try to convert value of current token to a int. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.

If representation can not be converted to an int (including structured type markers like start/end Object/Array) specified defaultValue will be returned; no exceptions are thrown.

Overrides:

getValueAsInt in class JsonParser

Throws:

IOException

JsonParseException

getValueAsLong

public long getValueAsLong(long defaultValue)
                    throws IOException,
                           JsonParseException

Description copied from class: JsonParser

Method that will try to convert value of current token to a long. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.

If representation can not be converted to an int (including structured type markers like start/end Object/Array) specified defaultValue will be returned; no exceptions are thrown.

Overrides:

getValueAsLong in class JsonParser

Throws:

IOException

JsonParseException

getValueAsDouble

public double getValueAsDouble(double defaultValue)
                        throws IOException,
                               JsonParseException

Description copied from class: JsonParser

Method that will try to convert value of current token to a Java double. Numbers are coerced using default Java rules; booleans convert to 0.0 (false) and 1.0 (true), and Strings are parsed using default Java language integer parsing rules.

If representation can not be converted to an int (including structured types like Objects and Arrays), specified defaultValue will be returned; no exceptions are thrown.

Overrides:

getValueAsDouble in class JsonParser

Throws:

IOException

JsonParseException

getValueAsString

public String getValueAsString(String defaultValue)
                        throws IOException,
                               JsonParseException

Description copied from class: JsonParser

Method that will try to convert value of current token to a String. JSON Strings map naturally; scalar values get converted to their textual representation. If representation can not be converted to a String value (including structured types like Objects and Arrays and null token), specified default value will be returned; no exceptions are thrown.

Specified by:

getValueAsString in class JsonParser

Throws:

IOException

JsonParseException

_decodeBase64

protected void _decodeBase64(String str,
                 ByteArrayBuilder builder,
                 Base64Variant b64variant)
                      throws IOException,
                             JsonParseException

Helper method that can be used for base64 decoding in cases where encoded content has already been read as a String.

Throws:

IOException

JsonParseException

_reportInvalidBase64

protected void _reportInvalidBase64(Base64Variant b64variant,
                        char ch,
                        int bindex,
                        String msg)
                             throws JsonParseException

Parameters:

bindex - Relative index within base64 character unit; between 0 and 3 (as unit has exactly 4 characters)

Throws:

JsonParseException

_reportBase64EOF

protected void _reportBase64EOF()
                         throws JsonParseException

Throws:

JsonParseException

_reportUnexpectedChar

protected void _reportUnexpectedChar(int ch,
                         String comment)
                              throws JsonParseException

Throws:

JsonParseException

_reportInvalidEOF

protected void _reportInvalidEOF()
                          throws JsonParseException

Throws:

JsonParseException

_reportInvalidEOF

protected void _reportInvalidEOF(String msg)
                          throws JsonParseException

Throws:

JsonParseException

_reportInvalidEOFInValue

protected void _reportInvalidEOFInValue()
                                 throws JsonParseException

Throws:

JsonParseException

_throwInvalidSpace

protected void _throwInvalidSpace(int i)
                           throws JsonParseException

Throws:

JsonParseException

_throwUnquotedSpace

protected void _throwUnquotedSpace(int i,
                       String ctxtDesc)
                            throws JsonParseException

Method called to report a problem with unquoted control character. Note: starting with version 1.4, it is possible to suppress exception by enabling JsonParser.Feature.ALLOW_UNQUOTED_CONTROL_CHARS.

Throws:

JsonParseException

_handleUnrecognizedCharacterEscape

protected char _handleUnrecognizedCharacterEscape(char ch)
                                           throws JsonProcessingException

Throws:

JsonProcessingException

_getCharDesc

protected static final String _getCharDesc(int ch)

_reportError

protected final void _reportError(String msg)
                           throws JsonParseException

Throws:

JsonParseException

_wrapError

protected final void _wrapError(String msg,
              Throwable t)
                         throws JsonParseException

Throws:

JsonParseException

_throwInternal

protected final void _throwInternal()

_constructError

protected final JsonParseException _constructError(String msg,
                                 Throwable t)