Package com.fasterxml.jackson.core.json

Class UTF8StreamJsonParser

  • All Implemented Interfaces:
    Versioned, java.io.Closeable, java.lang.AutoCloseable
    public class UTF8StreamJsonParser
extends JsonParserBase
    This is a concrete implementation of JsonParser, which is based on a InputStream as the input source.

    • Constructor Detail

      • UTF8StreamJsonParser

        @Deprecated
public UTF8StreamJsonParser​(IOContext ctxt,
                            int features,
                            java.io.InputStream in,
                            ObjectCodec codec,
                            ByteQuadsCanonicalizer sym,
                            byte[] inputBuffer,
                            int start,
                            int end,
                            boolean bufferRecyclable)
        Deprecated.
        Since 2.10
        Constructor called when caller wants to provide input buffer directly (or needs to, in case of bootstrapping having read some of contents) and it may or may not be recyclable use standard recycle context.
        Parameters:
        ctxt - I/O context to use
        features - Standard stream read features enabled
        in - InputStream used for reading actual content, if any; null if none
        codec - ObjectCodec to delegate object deserialization to
        sym - Name canonicalizer to use
        inputBuffer - Input buffer to read initial content from (before Reader)
        start - Pointer in inputBuffer that has the first content character to decode
        end - Pointer past the last content character in inputBuffer
        bufferRecyclable - Whether inputBuffer passed is managed by Jackson core (and thereby needs recycling)

      • UTF8StreamJsonParser

        public UTF8StreamJsonParser​(IOContext ctxt,
                            int features,
                            java.io.InputStream in,
                            ObjectCodec codec,
                            ByteQuadsCanonicalizer sym,
                            byte[] inputBuffer,
                            int start,
                            int end,
                            int bytesPreProcessed,
                            boolean bufferRecyclable)
        Constructor called when caller wants to provide input buffer directly (or needs to, in case of bootstrapping having read some of contents) and it may or may not be recyclable use standard recycle context.
        Parameters:
        ctxt - I/O context to use
        features - Standard stream read features enabled
        in - InputStream used for reading actual content, if any; null if none
        codec - ObjectCodec to delegate object deserialization to
        sym - Name canonicalizer to use
        inputBuffer - Input buffer to read initial content from (before Reader)
        start - Pointer in inputBuffer that has the first content character to decode
        end - Pointer past the last content character in inputBuffer
        bytesPreProcessed - Number of bytes that have been consumed already (by bootstrapping)
        bufferRecyclable - Whether inputBuffer passed is managed by Jackson core (and thereby needs recycling)

    • Method Detail

      • releaseBuffered

        public int releaseBuffered​(java.io.OutputStream out)
                    throws java.io.IOException
        Description copied from class: JsonParser
        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.
        Overrides:
        releaseBuffered in class JsonParser
        Parameters:
        out - OutputStream to which buffered, undecoded content is written to
        Returns:
        -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)
        Throws:
        java.io.IOException - if write to stream threw exception

      • getInputSource

        public java.lang.Object getInputSource()
        Description copied from class: JsonParser
        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.

        Overrides:
        getInputSource in class JsonParser
        Returns:
        Input source this parser was configured with

      • getText

        public int getText​(java.io.Writer writer)
            throws java.io.IOException
        Description copied from class: JsonParser
        Method to read the textual representation of the current token in chunks and pass it to the given Writer. Conceptually same as calling: 
          writer.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.
        Overrides:
        getText in class JsonParser
        Parameters:
        writer - Writer to write textual content to
        Returns:
        The number of characters written to the Writer
        Throws:
        java.io.IOException - for low-level read issues or writes using passed writer, or JsonParseException for decoding problems

      • getValueAsString

        public java.lang.String getValueAsString()
                                  throws java.io.IOException
        Description copied from class: JsonParser
        Method that will try to convert value of current token to a String. JSON Strings map naturally; scalar values get converted to their textual representation. If representation can not be converted to a String value (including structured types like Objects and Arrays and null token), default value of null will be returned; no exceptions are thrown.
        Overrides:
        getValueAsString in class ParserMinimalBase
        Returns:
        String value current token is converted to, if possible; null otherwise
        Throws:
        java.io.IOException - for low-level read issues, or JsonParseException for decoding problems

      • getValueAsString

        public java.lang.String getValueAsString​(java.lang.String defValue)
                                  throws java.io.IOException
        Description copied from class: JsonParser
        Method that will try to convert value of current token to a String. JSON Strings map naturally; scalar values get converted to their textual representation. If representation can not be converted to a String value (including structured types like Objects and Arrays and null token), specified default value will be returned; no exceptions are thrown.
        Overrides:
        getValueAsString in class ParserMinimalBase
        Parameters:
        defValue - Default value to return if conversion to String is not possible
        Returns:
        String value current token is converted to, if possible; def otherwise
        Throws:
        java.io.IOException - for low-level read issues, or JsonParseException for decoding problems

      • getValueAsInt

        public int getValueAsInt()
                  throws java.io.IOException
        Description copied from class: JsonParser
        Method that will try to convert value of current token to a Java int value. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.

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

        Overrides:
        getValueAsInt in class ParserMinimalBase
        Returns:
        int value current token is converted to, if possible; exception thrown otherwise
        Throws:
        java.io.IOException - for low-level read issues, or JsonParseException for decoding problems

      • getValueAsInt

        public int getValueAsInt​(int defValue)
                  throws java.io.IOException
        Description copied from class: JsonParser
        Method that will try to convert value of current token to a int. Numbers are coerced using default Java rules; booleans convert to 0 (false) and 1 (true), and Strings are parsed using default Java language integer parsing rules.

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

        Overrides:
        getValueAsInt in class ParserMinimalBase
        Parameters:
        defValue - Default value to return if conversion to int is not possible
        Returns:
        int value current token is converted to, if possible; def otherwise
        Throws:
        java.io.IOException - for low-level read issues, or JsonParseException for decoding problems

      • getTextCharacters

        public char[] getTextCharacters()
                         throws java.io.IOException
        Description copied from class: JsonParser
        Method similar to JsonParser.getText(), but that will return underlying (unmodifiable) character array that contains textual value, instead of constructing a String object to contain this information. Note, however, that:
        • Textual contents are not guaranteed to start at index 0 (rather, call JsonParser.getTextOffset()) to know the actual offset
        • Length of textual contents may be less than the length of returned buffer: call JsonParser.getTextLength() for actual length of returned content.

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

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

        Specified by:
        getTextCharacters in class ParserMinimalBase
        Returns:
        Buffer that contains the current textual value (but not necessarily at offset 0, and not necessarily until the end of buffer)
        Throws:
        java.io.IOException - for low-level read issues, or JsonParseException for decoding problems, including if the text is too large, see StreamReadConstraints.Builder.maxStringLength(int)

      • getBinaryValue

        public byte[] getBinaryValue​(Base64Variant b64variant)
                      throws java.io.IOException
        Description copied from class: JsonParser
        Method that can be used to read (and consume -- results may not be accessible using other methods after the call) base64-encoded binary data included in the current textual JSON value. It works similar to getting String value via JsonParser.getText() and decoding result (except for decoding part), but should be significantly more performant.

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

        Overrides:
        getBinaryValue in class ParserBase
        Parameters:
        b64variant - Expected variant of base64 encoded content (see Base64Variants for definitions of "standard" variants).
        Returns:
        Decoded binary data
        Throws:
        java.io.IOException - for low-level read issues, or JsonParseException for decoding problems

      • readBinaryValue

        public int readBinaryValue​(Base64Variant b64variant,
                           java.io.OutputStream out)
                    throws java.io.IOException
        Description copied from class: JsonParser
        Similar to JsonParser.readBinaryValue(OutputStream) but allows explicitly specifying base64 variant to use.
        Overrides:
        readBinaryValue in class JsonParser
        Parameters:
        b64variant - base64 variant to use
        out - Output stream to use for passing decoded binary data
        Returns:
        Number of bytes that were decoded and written via OutputStream
        Throws:
        java.io.IOException - for low-level read issues, or JsonParseException for decoding problems

      • nextToken

        public JsonToken nextToken()
                    throws java.io.IOException
        Description copied from class: JsonParser
        Main iteration method, which will advance stream enough to determine type of the next token, if any. If none remaining (stream has no content other than possible white space before ending), null will be returned.
        Specified by:
        nextToken in class ParserMinimalBase
        Returns:
        Next token from the stream, if any found, or null to indicate end-of-input
        Throws:
        java.io.IOException - for low-level read issues, or JsonParseException for decoding problems

      • finishToken

        public void finishToken()
                 throws java.io.IOException
        Description copied from class: JsonParser
        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. This is usually used to ensure that the token end location is available, as well as token contents (similar to what calling, say JsonParser.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.

        Overrides:
        finishToken in class JsonParser
        Throws:
        java.io.IOException - for low-level read issues, or JsonParseException for decoding problems

      • nextFieldName

        public boolean nextFieldName​(SerializableString str)
                      throws java.io.IOException
        Description copied from class: JsonParser
        Method that fetches next token (as if calling JsonParser.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(currentName());
        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.
        Overrides:
        nextFieldName in class JsonParser
        Parameters:
        str - Property name to compare next token to (if next token is JsonToken.FIELD_NAME)
        Returns:
        True if parser advanced to JsonToken.FIELD_NAME with specified name; false otherwise (different token or non-matching name)
        Throws:
        java.io.IOException - for low-level read issues, or JsonParseException for decoding problems

      • nextTextValue

        public java.lang.String nextTextValue()
                               throws java.io.IOException
        Description copied from class: JsonParser
        Method that fetches next token (as if calling JsonParser.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.
        Overrides:
        nextTextValue in class JsonParser
        Returns:
        Text value of the JsonToken.VALUE_STRING token parser advanced to; or null if next token is of some other type
        Throws:
        java.io.IOException - for low-level read issues, or JsonParseException for decoding problems

      • nextIntValue

        public int nextIntValue​(int defaultValue)
                 throws java.io.IOException
        Description copied from class: JsonParser
        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: 
          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.

        NOTE: value checks are performed similar to JsonParser.getIntValue()

        Overrides:
        nextIntValue in class JsonParser
        Parameters:
        defaultValue - Value to return if next token is NOT of type JsonToken.VALUE_NUMBER_INT
        Returns:
        Integer (int) value of the JsonToken.VALUE_NUMBER_INT token parser advanced to; or defaultValue if next token is of some other type
        Throws:
        java.io.IOException - for low-level read issues, or JsonParseException for decoding problems
        InputCoercionException - if integer number does not fit in Java int

      • nextLongValue

        public long nextLongValue​(long defaultValue)
                   throws java.io.IOException
        Description copied from class: JsonParser
        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: 
          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.

        NOTE: value checks are performed similar to JsonParser.getLongValue()

        Overrides:
        nextLongValue in class JsonParser
        Parameters:
        defaultValue - Value to return if next token is NOT of type JsonToken.VALUE_NUMBER_INT
        Returns:
        long value of the JsonToken.VALUE_NUMBER_INT token parser advanced to; or defaultValue if next token is of some other type
        Throws:
        java.io.IOException - for low-level read issues, or JsonParseException for decoding problems
        InputCoercionException - if integer number does not fit in Java long

      • nextBooleanValue

        public java.lang.Boolean nextBooleanValue()
                                   throws java.io.IOException
        Description copied from class: JsonParser
        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. 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.
        Overrides:
        nextBooleanValue in class JsonParser
        Returns:
        Boolean value of the JsonToken.VALUE_TRUE or JsonToken.VALUE_FALSE token parser advanced to; or null if next token is of some other type
        Throws:
        java.io.IOException - for low-level read issues, or JsonParseException for decoding problems

      • currentLocation

        public JsonLocation currentLocation()
        Description copied from class: JsonParser
        Method that returns location of the last processed input unit (character or byte) from the input; 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 JsonLocation.NA due to not having access to input location information (when delegating actual decoding work to other library)

        Specified by:
        currentLocation in class JsonParserBase
        Returns:
        Location of the last processed input unit (byte or character)

      • currentTokenLocation

        public JsonLocation currentTokenLocation()
        Description copied from class: JsonParser
        Method that return the starting location of the current (most recently returned) token; that is, the position of the first input unit (character or byte) 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 JsonLocation.NA due to not having access to input location information (when delegating actual decoding work to other library)

        Specified by:
        currentTokenLocation in class JsonParserBase
        Returns:
        Starting location of the token parser currently points to