public class UTF8DataInputJsonParser extends ParserBase
JsonParser, which is
based on a DataInput as the input source.
Due to limitations in look-ahead (basically there's none), as well as overhead of reading content mostly byte-by-byte, there are some minor differences from regular streaming parsing. Specifically:
DataInput.
JsonParser.Feature, JsonParser.NumberType| Constructor and Description |
|---|
UTF8DataInputJsonParser(IOContext ctxt,
int features,
java.io.DataInput inputData,
ObjectCodec codec,
ByteQuadsCanonicalizer sym,
int firstByte) |
| Modifier and Type | Method and Description |
|---|---|
void |
finishToken()
Method that may be used to force full handling of the current token
so that even if lazy processing is enabled, the whole contents are
read for possible retrieval.
|
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
|
java.lang.Object |
getInputSource()
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. |
java.lang.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. |
int |
getText(java.io.Writer writer)
Method to read the textual representation of the current token in chunks and
pass it to the given Writer.
|
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.
|
int |
getValueAsInt()
Method that will try to convert value of current token to a
int.
|
int |
getValueAsInt(int defValue)
Method that will try to convert value of current token to a
int.
|
java.lang.String |
getValueAsString()
Method that will try to convert value of current token to a
String. |
java.lang.String |
getValueAsString(java.lang.String defValue)
Method that will try to convert value of current token to a
String. |
java.lang.Boolean |
nextBooleanValue()
Method that fetches next token (as if calling
JsonParser.nextToken()) and
if it is JsonToken.VALUE_TRUE or JsonToken.VALUE_FALSE
returns matching Boolean value; otherwise return null. |
java.lang.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. |
int |
nextIntValue(int defaultValue)
Method that fetches next token (as if calling
JsonParser.nextToken()) and
if it is JsonToken.VALUE_NUMBER_INT returns 32-bit int value;
otherwise returns specified default value
It is functionally equivalent to: |
long |
nextLongValue(long defaultValue)
Method that fetches next token (as if calling
JsonParser.nextToken()) and
if it is JsonToken.VALUE_NUMBER_INT returns 64-bit long value;
otherwise returns specified default value
It is functionally equivalent to: |
java.lang.String |
nextTextValue()
Method that fetches next token (as if calling
JsonParser.nextToken()) and
if it is JsonToken.VALUE_STRING returns contained String value;
otherwise returns null. |
JsonToken |
nextToken()
Main iteration method, which will advance stream enough
to determine type of the next token, if any.
|
int |
readBinaryValue(Base64Variant b64variant,
java.io.OutputStream out)
Similar to
JsonParser.readBinaryValue(OutputStream) but allows explicitly
specifying base64 variant to use. |
int |
releaseBuffered(java.io.OutputStream out)
Method that can be called to push back any content that
has been read but not consumed by the parser.
|
void |
setCodec(ObjectCodec c)
Setter that allows defining
ObjectCodec associated with this
parser, if any. |
_getByteArrayBuilder, close, disable, enable, getBigIntegerValue, getCurrentName, getCurrentValue, getDecimalValue, getDoubleValue, getFloatValue, getIntValue, getLongValue, getNumberType, getNumberValue, getParsingContext, getTokenCharacterOffset, getTokenColumnNr, getTokenLineNr, hasTextCharacters, isClosed, isNaN, overrideCurrentName, overrideStdFeatures, setCurrentValue, setFeatureMask, versionclearCurrentToken, currentToken, currentTokenId, getCurrentToken, getCurrentTokenId, getLastClearedToken, getValueAsBoolean, getValueAsDouble, getValueAsLong, getValueAsLong, hasCurrentToken, hasToken, hasTokenId, isExpectedStartArrayToken, isExpectedStartObjectToken, nextValue, skipChildrencanParseAsync, canReadObjectId, canReadTypeId, canUseSchema, configure, currentName, getBinaryValue, getBooleanValue, getByteValue, getEmbeddedObject, getFeatureMask, getFormatFeatures, getNonBlockingInputFeeder, getObjectId, getSchema, getShortValue, getTypeId, getValueAsBoolean, getValueAsDouble, isEnabled, isEnabled, nextFieldName, overrideFormatFeatures, readBinaryValue, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, requiresCustomCodec, setRequestPayloadOnError, setRequestPayloadOnError, setRequestPayloadOnError, setSchemapublic UTF8DataInputJsonParser(IOContext ctxt, int features, java.io.DataInput inputData, ObjectCodec codec, ByteQuadsCanonicalizer sym, int firstByte)
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 int releaseBuffered(java.io.OutputStream out)
throws java.io.IOException
JsonParserreleaseBuffered in class JsonParserOutputStream;
otherwise number of bytes released (0 if there was nothing to release)java.io.IOException - if write to stream threw exceptionpublic java.lang.Object getInputSource()
JsonParserInputStream 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.
getInputSource in class JsonParserpublic java.lang.String getText()
throws java.io.IOException
JsonParserJsonParser.nextToken(), or
after encountering end-of-input), returns null.
Method can be called for any token type.getText in class ParserMinimalBasejava.io.IOExceptionpublic int getText(java.io.Writer writer)
throws java.io.IOException
JsonParserwriter.write(parser.getText());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.getText in class JsonParserjava.io.IOExceptionpublic java.lang.String getValueAsString()
throws java.io.IOException
JsonParserString.
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), default value of
null will be returned; no exceptions are thrown.getValueAsString in class ParserMinimalBasejava.io.IOExceptionpublic java.lang.String getValueAsString(java.lang.String defValue)
throws java.io.IOException
JsonParserString.
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.getValueAsString in class ParserMinimalBasejava.io.IOExceptionpublic int getValueAsInt()
throws java.io.IOException
JsonParserIf representation can not be converted to an int (including structured type markers like start/end Object/Array) default value of 0 will be returned; no exceptions are thrown.
getValueAsInt in class ParserMinimalBasejava.io.IOExceptionpublic int getValueAsInt(int defValue)
throws java.io.IOException
JsonParserIf representation can not be converted to an int (including structured type markers like start/end Object/Array) specified def will be returned; no exceptions are thrown.
getValueAsInt in class ParserMinimalBasejava.io.IOExceptionpublic char[] getTextCharacters()
throws java.io.IOException
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 ParserMinimalBasejava.io.IOExceptionpublic int getTextLength()
throws java.io.IOException
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.java.io.IOExceptionpublic int getTextOffset()
throws java.io.IOException
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.java.io.IOExceptionpublic byte[] getBinaryValue(Base64Variant b64variant) throws java.io.IOException
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 ParserBaseb64variant - Expected variant of base64 encoded
content (see Base64Variants for definitions
of "standard" variants).java.io.IOExceptionpublic int readBinaryValue(Base64Variant b64variant, java.io.OutputStream out) throws java.io.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 dataOutputStreamjava.io.IOExceptionpublic JsonToken nextToken() throws java.io.IOException
JsonParsernextToken in class ParserMinimalBasejava.io.IOExceptionpublic void finishToken()
throws java.io.IOException
JsonParserJsonParser.getTextCharacters(), would
achieve).
Note that for many dataformat implementations this method will not do anything; this is the default implementation unless overridden by sub-classes.
finishToken in class JsonParserjava.io.IOExceptionpublic java.lang.String nextFieldName()
throws java.io.IOException
JsonParserJsonParser.nextToken()) and
verifies whether it is JsonToken.FIELD_NAME; if it is,
returns same as JsonParser.getCurrentName(), otherwise null.nextFieldName in class JsonParserjava.io.IOExceptionpublic java.lang.String nextTextValue()
throws java.io.IOException
JsonParserJsonParser.nextToken()) and
if it is JsonToken.VALUE_STRING returns contained String value;
otherwise returns null.
It is functionally equivalent to:
return (nextToken() == JsonToken.VALUE_STRING) ? getText() : null;but may be faster for parser to process, and can therefore be used if caller expects to get a String value next from input.
nextTextValue in class JsonParserjava.io.IOExceptionpublic int nextIntValue(int defaultValue)
throws java.io.IOException
JsonParserJsonParser.nextToken()) and
if it is JsonToken.VALUE_NUMBER_INT returns 32-bit int value;
otherwise returns specified default value
It is functionally equivalent to:
return (nextToken() == JsonToken.VALUE_NUMBER_INT) ? getIntValue() : defaultValue;but may be faster for parser to process, and can therefore be used if caller expects to get an int value next from input.
nextIntValue in class JsonParserjava.io.IOExceptionpublic long nextLongValue(long defaultValue)
throws java.io.IOException
JsonParserJsonParser.nextToken()) and
if it is JsonToken.VALUE_NUMBER_INT returns 64-bit long value;
otherwise returns specified default value
It is functionally equivalent to:
return (nextToken() == JsonToken.VALUE_NUMBER_INT) ? getLongValue() : defaultValue;but may be faster for parser to process, and can therefore be used if caller expects to get a long value next from input.
nextLongValue in class JsonParserjava.io.IOExceptionpublic java.lang.Boolean nextBooleanValue()
throws java.io.IOException
JsonParserJsonParser.nextToken()) and
if it is JsonToken.VALUE_TRUE or JsonToken.VALUE_FALSE
returns matching Boolean value; otherwise return null.
It is functionally equivalent to:
JsonToken t = nextToken(); if (t == JsonToken.VALUE_TRUE) return Boolean.TRUE; if (t == JsonToken.VALUE_FALSE) return Boolean.FALSE; return null;but may be faster for parser to process, and can therefore be used if caller expects to get a Boolean value next from input.
nextBooleanValue in class JsonParserjava.io.IOExceptionpublic JsonLocation getTokenLocation()
ParserBasegetTokenLocation in class ParserBasepublic JsonLocation getCurrentLocation()
ParserBasegetCurrentLocation in class ParserBaseCopyright © 2010 - 2020 Adobe. All Rights Reserved