Package org.codehaus.jackson.util

Class JsonParserDelegate

  • All Implemented Interfaces:
    java.io.Closeable, java.lang.AutoCloseable, Versioned
    Direct Known Subclasses:
    JsonParserSequence
    public class JsonParserDelegate
extends JsonParser
    Helper class that implements delegation pattern for JsonParser, to allow for simple overridability of basic parsing functionality. The idea is that any functionality to be modified can be simply overridden; and anything else will be delegated by default.
    Since:
    1.4

    • Field Detail

      • delegate

        protected JsonParser delegate
        Delegate object that method calls are delegated to.

    • Constructor Detail

      • JsonParserDelegate

        public JsonParserDelegate​(JsonParser d)

    • Method Detail

      • setSchema

        public void setSchema​(FormatSchema schema)
        Description copied from class: JsonParser
        Method to call to make this parser use specified schema. Method must be called before trying to parse any content, right after parser instance has been created. Note that not all parsers support schemas; and those that do usually only accept specific types of schemas: ones defined for data format parser can read.

        If parser does not support specified schema, UnsupportedOperationException is thrown.

        Overrides:
        setSchema in class JsonParser
        Parameters:
        schema - Schema to use

      • version

        public Version version()
        Description copied from interface: Versioned
        Method called to detect version of the component that implements this interface; returned version should never be null, but may return specific "not available" instance (see Version for details).
        Specified by:
        version in interface Versioned
        Overrides:
        version in class JsonParser

      • 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

      • close

        public 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 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

      • getCurrentToken

        public JsonToken getCurrentToken()
        Description copied from class: JsonParser
        Accessor to find which token parser currently points to, if any; null will be returned if none. If return value is non-null, data associated with the token is available via other accessor methods.
        Overrides:
        getCurrentToken in class JsonParser
        Returns:
        Type of the token this parser currently points to, if any: null before any tokens have been read, and after end-of-input has been encountered, as well as if the current token has been explicitly cleared.

      • hasCurrentToken

        public boolean hasCurrentToken()
        Description copied from class: JsonParser
        Method for checking whether parser currently points to a token (and data for that token is available). Equivalent to check for parser.getCurrentToken() != null.
        Overrides:
        hasCurrentToken in class JsonParser
        Returns:
        True if the parser just returned a valid token via JsonParser.nextToken(); false otherwise (parser was just constructed, encountered end-of-input and returned null from JsonParser.nextToken(), or the token has been consumed)

      • getCurrentLocation

        public JsonLocation getCurrentLocation()
        Description copied from class: JsonParser
        Method that returns location of the last processed character; usually for error reporting purposes.
        Specified by:
        getCurrentLocation in class JsonParser

      • getParsingContext

        public 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 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 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

      • getNumberValue

        public java.lang.Number getNumberValue()
                                throws java.io.IOException,
                                       JsonParseException
        Description copied from class: JsonParser
        Generic number value accessor method that will work for all kinds of numeric values. It will return the optimal (simplest/smallest possible) wrapper object that can express the numeric value just parsed.
        Specified by:
        getNumberValue in class JsonParser
        Throws:
        java.io.IOException
        JsonParseException

      • getBinaryValue

        public 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

      • getEmbeddedObject

        public java.lang.Object getEmbeddedObject()
                                   throws java.io.IOException,
                                          JsonParseException
        Description copied from class: JsonParser
        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).

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

      • getTokenLocation

        public JsonLocation getTokenLocation()
        Description copied from class: JsonParser
        Method that return the starting location of the current token; that is, position of the first character from input that starts the current token.
        Specified by:
        getTokenLocation in class JsonParser

      • nextToken

        public 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