Package org.codehaus.jackson.impl

Class JsonParserMinimalBase

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, Versioned
    Direct Known Subclasses:
    JsonParserBase, TokenBuffer.Parser, TreeTraversingParser
    public abstract class JsonParserMinimalBase
extends JsonParser
    Intermediate base class used by all Jackson JsonParser implementations, but does not add any additional fields that depend on particular method of obtaining input.

    Note that 'minimal' here mostly refers to minimal number of fields (size) and functionality that is specific to certain types of parser implementations; but not necessarily to number of methods.

    Since:
    1.6
    Author:
    Tatu Saloranta

    • Constructor Detail

      • JsonParserMinimalBase

        protected JsonParserMinimalBase()

      • JsonParserMinimalBase

        protected JsonParserMinimalBase​(int features)

    • Method Detail

      • nextToken

        public abstract JsonToken nextToken()
                             throws java.io.IOException,
                                    JsonParseException
        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 JsonParser
        Returns:
        Next token from the stream, if any found, or null to indicate end-of-input
        Throws:
        java.io.IOException
        JsonParseException

      • close

        public abstract void close()
                    throws java.io.IOException
        Description copied from class: JsonParser
        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. 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.
        Specified by:
        close in interface java.lang.AutoCloseable
        Specified by:
        close in interface java.io.Closeable
        Specified by:
        close in class JsonParser
        Throws:
        java.io.IOException

      • isClosed

        public abstract boolean isClosed()
        Description copied from class: JsonParser
        Method that can be called to determine whether this parser is closed or not. If it is closed, no new tokens can be retrieved by calling JsonParser.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.
        Specified by:
        isClosed in class JsonParser

      • getParsingContext

        public abstract JsonStreamContext getParsingContext()
        Description copied from class: JsonParser
        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.
        Specified by:
        getParsingContext in class JsonParser

      • getText

        public abstract java.lang.String getText()
                                  throws java.io.IOException,
                                         JsonParseException
        Description copied from class: JsonParser
        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. Method can be called for any token type.
        Specified by:
        getText in class JsonParser
        Throws:
        java.io.IOException
        JsonParseException

      • getTextCharacters

        public abstract char[] getTextCharacters()
                                  throws java.io.IOException,
                                         JsonParseException
        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 JsonParser
        Throws:
        java.io.IOException
        JsonParseException

      • hasTextCharacters

        public abstract boolean hasTextCharacters()
        Description copied from class: JsonParser
        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.

        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.

        Overrides:
        hasTextCharacters in class JsonParser
        Returns:
        True if parser currently has character array that can be efficiently returned via JsonParser.getTextCharacters(); false means that it may or may not exist

      • getBinaryValue

        public abstract byte[] getBinaryValue​(Base64Variant b64variant)
                               throws java.io.IOException,
                                      JsonParseException
        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.

        Specified by:
        getBinaryValue in class JsonParser
        Parameters:
        b64variant - Expected variant of base64 encoded content (see Base64Variants for definitions of "standard" variants).
        Returns:
        Decoded binary data
        Throws:
        java.io.IOException
        JsonParseException

      • getValueAsBoolean

        public boolean getValueAsBoolean​(boolean defaultValue)
                          throws java.io.IOException,
                                 JsonParseException
        Description copied from class: JsonParser
        Method that will try to convert value of current token to a boolean. JSON booleans map naturally; integer numbers other than 0 map to true, and 0 maps to false and Strings 'true' and 'false' map to corresponding values.

        If representation can not be converted to a boolean value (including structured types like Objects and Arrays), specified defaultValue will be returned; no exceptions are thrown.

        Overrides:
        getValueAsBoolean in class JsonParser
        Throws:
        java.io.IOException
        JsonParseException

      • getValueAsInt

        public int getValueAsInt​(int defaultValue)
                  throws java.io.IOException,
                         JsonParseException
        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 defaultValue will be returned; no exceptions are thrown.

        Overrides:
        getValueAsInt in class JsonParser
        Throws:
        java.io.IOException
        JsonParseException

      • getValueAsLong

        public long getValueAsLong​(long defaultValue)
                    throws java.io.IOException,
                           JsonParseException
        Description copied from class: JsonParser
        Method that will try to convert value of current token to a long. 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 defaultValue will be returned; no exceptions are thrown.

        Overrides:
        getValueAsLong in class JsonParser
        Throws:
        java.io.IOException
        JsonParseException

      • getValueAsDouble

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

        If representation can not be converted to an int (including structured types like Objects and Arrays), specified defaultValue will be returned; no exceptions are thrown.

        Overrides:
        getValueAsDouble in class JsonParser
        Throws:
        java.io.IOException
        JsonParseException

      • _decodeBase64

        protected void _decodeBase64​(java.lang.String str,
                             ByteArrayBuilder builder,
                             Base64Variant b64variant)
                      throws java.io.IOException,
                             JsonParseException
        Helper method that can be used for base64 decoding in cases where encoded content has already been read as a String.
        Throws:
        java.io.IOException
        JsonParseException
        Since:
        1.9.3

      • _reportInvalidBase64

        protected void _reportInvalidBase64​(Base64Variant b64variant,
                                    char ch,
                                    int bindex,
                                    java.lang.String msg)
                             throws JsonParseException
        Parameters:
        bindex - Relative index within base64 character unit; between 0 and 3 (as unit has exactly 4 characters)
        Throws:
        JsonParseException

      • _getCharDesc

        protected static final java.lang.String _getCharDesc​(int ch)

      • _throwInternal

        protected final void _throwInternal()

      • _constructError

        protected final JsonParseException _constructError​(java.lang.String msg,
                                                   java.lang.Throwable t)