org.elasticsearch.common.xcontent.json

Class JsonXContentParser

java.lang.Object

org.elasticsearch.common.xcontent.support.AbstractXContentParser

org.elasticsearch.common.xcontent.json.JsonXContentParser

All Implemented Interfaces:

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

Direct Known Subclasses:

CborXContentParser, SmileXContentParser, YamlXContentParser

public class JsonXContentParser
extends AbstractXContentParser

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.XContentParser

XContentParser.NumberType, XContentParser.Token

Field Summary

Fields inherited from class org.elasticsearch.common.xcontent.support.AbstractXContentParser

DEFAULT_NUMBER_COERCE_POLICY

Constructor Summary

Constructors

Constructor and Description
JsonXContentParser(NamedXContentRegistry xContentRegistry, com.fasterxml.jackson.core.JsonParser parser)

Method Summary

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.
void	close()
XContentType	contentType()
java.lang.String	currentName()
XContentParser.Token	currentToken()
protected boolean	doBooleanValue()
double	doDoubleValue()
float	doFloatValue()
int	doIntValue()
long	doLongValue()
short	doShortValue()
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.
boolean	isClosed()
XContentParser.Token	nextToken()
XContentParser.NumberType	numberType()
java.lang.Number	numberValue()
java.lang.Object	objectBytes()
java.lang.Object	objectText()
void	skipChildren()
java.lang.String	text()
char[]	textCharacters()
int	textLength()
int	textOffset()
org.apache.lucene.util.BytesRef	utf8Bytes() Returns a BytesRef holding UTF-8 bytes.

Methods inherited from class org.elasticsearch.common.xcontent.support.AbstractXContentParser

booleanValue, doubleValue, doubleValue, floatValue, floatValue, getXContentRegistry, intValue, intValue, isBooleanValue, list, listOrderedMap, longValue, longValue, map, mapOrdered, mapStrings, mapStringsOrdered, namedObject, shortValue, shortValue, textOrNull, utf8BytesOrNull

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JsonXContentParser

public JsonXContentParser(NamedXContentRegistry xContentRegistry,
                          com.fasterxml.jackson.core.JsonParser parser)

Method Detail

contentType

public XContentType contentType()

nextToken

public XContentParser.Token nextToken()
                               throws java.io.IOException

Throws:

java.io.IOException

skipChildren

public void skipChildren()
                  throws java.io.IOException

Throws:

java.io.IOException

currentToken

public XContentParser.Token currentToken()

numberType

public XContentParser.NumberType numberType()
                                     throws java.io.IOException

Throws:

java.io.IOException

currentName

public java.lang.String currentName()
                             throws java.io.IOException

Throws:

java.io.IOException

doBooleanValue

protected boolean doBooleanValue()
                          throws java.io.IOException

Specified by:

doBooleanValue in class AbstractXContentParser

Throws:

java.io.IOException

text

public java.lang.String text()
                      throws java.io.IOException

Throws:

java.io.IOException

utf8Bytes

public org.apache.lucene.util.BytesRef utf8Bytes()
                                          throws java.io.IOException

Description copied from interface: XContentParser

Returns a BytesRef holding UTF-8 bytes. This method should be used to read text only binary content should be read through XContentParser.binaryValue()

Throws:

java.io.IOException

objectText

public java.lang.Object objectText()
                            throws java.io.IOException

Throws:

java.io.IOException

objectBytes

public java.lang.Object objectBytes()
                             throws java.io.IOException

Throws:

java.io.IOException

hasTextCharacters

public boolean hasTextCharacters()

Description copied from interface: XContentParser

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

public char[] textCharacters()
                      throws java.io.IOException

Throws:

java.io.IOException

textLength

public int textLength()
               throws java.io.IOException

Throws:

java.io.IOException

textOffset

public int textOffset()
               throws java.io.IOException

Throws:

java.io.IOException

numberValue

public java.lang.Number numberValue()
                             throws java.io.IOException

Throws:

java.io.IOException

doShortValue

public short doShortValue()
                   throws java.io.IOException

Specified by:

doShortValue in class AbstractXContentParser

Throws:

java.io.IOException

doIntValue

public int doIntValue()
               throws java.io.IOException

Specified by:

doIntValue in class AbstractXContentParser

Throws:

java.io.IOException

doLongValue

public long doLongValue()
                 throws java.io.IOException

Specified by:

doLongValue in class AbstractXContentParser

Throws:

java.io.IOException

doFloatValue

public float doFloatValue()
                   throws java.io.IOException

Specified by:

doFloatValue in class AbstractXContentParser

Throws:

java.io.IOException

doDoubleValue

public double doDoubleValue()
                     throws java.io.IOException

Specified by:

doDoubleValue in class AbstractXContentParser

Throws:

java.io.IOException

binaryValue

public byte[] binaryValue()
                   throws java.io.IOException

Description copied from interface: XContentParser

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. 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:

• XContentParser.utf8Bytes()
• XContentParser.utf8BytesOrNull()}
• XContentParser.text() ()}
• XContentParser.textOrNull() ()}
• XContentParser.textCharacters() ()}}

Throws:

java.io.IOException

getTokenLocation

public XContentLocation getTokenLocation()

Description copied from interface: XContentParser

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

close

public void close()

isClosed

public boolean isClosed()

Specified by:

isClosed in interface XContentParser

Specified by:

isClosed in class AbstractXContentParser