Interface XContentParser

    • Method Detail

      • nextToken

        XContentParser.Token nextToken()
                                throws java.io.IOException
        Throws:
        java.io.IOException
      • skipChildren

        void skipChildren()
                   throws java.io.IOException
        Throws:
        java.io.IOException
      • currentName

        java.lang.String currentName()
                              throws java.io.IOException
        Throws:
        java.io.IOException
      • map

        java.util.Map<java.lang.String,​java.lang.Object> map()
                                                            throws java.io.IOException
        Throws:
        java.io.IOException
      • mapOrdered

        java.util.Map<java.lang.String,​java.lang.Object> mapOrdered()
                                                                   throws java.io.IOException
        Throws:
        java.io.IOException
      • mapStrings

        java.util.Map<java.lang.String,​java.lang.String> mapStrings()
                                                                   throws java.io.IOException
        Throws:
        java.io.IOException
      • mapStringsOrdered

        java.util.Map<java.lang.String,​java.lang.String> mapStringsOrdered()
                                                                          throws java.io.IOException
        Throws:
        java.io.IOException
      • list

        java.util.List<java.lang.Object> list()
                                       throws java.io.IOException
        Throws:
        java.io.IOException
      • listOrderedMap

        java.util.List<java.lang.Object> listOrderedMap()
                                                 throws java.io.IOException
        Throws:
        java.io.IOException
      • text

        java.lang.String text()
                       throws java.io.IOException
        Throws:
        java.io.IOException
      • textOrNull

        java.lang.String textOrNull()
                             throws java.io.IOException
        Throws:
        java.io.IOException
      • charBufferOrNull

        java.nio.CharBuffer charBufferOrNull()
                                      throws java.io.IOException
        Throws:
        java.io.IOException
      • charBuffer

        java.nio.CharBuffer charBuffer()
                                throws java.io.IOException
        Returns a CharBuffer holding UTF-8 bytes. This method should be used to read text only binary content should be read through binaryValue()
        Throws:
        java.io.IOException
      • objectText

        java.lang.Object objectText()
                             throws java.io.IOException
        Throws:
        java.io.IOException
      • objectBytes

        java.lang.Object objectBytes()
                              throws java.io.IOException
        Throws:
        java.io.IOException
      • hasTextCharacters

        boolean hasTextCharacters()
        Method that can be used to determine whether calling of textCharacters() 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. This method shouldn't be used to check if the token contains text or not.
      • textCharacters

        char[] textCharacters()
                       throws java.io.IOException
        Throws:
        java.io.IOException
      • textLength

        int textLength()
                throws java.io.IOException
        Throws:
        java.io.IOException
      • textOffset

        int textOffset()
                throws java.io.IOException
        Throws:
        java.io.IOException
      • numberValue

        java.lang.Number numberValue()
                              throws java.io.IOException
        Throws:
        java.io.IOException
      • shortValue

        short shortValue​(boolean coerce)
                  throws java.io.IOException
        Throws:
        java.io.IOException
      • intValue

        int intValue​(boolean coerce)
              throws java.io.IOException
        Throws:
        java.io.IOException
      • longValue

        long longValue​(boolean coerce)
                throws java.io.IOException
        Throws:
        java.io.IOException
      • floatValue

        float floatValue​(boolean coerce)
                  throws java.io.IOException
        Throws:
        java.io.IOException
      • doubleValue

        double doubleValue​(boolean coerce)
                    throws java.io.IOException
        Throws:
        java.io.IOException
      • shortValue

        short shortValue()
                  throws java.io.IOException
        Throws:
        java.io.IOException
      • intValue

        int intValue()
              throws java.io.IOException
        Throws:
        java.io.IOException
      • longValue

        long longValue()
                throws java.io.IOException
        Throws:
        java.io.IOException
      • floatValue

        float floatValue()
                  throws java.io.IOException
        Throws:
        java.io.IOException
      • doubleValue

        double doubleValue()
                    throws java.io.IOException
        Throws:
        java.io.IOException
      • isBooleanValue

        boolean isBooleanValue()
                        throws java.io.IOException
        Returns:
        true iff the current value is either boolean (true or false) or one of "false", "true".
        Throws:
        java.io.IOException
      • booleanValue

        boolean booleanValue()
                      throws java.io.IOException
        Throws:
        java.io.IOException
      • isBooleanValueLenient

        @Deprecated
        boolean isBooleanValueLenient()
                               throws java.io.IOException
        Deprecated.
        Just present for providing backwards compatibility. Use isBooleanValue() instead.
        returns true if the current value is boolean in nature. values that are considered booleans: - boolean value (true/false) - numeric integers (=0 is considered as false, !=0 is true) - one of the following strings: "true","false","on","off","yes","no","1","0"
        Throws:
        java.io.IOException
      • booleanValueLenient

        @Deprecated
        boolean booleanValueLenient()
                             throws java.io.IOException
        Deprecated.
        Just present for providing backwards compatibility. Use booleanValue() instead.
        Throws:
        java.io.IOException
      • getTokenLocation

        XContentLocation getTokenLocation()
        Used for error reporting to highlight where syntax errors occur in content being parsed.
        Returns:
        last token's location or null if cannot be determined
      • namedObject

        <T> T namedObject​(java.lang.Class<T> categoryClass,
                          java.lang.String name,
                          java.lang.Object context)
                   throws java.io.IOException
        Parse an object by name.
        Throws:
        java.io.IOException
      • isClosed

        boolean isClosed()
      • getDeprecationHandler

        DeprecationHandler getDeprecationHandler()
        The callback to notify when parsing encounters a deprecated field.