XContentParser (core 5.3.3 API)

All Superinterfaces:

java.lang.AutoCloseable, java.io.Closeable, Releasable

All Known Implementing Classes:

AbstractXContentParser, CborXContentParser, JsonXContentParser, SmileXContentParser, YamlXContentParser
```
public interface XContentParser
extends Releasable
```
Interface for pull - parsing XContent see XContentType for supported types. To obtain an instance of this class use the following pattern:
```
     XContentType xContentType = XContentType.JSON;
     XContentParser parser = xContentType.xContent().createParser(NamedXContentRegistry.EMPTY, "{\"key\" : \"value\"}");
 
```

Nested Class Summary

Nested Classes
Modifier and Type Interface and Description

static class XContentParser.NumberType

static class XContentParser.Token

Nested Classes
Modifier and Type	Interface and Description
`static class`	`XContentParser.NumberType`
`static class`	`XContentParser.Token`

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`byte[]`	`binaryValue()` Reads a plain binary value that was written via one of the following methods: `XContentBuilder.field(String, org.apache.lucene.util.BytesRef)` `XContentBuilder.field(String, org.elasticsearch.common.bytes.BytesReference)` `XContentBuilder.field(String, byte[], int, int)`} `XContentBuilder.field(String, byte[])`} as well as via their `String` variants of the separated value methods.
`boolean`	`booleanValue()`
`XContentType`	`contentType()`
`java.lang.String`	`currentName()`
`XContentParser.Token`	`currentToken()`
`double`	`doubleValue()`
`double`	`doubleValue(boolean coerce)`
`float`	`floatValue()`
`float`	`floatValue(boolean coerce)`
`XContentLocation`	`getTokenLocation()` Used for error reporting to highlight where syntax errors occur in content being parsed.
`NamedXContentRegistry`	`getXContentRegistry()` The registry used to resolve `namedObject(Class, String, Object)`.
`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.
`int`	`intValue()`
`int`	`intValue(boolean coerce)`
`boolean`	`isBooleanValue()` returns true if the current value is boolean in nature.
`boolean`	`isClosed()`
`java.util.List<java.lang.Object>`	`list()`
`java.util.List<java.lang.Object>`	`listOrderedMap()`
`long`	`longValue()`
`long`	`longValue(boolean coerce)`
`java.util.Map<java.lang.String,java.lang.Object>`	`map()`
`java.util.Map<java.lang.String,java.lang.Object>`	`mapOrdered()`
`java.util.Map<java.lang.String,java.lang.String>`	`mapStrings()`
`java.util.Map<java.lang.String,java.lang.String>`	`mapStringsOrdered()`
`<T> T`	`namedObject(java.lang.Class<T> categoryClass, java.lang.String name, java.lang.Object context)` Parse an object by name.
`XContentParser.Token`	`nextToken()`
`XContentParser.NumberType`	`numberType()`
`java.lang.Number`	`numberValue()`
`java.lang.Object`	`objectBytes()`
`java.lang.Object`	`objectText()`
`short`	`shortValue()`
`short`	`shortValue(boolean coerce)`
`void`	`skipChildren()`
`java.lang.String`	`text()`
`char[]`	`textCharacters()`
`int`	`textLength()`
`int`	`textOffset()`
`java.lang.String`	`textOrNull()`
`org.apache.lucene.util.BytesRef`	`utf8Bytes()` Returns a BytesRef holding UTF-8 bytes.
`org.apache.lucene.util.BytesRef`	`utf8BytesOrNull()` Returns a BytesRef holding UTF-8 bytes or null if a null value is `XContentParser.Token.VALUE_NULL`.

Methods inherited from interface org.elasticsearch.common.lease.Releasable
close

- Method Detail
  - contentType
```
XContentType contentType()
```
  - nextToken
```
XContentParser.Token nextToken()
                        throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - skipChildren
```
void skipChildren()
           throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - currentToken
```
XContentParser.Token currentToken()
```
  - 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
  - utf8BytesOrNull
```
org.apache.lucene.util.BytesRef utf8BytesOrNull()
                                         throws java.io.IOException
```
    Returns a BytesRef holding UTF-8 bytes or null if a null value is XContentParser.Token.VALUE_NULL. This method should be used to read text only binary content should be read through binaryValue()
    
    Throws:
    
    java.io.IOException
  - utf8Bytes
```
org.apache.lucene.util.BytesRef utf8Bytes()
                                   throws java.io.IOException
```
    Returns a BytesRef 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
  - numberType
```
XContentParser.NumberType numberType()
                              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 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
  - booleanValue
```
boolean booleanValue()
              throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - binaryValue
```
byte[] binaryValue()
            throws java.io.IOException
```
    Reads a plain binary value that was written via one of the following methods:
    as well as via their String variants of the separated value methods. Note: Do not use this method to read values written with:
    - XContentBuilder.utf8Field(String, org.apache.lucene.util.BytesRef)
    - XContentBuilder.utf8Field(String, org.apache.lucene.util.BytesRef)
    these methods write UTF-8 encoded strings and must be read through:
    - utf8Bytes()
    - utf8BytesOrNull()}
    - text() ()}
    - textOrNull() ()}
    - textCharacters() ()}}
    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
  - getXContentRegistry
```
NamedXContentRegistry getXContentRegistry()
```
    The registry used to resolve namedObject(Class, String, Object). Use this when building a sub-parser from this parser.
  - isClosed
```
boolean isClosed()
```

Interface XContentParser

Nested Class Summary

Method Summary

Methods inherited from interface org.elasticsearch.common.lease.Releasable

Method Detail

contentType

nextToken

skipChildren

currentToken

currentName

map

mapOrdered

mapStrings

mapStringsOrdered

list

listOrderedMap

text

textOrNull

utf8BytesOrNull

utf8Bytes

objectText

objectBytes

hasTextCharacters

textCharacters

textLength

textOffset

numberValue

numberType

shortValue

intValue

longValue

floatValue

doubleValue

shortValue

intValue

longValue

floatValue

doubleValue

isBooleanValue

booleanValue

binaryValue

getTokenLocation

namedObject

getXContentRegistry

isClosed