org.hotwheel.json.impl.jackson

类 UTF8StreamJsonParser

java.lang.Object

org.hotwheel.json.impl.jackson.JacksonParser

org.hotwheel.json.impl.jackson.ParserMinimalBase

org.hotwheel.json.impl.jackson.ParserBase

org.hotwheel.json.impl.jackson.UTF8StreamJsonParser

所有已实现的接口:

Closeable, AutoCloseable, Versioned

public final class UTF8StreamJsonParser
extends ParserBase

This is a concrete implementation of JacksonParser, which is based on a InputStream as the input source.

嵌套类概要

从类继承的嵌套类/接口 org.hotwheel.json.impl.jackson.JacksonParser

JacksonParser.Feature, JacksonParser.NumberType

构造器概要

构造器

构造器和说明
UTF8StreamJsonParser(IOContext ctxt, int features, InputStream in, ObjectCodec codec, BytesToNameCanonicalizer sym, byte[] inputBuffer, int start, int end, boolean bufferRecyclable)

方法概要

限定符和类型	方法和说明
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 JacksonParser.Feature.AUTO_CLOSE_SOURCE is enabled.
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.
Object	getEmbeddedObject() Accessor that can be called if (and only if) the current token is JsonToken.VALUE_EMBEDDED_OBJECT.
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.
String	getText() Method for accessing textual representation of the current token; if no current token (before first call to JacksonParser.nextToken(), or after encountering end-of-input), returns null.
char[]	getTextCharacters() Method similar to JacksonParser.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 JacksonParser.getTextCharacters(), to know length of String stored in returned buffer.
int	getTextOffset() Accessor used with JacksonParser.getTextCharacters(), to know offset of the first text content character within buffer.
static int[]	growArrayBy(int[] arr, int more)
Boolean	nextBooleanValue() Method that fetches next token (as if calling JacksonParser.nextToken()) and if it is JsonToken.VALUE_TRUE or JsonToken.VALUE_FALSE returns matching Boolean value; otherwise return null.
boolean	nextFieldName(SerializableString str) Method that fetches next token (as if calling JacksonParser.nextToken()) and verifies whether it is JsonToken.FIELD_NAME with specified name and returns result of that comparison.
int	nextIntValue(int defaultValue) Method that fetches next token (as if calling JacksonParser.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) ?
long	nextLongValue(long defaultValue) Method that fetches next token (as if calling JacksonParser.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) ?
String	nextTextValue() Method that fetches next token (as if calling JacksonParser.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	releaseBuffered(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.
Version	version() Accessor for getting version of the core package, given a parser instance.

从类继承的方法 org.hotwheel.json.impl.jackson.ParserBase

_getByteArrayBuilder, getBigIntegerValue, getCurrentLocation, getCurrentName, getDecimalValue, getDoubleValue, getFloatValue, getIntValue, getLongValue, getNumberType, getNumberValue, getParsingContext, getTokenCharacterOffset, getTokenColumnNr, getTokenLineNr, getTokenLocation, hasTextCharacters, isClosed, overrideCurrentName

从类继承的方法 org.hotwheel.json.impl.jackson.ParserMinimalBase

clearCurrentToken, getCurrentToken, getLastClearedToken, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsLong, hasCurrentToken, nextValue, skipChildren

从类继承的方法 org.hotwheel.json.impl.jackson.JacksonParser

canUseSchema, configure, disable, enable, getBinaryValue, getBooleanValue, getByteValue, getSchema, getShortValue, getValueAsBoolean, getValueAsDouble, getValueAsInt, getValueAsLong, isEnabled, isExpectedStartArrayToken, readValueAs, readValueAs, readValueAsTree, readValuesAs, readValuesAs, releaseBuffered, setSchema

从类继承的方法 java.lang.Object

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

构造器详细资料

UTF8StreamJsonParser

public UTF8StreamJsonParser(IOContext ctxt,
                            int features,
                            InputStream in,
                            ObjectCodec codec,
                            BytesToNameCanonicalizer sym,
                            byte[] inputBuffer,
                            int start,
                            int end,
                            boolean bufferRecyclable)

方法详细资料

growArrayBy

public static int[] growArrayBy(int[] arr,
                                int more)

getCodec

public ObjectCodec getCodec()

从类复制的说明: JacksonParser

Accessor for ObjectCodec associated with this parser, if any. Codec is used by JacksonParser.readValueAs(Class) method (and its variants).

指定者:

getCodec 在类中 JacksonParser

setCodec

public void setCodec(ObjectCodec c)

从类复制的说明: JacksonParser

Setter that allows defining ObjectCodec associated with this parser, if any. Codec is used by JacksonParser.readValueAs(Class) method (and its variants).

指定者:

setCodec 在类中 JacksonParser

version

public Version version()

从类复制的说明: JacksonParser

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

指定者:

version 在接口中 Versioned

覆盖:

version 在类中 ParserMinimalBase

releaseBuffered

public int releaseBuffered(OutputStream out)
                    throws IOException

从类复制的说明: JacksonParser

Method that can be called to push back any content that has been read but not consumed by the parser. This is usually done after reading all content of interest using parser. Content is released by writing it to given stream if possible; if underlying input is byte-based it can released, if not (char-based) it can not.

覆盖:

releaseBuffered 在类中 JacksonParser

返回:

-1 if the underlying content source is not byte based (that is, input can not be sent to OutputStream; otherwise number of bytes released (0 if there was nothing to release)

抛出:

IOException - if write to stream threw exception

getInputSource

public Object getInputSource()

从类复制的说明: JacksonParser

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.

覆盖:

getInputSource 在类中 JacksonParser

getText

public String getText()
               throws IOException,
                      JsonParseException

从类复制的说明: JacksonParser

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

指定者:

getText 在类中 ParserMinimalBase

抛出:

IOException

JsonParseException

getTextCharacters

public char[] getTextCharacters()
                         throws IOException,
                                JsonParseException

从类复制的说明: JacksonParser

Method similar to JacksonParser.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 JacksonParser.getTextOffset()) to know the actual offset
• Length of textual contents may be less than the length of returned buffer: call JacksonParser.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 JacksonParser.getText()) is to avoid construction of a String object (which will make a copy of contents).

指定者:

getTextCharacters 在类中 ParserMinimalBase

抛出:

IOException

JsonParseException

getTextLength

public int getTextLength()
                  throws IOException,
                         JsonParseException

从类复制的说明: JacksonParser

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

指定者:

getTextLength 在类中 ParserMinimalBase

返回:

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

抛出:

IOException

JsonParseException

getTextOffset

public int getTextOffset()
                  throws IOException,
                         JsonParseException

从类复制的说明: JacksonParser

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

指定者:

getTextOffset 在类中 ParserMinimalBase

返回:

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

抛出:

IOException

JsonParseException

getEmbeddedObject

public Object getEmbeddedObject()
                         throws IOException,
                                JsonParseException

从类复制的说明: JacksonParser

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

指定者:

getEmbeddedObject 在类中 JacksonParser

抛出:

IOException

JsonParseException

getBinaryValue

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

从类复制的说明: JacksonParser

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 JacksonParser.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 在类中 ParserMinimalBase

参数:

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

返回:

Decoded binary data

抛出:

IOException

JsonParseException

nextToken

public JsonToken nextToken()
                    throws IOException,
                           JsonParseException

从类复制的说明: JacksonParser

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.

指定者:

nextToken 在类中 ParserMinimalBase

返回:

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

抛出:

IOException

JsonParseException

close

public void close()
           throws IOException

从类复制的说明: JacksonParser

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 JacksonParser.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 在接口中 Closeable

指定者:

close 在接口中 AutoCloseable

覆盖:

close 在类中 ParserBase

抛出:

IOException

nextFieldName

public boolean nextFieldName(SerializableString str)
                      throws IOException,
                             JsonParseException

从类复制的说明: JacksonParser

Method that fetches next token (as if calling JacksonParser.nextToken()) and verifies whether it is JsonToken.FIELD_NAME with specified name and returns result of that comparison. It is functionally equivalent to:

  return (nextToken() == JsonToken.FIELD_NAME) && str.getValue().equals(getCurrentName());
 

but may be faster for parser to verify, and can therefore be used if caller expects to get such a property name from input next.

覆盖:

nextFieldName 在类中 JacksonParser

参数:

str - Property name to compare next token to (if next token is JsonToken.FIELD_NAME)

抛出:

IOException

JsonParseException

nextTextValue

public String nextTextValue()
                     throws IOException,
                            JsonParseException

从类复制的说明: JacksonParser

Method that fetches next token (as if calling JacksonParser.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 在类中 JacksonParser

抛出:

IOException

JsonParseException

nextIntValue

public int nextIntValue(int defaultValue)
                 throws IOException,
                        JsonParseException

从类复制的说明: JacksonParser

Method that fetches next token (as if calling JacksonParser.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 a String value next from input.

覆盖:

nextIntValue 在类中 JacksonParser

抛出:

IOException

JsonParseException

nextLongValue

public long nextLongValue(long defaultValue)
                   throws IOException,
                          JsonParseException

从类复制的说明: JacksonParser

Method that fetches next token (as if calling JacksonParser.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 String value next from input.

覆盖:

nextLongValue 在类中 JacksonParser

抛出:

IOException

JsonParseException

nextBooleanValue

public Boolean nextBooleanValue()
                         throws IOException,
                                JsonParseException

从类复制的说明: JacksonParser

Method that fetches next token (as if calling JacksonParser.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 String value next from input.

覆盖:

nextBooleanValue 在类中 JacksonParser

抛出:

IOException

JsonParseException