protected static final class TokenBuffer.Parser extends ParserMinimalBase
JsonParser.Feature, JsonParser.NumberType| Modifier and Type | Field and Description |
|---|---|
protected ByteArrayBuilder |
_byteBuilder |
protected boolean |
_closed |
protected ObjectCodec |
_codec |
protected boolean |
_hasNativeIds |
protected boolean |
_hasNativeObjectIds |
protected boolean |
_hasNativeTypeIds |
protected JsonLocation |
_location |
protected JsonReadContext |
_parsingContext
Information about parser context, context in which
the next token is to be parsed (root, array, object).
|
protected TokenBuffer.Segment |
_segment
Currently active segment
|
protected int |
_segmentPtr
Pointer to current token within current segment
|
_currToken, _lastClearedToken, INT_BACKSLASH, INT_COLON, INT_COMMA, INT_CR, INT_e, INT_E, INT_HASH, INT_LBRACKET, INT_LCURLY, INT_LF, INT_PERIOD, INT_QUOTE, INT_RBRACKET, INT_RCURLY, INT_SLASH, INT_SPACE, INT_TAB_features, _requestPayload| Constructor and Description |
|---|
Parser(TokenBuffer.Segment firstSeg,
ObjectCodec codec,
boolean hasNativeTypeIds,
boolean hasNativeObjectIds) |
| Modifier and Type | Method and Description |
|---|---|
protected void |
_checkIsNumber() |
protected Object |
_currentObject() |
protected void |
_handleEOF()
Method sub-classes need to implement
|
boolean |
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).
|
boolean |
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).
|
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. |
BigInteger |
getBigIntegerValue()
Numeric accessor that can be called when the current
token is of type
JsonToken.VALUE_NUMBER_INT and
it can not be used as a Java long primitive type due to its
magnitude. |
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.
|
ObjectCodec |
getCodec()
Accessor for
ObjectCodec associated with this
parser, if any. |
JsonLocation |
getCurrentLocation()
Method that returns location of the last processed character;
usually for error reporting purposes.
|
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. |
BigDecimal |
getDecimalValue()
Numeric accessor that can be called when the current
token is of type
JsonToken.VALUE_NUMBER_FLOAT or
JsonToken.VALUE_NUMBER_INT. |
double |
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. |
Object |
getEmbeddedObject()
Accessor that can be called if (and only if) the current token
is
JsonToken.VALUE_EMBEDDED_OBJECT. |
float |
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. |
int |
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. |
long |
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. |
JsonParser.NumberType |
getNumberType()
If current token is of type
JsonToken.VALUE_NUMBER_INT or
JsonToken.VALUE_NUMBER_FLOAT, returns
one of JsonParser.NumberType constants; otherwise returns null. |
Number |
getNumberValue()
Generic number value accessor method that will work for
all kinds of numeric values.
|
Object |
getObjectId()
Method that can be called to check whether current token
(one that was just read) has an associated Object id, and if
so, return it.
|
JsonStreamContext |
getParsingContext()
Method that can be used to access current parsing context reader
is in.
|
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. |
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. |
int |
getTextLength()
Accessor used with
JsonParser.getTextCharacters(), to know length
of String stored in returned buffer. |
int |
getTextOffset()
Accessor used with
JsonParser.getTextCharacters(), to know offset
of the first text content character within buffer. |
JsonLocation |
getTokenLocation()
Method that return the starting location of the current
token; that is, position of the first character from input
that starts the current token.
|
Object |
getTypeId()
Method that can be called to check whether current token
(one that was just read) has an associated type id, and if
so, return it.
|
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. |
boolean |
isClosed()
Method that can be called to determine whether this parser
is closed or not.
|
String |
nextFieldName()
Method that fetches next token (as if calling
JsonParser.nextToken()) and
verifies whether it is JsonToken.FIELD_NAME; if it is,
returns same as JsonParser.getCurrentName(), otherwise null. |
JsonToken |
nextToken()
Main iteration method, which will advance stream enough
to determine type of the next token, if any.
|
void |
overrideCurrentName(String name)
Method that can be used to change what is considered to be
the current (field) name.
|
JsonToken |
peekNextToken() |
int |
readBinaryValue(Base64Variant b64variant,
OutputStream out)
Similar to
JsonParser.readBinaryValue(OutputStream) but allows explicitly
specifying base64 variant to use. |
void |
setCodec(ObjectCodec c)
Setter that allows defining
ObjectCodec associated with this
parser, if any. |
void |
setLocation(JsonLocation l) |
Version |
version()
Accessor for getting version of the core package, given a parser instance.
|
_ascii, _asciiBytes, _constructError, _decodeBase64, _getCharDesc, _handleUnrecognizedCharacterEscape, _hasTextualNull, _reportError, _reportInvalidEOF, _reportInvalidEOF, _reportInvalidEOF, _reportInvalidEOFInValue, _reportInvalidEOFInValue, _reportMissingRootWS, _reportUnexpectedChar, _throwInternal, _throwInvalidSpace, _throwUnquotedSpace, _wrapError, clearCurrentToken, currentToken, currentTokenId, getCurrentToken, getCurrentTokenId, getLastClearedToken, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsInt, getValueAsLong, getValueAsLong, getValueAsString, getValueAsString, hasCurrentToken, hasToken, hasTokenId, isExpectedStartArrayToken, isExpectedStartObjectToken, nextValue, skipChildren_codec, _constructError, _reportUnsupportedOperation, canUseSchema, configure, disable, enable, finishToken, getBinaryValue, getBooleanValue, getByteValue, getCurrentValue, getFeatureMask, getFormatFeatures, getInputSource, getSchema, getShortValue, getText, getValueAsBoolean, getValueAsDouble, isEnabled, nextBooleanValue, nextFieldName, nextIntValue, nextLongValue, nextTextValue, overrideFormatFeatures, overrideStdFeatures, readBinaryValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, releaseBuffered, requiresCustomCodec, setCurrentValue, setFeatureMask, setRequestPayloadOnError, setRequestPayloadOnError, setRequestPayloadOnError, setSchemaprotected ObjectCodec _codec
protected final boolean _hasNativeTypeIds
protected final boolean _hasNativeObjectIds
protected final boolean _hasNativeIds
protected TokenBuffer.Segment _segment
protected int _segmentPtr
protected JsonReadContext _parsingContext
protected boolean _closed
protected transient ByteArrayBuilder _byteBuilder
protected JsonLocation _location
public Parser(TokenBuffer.Segment firstSeg, ObjectCodec codec, boolean hasNativeTypeIds, boolean hasNativeObjectIds)
public void setLocation(JsonLocation l)
public ObjectCodec getCodec()
JsonParserObjectCodec associated with this
parser, if any. Codec is used by JsonParser.readValueAs(Class)
method (and its variants).getCodec in class JsonParserpublic void setCodec(ObjectCodec c)
JsonParserObjectCodec associated with this
parser, if any. Codec is used by JsonParser.readValueAs(Class)
method (and its variants).setCodec in class JsonParserpublic Version version()
JsonParserversion in interface Versionedversion in class JsonParserpublic JsonToken peekNextToken() throws IOException
IOExceptionpublic void close()
throws IOException
JsonParserJsonParser.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.close in interface Closeableclose in interface AutoCloseableclose in class ParserMinimalBaseIOExceptionpublic JsonToken nextToken() throws IOException
JsonParsernextToken in class ParserMinimalBaseIOExceptionpublic String nextFieldName() throws IOException
JsonParserJsonParser.nextToken()) and
verifies whether it is JsonToken.FIELD_NAME; if it is,
returns same as JsonParser.getCurrentName(), otherwise null.nextFieldName in class JsonParserIOExceptionpublic boolean isClosed()
JsonParserJsonParser.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.isClosed in class ParserMinimalBasepublic JsonStreamContext getParsingContext()
JsonParsergetParsingContext in class ParserMinimalBasepublic JsonLocation getTokenLocation()
JsonParsergetTokenLocation in class JsonParserpublic JsonLocation getCurrentLocation()
JsonParsergetCurrentLocation in class JsonParserpublic String getCurrentName()
JsonParserJsonToken.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.getCurrentName in class ParserMinimalBasepublic void overrideCurrentName(String name)
JsonParserNote that use of this method should only be done as sort of last resort, as it is a work-around for regular operation.
overrideCurrentName in class ParserMinimalBasename - Name to use as the current name; may be null.public String getText()
JsonParserJsonParser.nextToken(), or
after encountering end-of-input), returns null.
Method can be called for any token type.getText in class ParserMinimalBasepublic char[] getTextCharacters()
JsonParserJsonParser.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:
JsonParser.getTextOffset()) to
know the actual offset
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).
getTextCharacters in class ParserMinimalBasepublic int getTextLength()
JsonParserJsonParser.getTextCharacters(), to know length
of String stored in returned buffer.getTextLength in class ParserMinimalBaseJsonParser.getTextCharacters() that are part of
textual content of the current token.public int getTextOffset()
JsonParserJsonParser.getTextCharacters(), to know offset
of the first text content character within buffer.getTextOffset in class ParserMinimalBaseJsonParser.getTextCharacters() that is part of
textual content of the current token.public boolean hasTextCharacters()
JsonParserJsonParser.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.
hasTextCharacters in class ParserMinimalBaseJsonParser.getTextCharacters(); false
means that it may or may not existpublic BigInteger getBigIntegerValue() throws IOException
JsonParserJsonToken.VALUE_NUMBER_INT and
it can not 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 JsonParser.getDecimalValue()
and then constructing a BigInteger from that value.getBigIntegerValue in class JsonParserIOExceptionpublic BigDecimal getDecimalValue() throws IOException
JsonParserJsonToken.VALUE_NUMBER_FLOAT or
JsonToken.VALUE_NUMBER_INT. No under/overflow exceptions
are ever thrown.getDecimalValue in class JsonParserIOExceptionpublic double getDoubleValue()
throws IOException
JsonParserJsonToken.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 JsonParser.getLongValue()
and then casting; except for possible overflow/underflow
exception.
Note: if the value falls
outside of range of Java double, a JsonParseException
will be thrown to indicate numeric overflow/underflow.
getDoubleValue in class JsonParserIOExceptionpublic float getFloatValue()
throws IOException
JsonParserJsonToken.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 JsonParser.getLongValue()
and then casting; except for possible overflow/underflow
exception.
Note: if the value falls
outside of range of Java float, a JsonParseException
will be thrown to indicate numeric overflow/underflow.
getFloatValue in class JsonParserIOExceptionpublic int getIntValue()
throws IOException
JsonParserJsonToken.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 JsonParser.getDoubleValue()
and then casting; except for possible overflow/underflow
exception.
Note: if the resulting integer value falls outside range of
Java int, a JsonParseException
may be thrown to indicate numeric overflow/underflow.
getIntValue in class JsonParserIOExceptionpublic long getLongValue()
throws IOException
JsonParserJsonToken.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 JsonParser.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 JsonParseException
may be thrown to indicate numeric overflow/underflow.
getLongValue in class JsonParserIOExceptionpublic JsonParser.NumberType getNumberType() throws IOException
JsonParserJsonToken.VALUE_NUMBER_INT or
JsonToken.VALUE_NUMBER_FLOAT, returns
one of JsonParser.NumberType constants; otherwise returns null.getNumberType in class JsonParserIOExceptionpublic final Number getNumberValue() throws IOException
JsonParsergetNumberValue in class JsonParserIOExceptionpublic Object getEmbeddedObject()
JsonParserJsonToken.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
JsonParser.getBinaryValue().
getEmbeddedObject in class JsonParserpublic byte[] getBinaryValue(Base64Variant b64variant) throws IOException, JsonParseException
JsonParserJsonParser.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.
getBinaryValue in class ParserMinimalBaseb64variant - Expected variant of base64 encoded
content (see Base64Variants for definitions
of "standard" variants).IOExceptionJsonParseExceptionpublic int readBinaryValue(Base64Variant b64variant, OutputStream out) throws IOException
JsonParserJsonParser.readBinaryValue(OutputStream) but allows explicitly
specifying base64 variant to use.readBinaryValue in class JsonParserb64variant - base64 variant to useout - Output stream to use for passing decoded binary dataOutputStreamIOExceptionpublic boolean canReadObjectId()
JsonParserDefault 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 can not use native object ids.
canReadObjectId in class JsonParserpublic boolean canReadTypeId()
JsonParserDefault 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 can not use native type ids.
canReadTypeId in class JsonParserpublic Object getTypeId()
JsonParserJsonParser.canReadTypeId()
first, it is not illegal to call this method even if that method returns
true; but if so, it will return null. This may be used to simplify calling
code.
Default implementation will simply return null.
getTypeId in class JsonParserpublic Object getObjectId()
JsonParserJsonParser.canReadObjectId()
first, it is not illegal to call this method even if that method returns
true; but if so, it will return null. This may be used to simplify calling
code.
Default implementation will simply return null.
getObjectId in class JsonParserprotected final Object _currentObject()
protected final void _checkIsNumber()
throws JsonParseException
JsonParseExceptionprotected void _handleEOF()
throws JsonParseException
ParserMinimalBase_handleEOF in class ParserMinimalBaseJsonParseExceptionCopyright © 2017 JBoss by Red Hat. All rights reserved.