XContentParser (Elasticsearch: Core 2.3.5.1 API)

すべてのスーパーインタフェース:

AutoCloseable, Releasable

既知の実装クラスのリスト:

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("{\"key\" : \"value\"}");
 
```

ネストされたクラスのサマリー

ネストされたクラス
修飾子とタイプインタフェースと説明

static class XContentParser.NumberType

static class XContentParser.Token

ネストされたクラス
修飾子とタイプ	インタフェースと説明
`static class`	`XContentParser.NumberType`
`static class`	`XContentParser.Token`

メソッドのサマリー

すべてのメソッドインスタンス・メソッド abstractメソッド
修飾子とタイプ	メソッドと説明
`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 `XContentBuilderString` variants of the separated value methods.
`boolean`	`booleanValue()`
`XContentType`	`contentType()`
`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.
`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()`
`List<Object>`	`list()`
`List<Object>`	`listOrderedMap()`
`long`	`longValue()`
`long`	`longValue(boolean coerce)`
`Map<String,Object>`	`map()`
`Map<String,Object>`	`mapOrdered()`
`XContentParser.Token`	`nextToken()`
`XContentParser.NumberType`	`numberType()`
`Number`	`numberValue()`
`Object`	`objectBytes()`
`Object`	`objectText()`
`short`	`shortValue()`
`short`	`shortValue(boolean coerce)`
`void`	`skipChildren()`
`String`	`text()`
`char[]`	`textCharacters()`
`int`	`textLength()`
`int`	`textOffset()`
`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`.

インタフェースから継承されたメソッド org.elasticsearch.common.lease.Releasable
close

- メソッドの詳細
  - contentType
```
XContentType contentType()
```
  - nextToken
```
XContentParser.Token nextToken()
                        throws IOException
```
    例外:
    
    IOException
  - skipChildren
```
void skipChildren()
           throws IOException
```
    例外:
    
    IOException
  - currentToken
```
XContentParser.Token currentToken()
```
  - currentName
```
String currentName()
            throws IOException
```
    例外:
    
    IOException
  - map
```
Map<String,Object> map()
                throws IOException
```
    例外:
    
    IOException
  - mapOrdered
```
Map<String,Object> mapOrdered()
                       throws IOException
```
    例外:
    
    IOException
  - list
```
List<Object> list()
           throws IOException
```
    例外:
    
    IOException
  - listOrderedMap
```
List<Object> listOrderedMap()
                     throws IOException
```
    例外:
    
    IOException
  - text
```
String text()
     throws IOException
```
    例外:
    
    IOException
  - textOrNull
```
String textOrNull()
           throws IOException
```
    例外:
    
    IOException
  - utf8BytesOrNull
```
org.apache.lucene.util.BytesRef utf8BytesOrNull()
                                         throws 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()
    
    例外:
    
    IOException
  - utf8Bytes
```
org.apache.lucene.util.BytesRef utf8Bytes()
                                   throws IOException
```
    Returns a BytesRef holding UTF-8 bytes. This method should be used to read text only binary content should be read through binaryValue()
    
    例外:
    
    IOException
  - objectText
```
Object objectText()
           throws IOException
```
    例外:
    
    IOException
  - objectBytes
```
Object objectBytes()
            throws IOException
```
    例外:
    
    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 IOException
```
    例外:
    
    IOException
  - textLength
```
int textLength()
        throws IOException
```
    例外:
    
    IOException
  - textOffset
```
int textOffset()
        throws IOException
```
    例外:
    
    IOException
  - numberValue
```
Number numberValue()
            throws IOException
```
    例外:
    
    IOException
  - numberType
```
XContentParser.NumberType numberType()
                              throws IOException
```
    例外:
    
    IOException
  - shortValue
```
short shortValue(boolean coerce)
          throws IOException
```
    例外:
    
    IOException
  - intValue
```
int intValue(boolean coerce)
      throws IOException
```
    例外:
    
    IOException
  - longValue
```
long longValue(boolean coerce)
        throws IOException
```
    例外:
    
    IOException
  - floatValue
```
float floatValue(boolean coerce)
          throws IOException
```
    例外:
    
    IOException
  - doubleValue
```
double doubleValue(boolean coerce)
            throws IOException
```
    例外:
    
    IOException
  - shortValue
```
short shortValue()
          throws IOException
```
    例外:
    
    IOException
  - intValue
```
int intValue()
      throws IOException
```
    例外:
    
    IOException
  - longValue
```
long longValue()
        throws IOException
```
    例外:
    
    IOException
  - floatValue
```
float floatValue()
          throws IOException
```
    例外:
    
    IOException
  - doubleValue
```
double doubleValue()
            throws IOException
```
    例外:
    
    IOException
  - isBooleanValue
```
boolean isBooleanValue()
                throws 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"
    
    例外:
    
    IOException
  - booleanValue
```
boolean booleanValue()
              throws IOException
```
    例外:
    
    IOException
  - binaryValue
```
byte[] binaryValue()
            throws IOException
```
    Reads a plain binary value that was written via one of the following methods:
    as well as via their XContentBuilderString variants of the separated value methods. Note: Do not use this method to read values written with:
    - XContentBuilder.utf8Field(XContentBuilderString, 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() ()}}
    例外:
    
    IOException
  - getTokenLocation
```
XContentLocation getTokenLocation()
```
    Used for error reporting to highlight where syntax errors occur in content being parsed.
    
    戻り値:
    
    last token's location or null if cannot be determined
  - isClosed
```
boolean isClosed()
```

インタフェース XContentParser

ネストされたクラスのサマリー

メソッドのサマリー

インタフェースから継承されたメソッド org.elasticsearch.common.lease.Releasable

メソッドの詳細

contentType

nextToken

skipChildren

currentToken

currentName

map

mapOrdered

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

isClosed