Jackson 3.0.1 · tools.jackson.dataformat.javaprop.JavaPropsParser

Modifier and Type	Field and Description
protected byte[]	_binaryValue
protected ByteArrayBuilder	_byteArrayBuilder
protected final Object	_inputSource Although most massaging is done later, caller may be interested in the ultimate source.
protected JavaPropsSchema	_schema Schema we use for parsing Properties into structure of some kind.
protected final Map<?, ?>	_sourceContent Actual `java.util.Properties` (or, actually, any `java.util.Map` with String keys, values) that were parsed and handed to us for further processing.
protected JPropReadContext	_streamReadContext
protected static final JavaPropsSchema	DEFAULT_SCHEMA
protected static final JacksonFeatureSet<StreamReadCapability>	STREAM_READ_CAPABILITIES Properties capabilities slightly different from defaults, having untyped (text-only) scalars.

Access	Constructor and Description
public	JavaPropsParser(ObjectReadContext readCtxt, IOContext ioCtxt, int parserFeatures, JavaPropsSchema schema, Object inputSource, Map<?, ?> sourceMap)

Method Summary

Modifier and Type	Method and Description
protected void	_closeInput() Implements abstract tools.jackson.core.base.ParserMinimalBase._closeInput. Abstract method for sub-classes to implement; to be called by `close()` implementation here.
public ByteArrayBuilder	_getByteArrayBuilder()
protected void	_handleEOF() Implements abstract tools.jackson.core.base.ParserMinimalBase._handleEOF. Method sub-classes need to implement to check whether end-of-content is allowed at the current decoding position: formats often want to verify the all start/end token pairs match, for example.
protected <T> T	_noNumbers()
protected void	_releaseBuffers() Implements abstract tools.jackson.core.base.ParserMinimalBase._releaseBuffers. Method called to release internal buffers owned by the base reader.
public void	assignCurrentValue(Object v) Implements abstract tools.jackson.core.JsonParser.assignCurrentValue. Helper method, usually equivalent to: `getParsingContext().assignCurrentValue(v);`
public boolean	canReadObjectId() Overrides tools.jackson.core.JsonParser.canReadObjectId. Introspection method that may be called to see if the underlying data format supports some kind of Object Ids natively (many do not; for example, JSON doesn't).
public boolean	canReadTypeId() Overrides tools.jackson.core.JsonParser.canReadTypeId. Introspection method that may be called to see if the underlying data format supports some kind of Type Ids natively (many do not; for example, JSON doesn't).
public TokenStreamLocation	currentLocation() Implements abstract tools.jackson.core.JsonParser.currentLocation. Method that returns location of the last processed character; usually for error reporting purposes.
public String	currentName() Implements abstract tools.jackson.core.JsonParser.currentName. Method that can be called to get the name associated with the current token: for `JsonToken#PROPERTY_NAME`s it will be the same as what `getString()` returns; for Object property values it will be the preceding property name; and for others (array element, root-level values) null.
public TokenStreamLocation	currentTokenLocation() Implements abstract tools.jackson.core.JsonParser.currentTokenLocation. Method that return the starting location of the current token; that is, position of the first character from input that starts the current token.
public Object	currentValue() Implements abstract tools.jackson.core.JsonParser.currentValue. Helper method, usually equivalent to: `getParsingContext().currentValue();` Note that "current value" is NOT populated (or used) by Streaming parser; it is only used by higher-level data-binding functionality.
public BigInteger	getBigIntegerValue() Implements abstract tools.jackson.core.JsonParser.getBigIntegerValue. Numeric accessor that can be called when the current token is of type `JsonToken#VALUE_NUMBER_INT` and it cannot be used as a Java long primitive type due to its magnitude.
public byte[]	getBinaryValue(Base64Variant variant) Implements abstract tools.jackson.core.JsonParser.getBinaryValue. 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.
public BigDecimal	getDecimalValue() Implements abstract tools.jackson.core.JsonParser.getDecimalValue. Numeric accessor that can be called when the current token is of type `JsonToken#VALUE_NUMBER_FLOAT` or `JsonToken#VALUE_NUMBER_INT`.
public double	getDoubleValue() Implements abstract tools.jackson.core.JsonParser.getDoubleValue. Numeric accessor that can be called when the current token is of type `JsonToken#VALUE_NUMBER_FLOAT` and it can be expressed as a Java double primitive type.
public Object	getEmbeddedObject() Overrides tools.jackson.core.base.ParserMinimalBase.getEmbeddedObject. Accessor that can be called if (and only if) the current token is `JsonToken#VALUE_EMBEDDED_OBJECT`.
public float	getFloatValue() Implements abstract tools.jackson.core.JsonParser.getFloatValue. Numeric accessor that can be called when the current token is of type `JsonToken#VALUE_NUMBER_FLOAT` and it can be expressed as a Java float primitive type.
public int	getIntValue() Implements abstract tools.jackson.core.JsonParser.getIntValue. Numeric accessor that can be called when the current token is of type `JsonToken#VALUE_NUMBER_INT` and it can be expressed as a value of Java int primitive type.
public long	getLongValue() Implements abstract tools.jackson.core.JsonParser.getLongValue. Numeric accessor that can be called when the current token is of type `JsonToken#VALUE_NUMBER_INT` and it can be expressed as a Java long primitive type.
public JsonParser.NumberType	getNumberType() Implements abstract tools.jackson.core.JsonParser.getNumberType. If current token is of type `JsonToken#VALUE_NUMBER_INT` or `JsonToken#VALUE_NUMBER_FLOAT`, returns one of `NumberType` constants; otherwise returns null.
public Number	getNumberValue() Implements abstract tools.jackson.core.JsonParser.getNumberValue. Generic number value accessor method that will work for all kinds of numeric values.
public JavaPropsSchema	getSchema() Overrides tools.jackson.core.JsonParser.getSchema. Method for accessing Schema that this parser uses, if any.
public String	getString() Implements abstract tools.jackson.core.JsonParser.getString. Method for accessing textual representation of the current token; if no current token (before first call to `nextToken`, or after encountering end-of-input), returns null.
public int	getString(Writer writer) Overrides tools.jackson.core.base.ParserMinimalBase.getString. Method to read the textual representation of the current token in chunks and pass it to the given Writer.
public char[]	getStringCharacters() Implements abstract tools.jackson.core.JsonParser.getStringCharacters. Method similar to `getString()`, but that will return underlying (unmodifiable) character array that contains textual value, instead of constructing a String object to contain this information.
public int	getStringLength() Implements abstract tools.jackson.core.JsonParser.getStringLength. Accessor used with `getStringCharacters`, to know length of String stored in returned buffer.
public int	getStringOffset() Implements abstract tools.jackson.core.JsonParser.getStringOffset. Accessor used with `getStringCharacters`, to know offset of the first text content character within buffer.
public boolean	hasStringCharacters() Implements abstract tools.jackson.core.JsonParser.hasStringCharacters. Method that can be used to determine whether calling of `getStringCharacters` would be the most efficient way to access String value for the event parser currently points to (compared to `getString()`).
public boolean	isNaN() Implements abstract tools.jackson.core.JsonParser.isNaN. Accessor for checking whether current token is a special "not-a-number" (NaN) token (including both "NaN" AND positive/negative infinity!).
public JsonToken	nextToken() Implements abstract tools.jackson.core.JsonParser.nextToken. Main iteration method, which will advance stream enough to determine type of the next token, if any.
public JacksonFeatureSet<StreamReadCapability>	streamReadCapabilities() Overrides tools.jackson.core.base.ParserMinimalBase.streamReadCapabilities. Accessor for getting metadata on capabilities of this parser, based on underlying data format being read (directly or indirectly).
public TokenStreamContext	streamReadContext() Implements abstract tools.jackson.core.JsonParser.streamReadContext. 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.
public Object	streamReadInputSource() Implements abstract tools.jackson.core.JsonParser.streamReadInputSource. Method that can be used to get access to object that is used to access input being parsed; this is usually either `InputStream` or `Reader`, depending on what parser was constructed with.
public Version	version() Implements abstract tools.jackson.core.JsonParser.version. Implements tools.jackson.core.Versioned.version. Accessor for getting version of the core package, given a parser instance.

Inherited from tools.jackson.core.base.ParserMinimalBase:: _constructInputCoercion _constructNotNumericType _currentLocationMinusOne _decodeBase64 _getCharDesc _hasTextualNull _longIntegerDesc _longNumberDesc _nullSafeUpdateToken _reportBadInputStream _reportBadReader _reportError _reportError _reportError _reportError _reportInvalidEOF _reportInvalidEOF _reportInvalidEOFInValue _reportInvalidNumber _reportInvalidSpace _reportMissingRootWS _reportOverflowByte _reportOverflowInt _reportOverflowInt _reportOverflowInt _reportOverflowLong _reportOverflowLong _reportOverflowLong _reportOverflowShort _reportUnexpectedChar _reportUnexpectedNumberChar _throwInternal _updateToken _updateTokenToNA _updateTokenToNull _wrapIOFailure clearCurrentToken close currentNameMatch currentToken currentTokenCount currentTokenId finishToken getBooleanValue getByteValue getLastClearedToken getNumberTypeFP getNumberValueDeferred getNumberValueExact getShortValue getValueAsBoolean getValueAsDouble getValueAsInt getValueAsInt getValueAsLong getValueAsLong getValueAsString getValueAsString hasCurrentToken hasToken hasTokenId isClosed isEnabled isExpectedNumberIntToken isExpectedStartArrayToken isExpectedStartObjectToken nextName nextName nextNameMatch nextValue objectReadContext readValueAs readValueAs readValueAs readValueAsTree skipChildren streamReadConstraints streamReadFeatures

_binaryValue	back to summary
protected byte[] _binaryValue

_byteArrayBuilder	back to summary
protected ByteArrayBuilder _byteArrayBuilder

_inputSource	back to summary
protected final Object _inputSource Although most massaging is done later, caller may be interested in the ultimate source.

_schema	back to summary
protected JavaPropsSchema _schema Schema we use for parsing Properties into structure of some kind.

_sourceContent	back to summary
protected final Map<?, ?> _sourceContent Actual `java.util.Properties` (or, actually, any `java.util.Map` with String keys, values) that were parsed and handed to us for further processing.

_streamReadContext	back to summary
protected JPropReadContext _streamReadContext

DEFAULT_SCHEMA	back to summary
protected static final JavaPropsSchema DEFAULT_SCHEMA

STREAM_READ_CAPABILITIES	back to summary
protected static final JacksonFeatureSet<StreamReadCapability> STREAM_READ_CAPABILITIES Properties capabilities slightly different from defaults, having untyped (text-only) scalars.

JavaPropsParser	back to summary
public JavaPropsParser(ObjectReadContext readCtxt, IOContext ioCtxt, int parserFeatures, JavaPropsSchema schema, Object inputSource, Map<?, ?> sourceMap)

Method Detail

_closeInput back to summary

_closeInput	back to summary
protected void _closeInput() throws IOException Implements abstract tools.jackson.core.base.ParserMinimalBase._closeInput. Doc from tools.jackson.core.base.ParserMinimalBase._closeInput. Abstract method for sub-classes to implement; to be called by `close()` implementation here. Annotations @Override Exceptions IOException: from underlying input source if thrown

protected void _closeInput() throws IOException

Implements abstract tools.jackson.core.base.ParserMinimalBase._closeInput.

Doc from tools.jackson.core.base.ParserMinimalBase._closeInput.

Abstract method for sub-classes to implement; to be called by close() implementation here.

Annotations

@Override

Exceptions

IOException:: from underlying input source if thrown

_getByteArrayBuilder	back to summary
public ByteArrayBuilder _getByteArrayBuilder()

_handleEOF	back to summary
protected void _handleEOF() throws StreamReadException Implements abstract tools.jackson.core.base.ParserMinimalBase._handleEOF. Doc from tools.jackson.core.base.ParserMinimalBase._handleEOF. Method sub-classes need to implement to check whether end-of-content is allowed at the current decoding position: formats often want to verify the all start/end token pairs match, for example. Annotations @Override

_handleEOF

back to summary

protected void _handleEOF() throws StreamReadException

Implements abstract tools.jackson.core.base.ParserMinimalBase._handleEOF.

Doc from tools.jackson.core.base.ParserMinimalBase._handleEOF.

Method sub-classes need to implement to check whether end-of-content is allowed at the current decoding position: formats often want to verify the all start/end token pairs match, for example.

Annotations

@Override

_noNumbers	back to summary
protected <T> T _noNumbers() throws StreamReadException

_releaseBuffers back to summary

_releaseBuffers	back to summary
protected void _releaseBuffers() Implements abstract tools.jackson.core.base.ParserMinimalBase._releaseBuffers. Doc from tools.jackson.core.base.ParserMinimalBase._releaseBuffers. Method called to release internal buffers owned by the base reader. This is expected to be called after `_closeInput` since the buffers are expected not to be needed any longer. Annotations @Override

protected void _releaseBuffers()

Implements abstract tools.jackson.core.base.ParserMinimalBase._releaseBuffers.

Doc from tools.jackson.core.base.ParserMinimalBase._releaseBuffers.

Method called to release internal buffers owned by the base reader. This is expected to be called after _closeInput since the buffers are expected not to be needed any longer.

Annotations

@Override

assignCurrentValue back to summary

assignCurrentValue	back to summary
public void assignCurrentValue(Object v) Implements abstract tools.jackson.core.JsonParser.assignCurrentValue. Doc from tools.jackson.core.JsonParser.assignCurrentValue. Helper method, usually equivalent to: `getParsingContext().assignCurrentValue(v);` Annotations @Override

public void assignCurrentValue(Object v)

Implements abstract tools.jackson.core.JsonParser.assignCurrentValue.

Doc from tools.jackson.core.JsonParser.assignCurrentValue.

Helper method, usually equivalent to: getParsingContext().assignCurrentValue(v);

Annotations

@Override

canReadObjectId	back to summary
public boolean canReadObjectId() Overrides tools.jackson.core.JsonParser.canReadObjectId. Doc from tools.jackson.core.JsonParser.canReadObjectId. Introspection method that may be called to see if the underlying data format supports some kind of Object Ids natively (many do not; for example, JSON doesn't). Default implementation returns true; overridden by data formats that do support native Object Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it cannot use native object ids. Annotations @Override

canReadObjectId

back to summary

public boolean canReadObjectId()

Overrides tools.jackson.core.JsonParser.canReadObjectId.

Doc from tools.jackson.core.JsonParser.canReadObjectId.

Introspection method that may be called to see if the underlying data format supports some kind of Object Ids natively (many do not; for example, JSON doesn't).

Default implementation returns true; overridden by data formats that do support native Object Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it cannot use native object ids.

Annotations

@Override

canReadTypeId	back to summary
public boolean canReadTypeId() Overrides tools.jackson.core.JsonParser.canReadTypeId. Doc from tools.jackson.core.JsonParser.canReadTypeId. Introspection method that may be called to see if the underlying data format supports some kind of Type Ids natively (many do not; for example, JSON doesn't). Default implementation returns true; overridden by data formats that do support native Type Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it cannot use native type ids. Annotations @Override

canReadTypeId

back to summary

public boolean canReadTypeId()

Overrides tools.jackson.core.JsonParser.canReadTypeId.

Doc from tools.jackson.core.JsonParser.canReadTypeId.

Introspection method that may be called to see if the underlying data format supports some kind of Type Ids natively (many do not; for example, JSON doesn't).

Default implementation returns true; overridden by data formats that do support native Type Ids. Caller is expected to either use a non-native notation (explicit property or such), or fail, in case it cannot use native type ids.

Annotations

@Override

currentLocation back to summary

currentLocation	back to summary
public TokenStreamLocation currentLocation() Implements abstract tools.jackson.core.JsonParser.currentLocation. Doc from tools.jackson.core.JsonParser.currentLocation. Method that returns location of the last processed character; usually for error reporting purposes. Note that the location is not guaranteed to be accurate (although most implementation will try their best): some implementations may only report specific boundary locations (start or end locations of tokens) and others only return `TokenStreamLocation#NA` due to not having access to input location information (when delegating actual decoding work to other library). Annotations @Override

public TokenStreamLocation currentLocation()

Implements abstract tools.jackson.core.JsonParser.currentLocation.

Doc from tools.jackson.core.JsonParser.currentLocation.

Method that returns location of the last processed character; usually for error reporting purposes.

Note that the location is not guaranteed to be accurate (although most implementation will try their best): some implementations may only report specific boundary locations (start or end locations of tokens) and others only return TokenStreamLocation#NA due to not having access to input location information (when delegating actual decoding work to other library).

Annotations

@Override

currentName back to summary

currentName	back to summary
public String currentName() Implements abstract tools.jackson.core.JsonParser.currentName. Doc from tools.jackson.core.JsonParser.currentName. Method that can be called to get the name associated with the current token: for `JsonToken#PROPERTY_NAME`s it will be the same as what `getString()` returns; for Object property values it will be the preceding property name; and for others (array element, root-level values) null. Annotations @Override

public String currentName()

Implements abstract tools.jackson.core.JsonParser.currentName.

Doc from tools.jackson.core.JsonParser.currentName.

Method that can be called to get the name associated with the current token: for JsonToken#PROPERTY_NAMEs it will be the same as what getString() returns; for Object property values it will be the preceding property name; and for others (array element, root-level values) null.

Annotations

@Override

currentTokenLocation back to summary

currentTokenLocation	back to summary
public TokenStreamLocation currentTokenLocation() Implements abstract tools.jackson.core.JsonParser.currentTokenLocation. Doc from tools.jackson.core.JsonParser.currentTokenLocation. Method that return the starting location of the current token; that is, position of the first character from input that starts the current token. Note that the location is not guaranteed to be accurate (although most implementation will try their best): some implementations may only return `TokenStreamLocation#NA` due to not having access to input location information (when delegating actual decoding work to other library). Annotations @Override

public TokenStreamLocation currentTokenLocation()

Implements abstract tools.jackson.core.JsonParser.currentTokenLocation.

Doc from tools.jackson.core.JsonParser.currentTokenLocation.

Method that return the starting location of the current token; that is, position of the first character from input that starts the current token.

Note that the location is not guaranteed to be accurate (although most implementation will try their best): some implementations may only return TokenStreamLocation#NA due to not having access to input location information (when delegating actual decoding work to other library).

Annotations

@Override

currentValue back to summary

currentValue	back to summary
public Object currentValue() Implements abstract tools.jackson.core.JsonParser.currentValue. Doc from tools.jackson.core.JsonParser.currentValue. Helper method, usually equivalent to: `getParsingContext().currentValue();` Note that "current value" is NOT populated (or used) by Streaming parser; it is only used by higher-level data-binding functionality. The reason it is included here is that it can be stored and accessed hierarchically, and gets passed through data-binding. Annotations @Override

public Object currentValue()

Implements abstract tools.jackson.core.JsonParser.currentValue.

Doc from tools.jackson.core.JsonParser.currentValue.

Helper method, usually equivalent to: getParsingContext().currentValue();

Note that "current value" is NOT populated (or used) by Streaming parser; it is only used by higher-level data-binding functionality. The reason it is included here is that it can be stored and accessed hierarchically, and gets passed through data-binding.

Annotations

@Override

getBigIntegerValue back to summary

getBigIntegerValue	back to summary
public BigInteger getBigIntegerValue() throws JacksonException Implements abstract tools.jackson.core.JsonParser.getBigIntegerValue. Doc from tools.jackson.core.JsonParser.getBigIntegerValue. Numeric accessor that can be called when the current token is of type `JsonToken#VALUE_NUMBER_INT` and it cannot be used as a Java long primitive type due to its magnitude. It can also be called for `JsonToken#VALUE_NUMBER_FLOAT`; if so, it is equivalent to calling `getDecimalValue` and then constructing a `BigInteger` from that value. Annotations @Override

public BigInteger getBigIntegerValue() throws JacksonException

Implements abstract tools.jackson.core.JsonParser.getBigIntegerValue.

Doc from tools.jackson.core.JsonParser.getBigIntegerValue.

Numeric accessor that can be called when the current token is of type JsonToken#VALUE_NUMBER_INT and it cannot be used as a Java long primitive type due to its magnitude. It can also be called for JsonToken#VALUE_NUMBER_FLOAT; if so, it is equivalent to calling getDecimalValue and then constructing a BigInteger from that value.

Annotations

@Override

getBinaryValue back to summary

getBinaryValue	back to summary
public byte[] getBinaryValue(Base64Variant variant) throws JacksonException Implements abstract tools.jackson.core.JsonParser.getBinaryValue. Doc from tools.jackson.core.JsonParser.getBinaryValue. 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 `getString()` 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. Annotations @SuppressWarnings:resource @Override

public byte[] getBinaryValue(Base64Variant variant) throws JacksonException

Implements abstract tools.jackson.core.JsonParser.getBinaryValue.

Doc from tools.jackson.core.JsonParser.getBinaryValue.

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 getString() 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.

Annotations

@SuppressWarnings:resource
@Override

getDecimalValue back to summary

getDecimalValue	back to summary
public BigDecimal getDecimalValue() throws JacksonException Implements abstract tools.jackson.core.JsonParser.getDecimalValue. Doc from tools.jackson.core.JsonParser.getDecimalValue. Numeric accessor that can be called when the current token is of type `JsonToken#VALUE_NUMBER_FLOAT` or `JsonToken#VALUE_NUMBER_INT`. No under/overflow exceptions are ever thrown. Annotations @Override

public BigDecimal getDecimalValue() throws JacksonException

Implements abstract tools.jackson.core.JsonParser.getDecimalValue.

Doc from tools.jackson.core.JsonParser.getDecimalValue.

Numeric accessor that can be called when the current token is of type JsonToken#VALUE_NUMBER_FLOAT or JsonToken#VALUE_NUMBER_INT. No under/overflow exceptions are ever thrown.

Annotations

@Override

getDoubleValue back to summary

getDoubleValue	back to summary
public double getDoubleValue() throws JacksonException Implements abstract tools.jackson.core.JsonParser.getDoubleValue. Doc from tools.jackson.core.JsonParser.getDoubleValue. Numeric accessor that can be called when the current token is of type `JsonToken#VALUE_NUMBER_FLOAT` and it can be expressed as a Java double primitive type. It can also be called for `JsonToken#VALUE_NUMBER_INT`; if so, it is equivalent to calling `getLongValue` and then casting; except for possible overflow/underflow exception. Note if the value falls outside of range of Java double, a `InputCoercionException` will be thrown to indicate numeric overflow/underflow. Annotations @Override

public double getDoubleValue() throws JacksonException

Implements abstract tools.jackson.core.JsonParser.getDoubleValue.

Doc from tools.jackson.core.JsonParser.getDoubleValue.

Numeric accessor that can be called when the current token is of type JsonToken#VALUE_NUMBER_FLOAT and it can be expressed as a Java double primitive type. It can also be called for JsonToken#VALUE_NUMBER_INT; if so, it is equivalent to calling getLongValue and then casting; except for possible overflow/underflow exception.

Note

if the value falls outside of range of Java double, a InputCoercionException will be thrown to indicate numeric overflow/underflow.

Annotations

@Override

getEmbeddedObject back to summary

getEmbeddedObject	back to summary
public Object getEmbeddedObject() throws JacksonException Overrides tools.jackson.core.base.ParserMinimalBase.getEmbeddedObject. Doc from tools.jackson.core.JsonParser.getEmbeddedObject. Accessor that can be called if (and only if) the current token is `JsonToken#VALUE_EMBEDDED_OBJECT`. For other token types, null is returned. Note only some specialized parser implementations support embedding of objects (usually ones that are facades on top of non-streaming sources, such as object trees). One exception is access to binary content (whether via base64 encoding or not) which typically is accessible using this method, as well as `getBinaryValue()`. Annotations @Override

public Object getEmbeddedObject() throws JacksonException

Overrides tools.jackson.core.base.ParserMinimalBase.getEmbeddedObject.

Doc from tools.jackson.core.JsonParser.getEmbeddedObject.

Accessor that can be called if (and only if) the current token is JsonToken#VALUE_EMBEDDED_OBJECT. For other token types, null is returned.

Note

only some specialized parser implementations support embedding of objects (usually ones that are facades on top of non-streaming sources, such as object trees). One exception is access to binary content (whether via base64 encoding or not) which typically is accessible using this method, as well as getBinaryValue().

Annotations

@Override

getFloatValue back to summary

getFloatValue	back to summary
public float getFloatValue() throws JacksonException Implements abstract tools.jackson.core.JsonParser.getFloatValue. Doc from tools.jackson.core.JsonParser.getFloatValue. Numeric accessor that can be called when the current token is of type `JsonToken#VALUE_NUMBER_FLOAT` and it can be expressed as a Java float primitive type. It can also be called for `JsonToken#VALUE_NUMBER_INT`; if so, it is equivalent to calling `getLongValue` and then casting; except for possible overflow/underflow exception. Note if the value falls outside of range of Java float, a `InputCoercionException` will be thrown to indicate numeric overflow/underflow. Annotations @Override

public float getFloatValue() throws JacksonException

Implements abstract tools.jackson.core.JsonParser.getFloatValue.

Doc from tools.jackson.core.JsonParser.getFloatValue.

Numeric accessor that can be called when the current token is of type JsonToken#VALUE_NUMBER_FLOAT and it can be expressed as a Java float primitive type. It can also be called for JsonToken#VALUE_NUMBER_INT; if so, it is equivalent to calling getLongValue and then casting; except for possible overflow/underflow exception.

Note

if the value falls outside of range of Java float, a InputCoercionException will be thrown to indicate numeric overflow/underflow.

Annotations

@Override

getIntValue back to summary

getIntValue	back to summary
public int getIntValue() throws JacksonException Implements abstract tools.jackson.core.JsonParser.getIntValue. Doc from tools.jackson.core.JsonParser.getIntValue. Numeric accessor that can be called when the current token is of type `JsonToken#VALUE_NUMBER_INT` and it can be expressed as a value of Java int primitive type. It can also be called for `JsonToken#VALUE_NUMBER_FLOAT`; if so, it is equivalent to calling `getDoubleValue` and then casting; except for possible overflow/underflow exception. Note if the resulting integer value falls outside range of Java `int`, a `InputCoercionException` may be thrown to indicate numeric overflow/underflow. Annotations @Override

public int getIntValue() throws JacksonException

Implements abstract tools.jackson.core.JsonParser.getIntValue.

Doc from tools.jackson.core.JsonParser.getIntValue.

Numeric accessor that can be called when the current token is of type JsonToken#VALUE_NUMBER_INT and it can be expressed as a value of Java int primitive type. It can also be called for JsonToken#VALUE_NUMBER_FLOAT; if so, it is equivalent to calling getDoubleValue and then casting; except for possible overflow/underflow exception.

Note

if the resulting integer value falls outside range of Java int, a InputCoercionException may be thrown to indicate numeric overflow/underflow.

Annotations

@Override

getLongValue back to summary

getLongValue	back to summary
public long getLongValue() throws JacksonException Implements abstract tools.jackson.core.JsonParser.getLongValue. Doc from tools.jackson.core.JsonParser.getLongValue. Numeric accessor that can be called when the current token is of type `JsonToken#VALUE_NUMBER_INT` and it can be expressed as a Java long primitive type. It can also be called for `JsonToken#VALUE_NUMBER_FLOAT`; if so, it is equivalent to calling `getDoubleValue` and then casting to `int`; except for possible overflow/underflow exception. Note if the token is an integer, but its value falls outside of range of Java long, a `InputCoercionException` may be thrown to indicate numeric overflow/underflow. Annotations @Override

public long getLongValue() throws JacksonException

Implements abstract tools.jackson.core.JsonParser.getLongValue.

Doc from tools.jackson.core.JsonParser.getLongValue.

Numeric accessor that can be called when the current token is of type JsonToken#VALUE_NUMBER_INT and it can be expressed as a Java long primitive type. It can also be called for JsonToken#VALUE_NUMBER_FLOAT; if so, it is equivalent to calling getDoubleValue and then casting to int; except for possible overflow/underflow exception.

Note

if the token is an integer, but its value falls outside of range of Java long, a InputCoercionException may be thrown to indicate numeric overflow/underflow.

Annotations

@Override

getNumberType back to summary

getNumberType	back to summary
public JsonParser.NumberType getNumberType() throws JacksonException Implements abstract tools.jackson.core.JsonParser.getNumberType. Doc from tools.jackson.core.JsonParser.getNumberType. If current token is of type `JsonToken#VALUE_NUMBER_INT` or `JsonToken#VALUE_NUMBER_FLOAT`, returns one of `NumberType` constants; otherwise returns null. Note in Jackson 2.x, an exception was wrong if called for non-numeric token. Annotations @Override

public JsonParser.NumberType getNumberType() throws JacksonException

Implements abstract tools.jackson.core.JsonParser.getNumberType.

Doc from tools.jackson.core.JsonParser.getNumberType.

If current token is of type JsonToken#VALUE_NUMBER_INT or JsonToken#VALUE_NUMBER_FLOAT, returns one of NumberType constants; otherwise returns null.

Note

in Jackson 2.x, an exception was wrong if called for non-numeric token.

Annotations

@Override

getNumberValue	back to summary
public Number getNumberValue() throws JacksonException Implements abstract tools.jackson.core.JsonParser.getNumberValue. Doc from tools.jackson.core.JsonParser.getNumberValue. Generic number value accessor method that will work for all kinds of numeric values. It will return the optimal (simplest/smallest possible) wrapper object that can express the numeric value just parsed. Annotations @Override

getNumberValue

back to summary

public Number getNumberValue() throws JacksonException

Implements abstract tools.jackson.core.JsonParser.getNumberValue.

Doc from tools.jackson.core.JsonParser.getNumberValue.

Generic number value accessor method that will work for all kinds of numeric values. It will return the optimal (simplest/smallest possible) wrapper object that can express the numeric value just parsed.

Annotations

@Override

getSchema	back to summary
public JavaPropsSchema getSchema() Overrides tools.jackson.core.JsonParser.getSchema. Doc from tools.jackson.core.JsonParser.getSchema. Method for accessing Schema that this parser uses, if any. Default implementation returns null. Annotations @Override

getSchema

back to summary

public JavaPropsSchema getSchema()

Overrides tools.jackson.core.JsonParser.getSchema.

Doc from tools.jackson.core.JsonParser.getSchema.

Method for accessing Schema that this parser uses, if any. Default implementation returns null.

Annotations

@Override

getString back to summary

getString	back to summary
public String getString() throws JacksonException Implements abstract tools.jackson.core.JsonParser.getString. Doc from tools.jackson.core.JsonParser.getString. Method for accessing textual representation of the current token; if no current token (before first call to `nextToken`, or after encountering end-of-input), returns null. Method can be called for any token type. Annotations @Override

public String getString() throws JacksonException

Implements abstract tools.jackson.core.JsonParser.getString.

Doc from tools.jackson.core.JsonParser.getString.

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

Annotations

@Override

getString back to summary

getString	back to summary
public int getString(Writer writer) throws JacksonException Overrides tools.jackson.core.base.ParserMinimalBase.getString. Doc from tools.jackson.core.JsonParser.getString. Method to read the textual representation of the current token in chunks and pass it to the given Writer. Functionally same as calling: writer.write(parser.getString()); but should typically be more efficient as longer content does need to be combined into a single `String` to return, and write can occur directly from intermediate buffers Jackson uses. Note String value will still be buffered (usually using `TextBuffer`) and will be accessible with other `getString()` calls (that is, it will not be consumed). So this accessor only avoids construction of `java.lang.String` compared to plain `getString()` method. Note In Jackson 2.x this method was called `getString(Writer)`. Annotations @Override

public int getString(Writer writer) throws JacksonException

Overrides tools.jackson.core.base.ParserMinimalBase.getString.

Doc from tools.jackson.core.JsonParser.getString.

Method to read the textual representation of the current token in chunks and pass it to the given Writer. Functionally same as calling:

  writer.write(parser.getString());

but should typically be more efficient as longer content does need to be combined into a single String to return, and write can occur directly from intermediate buffers Jackson uses.

Note

String value will still be buffered (usually using TextBuffer) and will be accessible with other getString() calls (that is, it will not be consumed). So this accessor only avoids construction of java.lang.String compared to plain getString() method.

Note

In Jackson 2.x this method was called getString(Writer).

Annotations

@Override

getStringCharacters back to summary

getStringCharacters	back to summary
public char[] getStringCharacters() throws JacksonException Implements abstract tools.jackson.core.JsonParser.getStringCharacters. Doc from tools.jackson.core.JsonParser.getStringCharacters. Method similar to `getString()`, 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: String contents are not guaranteed to start at index 0 (rather, call `getStringOffset`) to know the actual offset Length of string contents may be less than the length of returned buffer: call `getStringLength` 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 `getString()`) is to avoid construction of a String object (which will make a copy of contents). Annotations @Override

public char[] getStringCharacters() throws JacksonException

Implements abstract tools.jackson.core.JsonParser.getStringCharacters.

Doc from tools.jackson.core.JsonParser.getStringCharacters.

Method similar to getString(), 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:

String contents are not guaranteed to start at index 0 (rather, call getStringOffset) to know the actual offset
Length of string contents may be less than the length of returned buffer: call getStringLength 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 getString()) is to avoid construction of a String object (which will make a copy of contents).

Annotations

@Override

getStringLength back to summary

getStringLength	back to summary
public int getStringLength() throws JacksonException Implements abstract tools.jackson.core.JsonParser.getStringLength. Doc from tools.jackson.core.JsonParser.getStringLength. Accessor used with `getStringCharacters`, to know length of String stored in returned buffer. Annotations @Override

public int getStringLength() throws JacksonException

Implements abstract tools.jackson.core.JsonParser.getStringLength.

Doc from tools.jackson.core.JsonParser.getStringLength.

Accessor used with getStringCharacters, to know length of String stored in returned buffer.

Annotations

@Override

getStringOffset back to summary

getStringOffset	back to summary
public int getStringOffset() throws JacksonException Implements abstract tools.jackson.core.JsonParser.getStringOffset. Doc from tools.jackson.core.JsonParser.getStringOffset. Accessor used with `getStringCharacters`, to know offset of the first text content character within buffer. Annotations @Override

public int getStringOffset() throws JacksonException

Implements abstract tools.jackson.core.JsonParser.getStringOffset.

Doc from tools.jackson.core.JsonParser.getStringOffset.

Accessor used with getStringCharacters, to know offset of the first text content character within buffer.

Annotations

@Override

hasStringCharacters back to summary

hasStringCharacters	back to summary
public boolean hasStringCharacters() Implements abstract tools.jackson.core.JsonParser.hasStringCharacters. Doc from tools.jackson.core.JsonParser.hasStringCharacters. Method that can be used to determine whether calling of `getStringCharacters` would be the most efficient way to access String value for the event parser currently points to (compared to `getString()`). Annotations @Override

public boolean hasStringCharacters()

Implements abstract tools.jackson.core.JsonParser.hasStringCharacters.

Doc from tools.jackson.core.JsonParser.hasStringCharacters.

Method that can be used to determine whether calling of getStringCharacters would be the most efficient way to access String value for the event parser currently points to (compared to getString()).

Annotations

@Override

isNaN back to summary

isNaN	back to summary
public boolean isNaN() Implements abstract tools.jackson.core.JsonParser.isNaN. Doc from tools.jackson.core.JsonParser.isNaN. Accessor for checking whether current token is a special "not-a-number" (NaN) token (including both "NaN" AND positive/negative infinity!). These values are not supported by all formats: JSON, for example, only supports them if `JsonReadFeature#ALLOW_NON_NUMERIC_NUMBERS` is enabled. Note in case where numeric value is outside range of requested type -- most notably `java.lang.Float` or `java.lang.Double` -- and decoding results effectively in a NaN value, this method DOES NOT return `true`: only explicit incoming markers do. This is because value could still be accessed as a valid `BigDecimal`. Annotations @Override

public boolean isNaN()

Implements abstract tools.jackson.core.JsonParser.isNaN.

Doc from tools.jackson.core.JsonParser.isNaN.

Accessor for checking whether current token is a special "not-a-number" (NaN) token (including both "NaN" AND positive/negative infinity!). These values are not supported by all formats: JSON, for example, only supports them if JsonReadFeature#ALLOW_NON_NUMERIC_NUMBERS is enabled.

Note

in case where numeric value is outside range of requested type -- most notably java.lang.Float or java.lang.Double -- and decoding results effectively in a NaN value, this method DOES NOT return true: only explicit incoming markers do. This is because value could still be accessed as a valid BigDecimal.

Annotations

@Override

nextToken	back to summary
public JsonToken nextToken() throws JacksonException Implements abstract tools.jackson.core.JsonParser.nextToken. Doc from tools.jackson.core.JsonParser.nextToken. 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. Annotations @Override Exceptions JacksonException: for low-level read issues

nextToken

back to summary

public JsonToken nextToken() throws JacksonException

Implements abstract tools.jackson.core.JsonParser.nextToken.

Doc from tools.jackson.core.JsonParser.nextToken.

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.

Annotations

@Override

Exceptions

JacksonException:: for low-level read issues

streamReadCapabilities	back to summary
public JacksonFeatureSet<StreamReadCapability> streamReadCapabilities() Overrides tools.jackson.core.base.ParserMinimalBase.streamReadCapabilities. Doc from tools.jackson.core.JsonParser.streamReadCapabilities. Accessor for getting metadata on capabilities of this parser, based on underlying data format being read (directly or indirectly). Annotations @Override

streamReadCapabilities

back to summary

public JacksonFeatureSet<StreamReadCapability> streamReadCapabilities()

Overrides tools.jackson.core.base.ParserMinimalBase.streamReadCapabilities.

Doc from tools.jackson.core.JsonParser.streamReadCapabilities.

Accessor for getting metadata on capabilities of this parser, based on underlying data format being read (directly or indirectly).

Annotations

@Override

streamReadContext back to summary

streamReadContext	back to summary
public TokenStreamContext streamReadContext() Implements abstract tools.jackson.core.JsonParser.streamReadContext. Doc from tools.jackson.core.JsonParser.streamReadContext. 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. Note method was called `getParsingContext()` in Jackson 2.x Annotations @Override

public TokenStreamContext streamReadContext()

Implements abstract tools.jackson.core.JsonParser.streamReadContext.

Doc from tools.jackson.core.JsonParser.streamReadContext.

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.

Note

method was called getParsingContext() in Jackson 2.x

Annotations

@Override

streamReadInputSource back to summary

streamReadInputSource	back to summary
public Object streamReadInputSource() Implements abstract tools.jackson.core.JsonParser.streamReadInputSource. Doc from tools.jackson.core.JsonParser.streamReadInputSource. Method that can be used to get access to object that is used to access input being parsed; this is usually either `InputStream` or `Reader`, depending on what parser was constructed with. Note that returned value may be null in some cases; including case where parser implementation does not want to exposed raw source to caller. In cases where input has been decorated, object returned here is the decorated version; this allows some level of interaction between users of parser and decorator object. In general use of this accessor should be considered as "last effort", i.e. only used if no other mechanism is applicable. Note was named `getInputSource()` in Jackson 2.x. Annotations @Override

public Object streamReadInputSource()

Implements abstract tools.jackson.core.JsonParser.streamReadInputSource.

Doc from tools.jackson.core.JsonParser.streamReadInputSource.

Method that can be used to get access to object that is used to access input being parsed; this is usually either InputStream or Reader, depending on what parser was constructed with. Note that returned value may be null in some cases; including case where parser implementation does not want to exposed raw source to caller. In cases where input has been decorated, object returned here is the decorated version; this allows some level of interaction between users of parser and decorator object.

In general use of this accessor should be considered as "last effort", i.e. only used if no other mechanism is applicable.

Note

was named getInputSource() in Jackson 2.x.

Annotations

@Override

version	back to summary
public Version version() Implements abstract tools.jackson.core.JsonParser.version. Implements tools.jackson.core.Versioned.version. Doc from tools.jackson.core.JsonParser.version. Accessor for getting version of the core package, given a parser instance. Left for sub-classes to implement. Annotations @Override

version

back to summary

public Version version()

Implements abstract tools.jackson.core.JsonParser.version.

Implements tools.jackson.core.Versioned.version.

Doc from tools.jackson.core.JsonParser.version.

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

Annotations

@Override

public Class JavaPropsParser

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail