Package org.elasticsearch.common.xcontent.support

Class MapXContentParser

java.lang.Object

org.elasticsearch.common.xcontent.support.AbstractXContentParser

org.elasticsearch.common.xcontent.support.MapXContentParser

All Implemented Interfaces:

Closeable, AutoCloseable, XContentParser

public class MapXContentParser
extends AbstractXContentParser

Wraps a map generated by XContentParser's map() method into XContent Parser

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	Description
MapXContentParser(NamedXContentRegistry xContentRegistry, DeprecationHandler deprecationHandler, Map<String,Object> map, XContentType xContentType)

Method Summary

Modifier and Type	Method	Description
byte[]	binaryValue()	Reads a plain binary value that was written via one of the following methods: XContentBuilder.field(String, byte[], int, int)} XContentBuilder.field(String, byte[])} as well as via their String variants of the separated value methods.
CharBuffer	charBuffer()	Returns a CharBuffer holding UTF-8 bytes.
void	close()
XContentType	contentType()
String	currentName()
XContentParser.Token	currentToken()
protected boolean	doBooleanValue()
protected double	doDoubleValue()
protected float	doFloatValue()
protected int	doIntValue()
protected long	doLongValue()
protected 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()
Number	numberValue()
Object	objectBytes()
Object	objectText()
void	skipChildren()
String	text()
char[]	textCharacters()
int	textLength()
int	textOffset()

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

booleanValue, charBufferOrNull, doubleValue, doubleValue, floatValue, floatValue, getDeprecationHandler, getXContentRegistry, intValue, intValue, isBooleanValue, list, listOrderedMap, longValue, longValue, map, map, mapOrdered, mapStrings, namedObject, readValue, shortValue, shortValue, textOrNull

Methods inherited from class java.lang.Object

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

Constructor Detail

MapXContentParser

public MapXContentParser(NamedXContentRegistry xContentRegistry,
                         DeprecationHandler deprecationHandler,
                         Map<String,Object> map,
                         XContentType xContentType)

Method Detail

doBooleanValue

protected boolean doBooleanValue()
                          throws IOException

Specified by:

doBooleanValue in class AbstractXContentParser

Throws:

IOException

doShortValue

protected short doShortValue()
                      throws IOException

Specified by:

doShortValue in class AbstractXContentParser

Throws:

IOException

doIntValue

protected int doIntValue()
                  throws IOException

Specified by:

doIntValue in class AbstractXContentParser

Throws:

IOException

doLongValue

protected long doLongValue()
                    throws IOException

Specified by:

doLongValue in class AbstractXContentParser

Throws:

IOException

doFloatValue

protected float doFloatValue()
                      throws IOException

Specified by:

doFloatValue in class AbstractXContentParser

Throws:

IOException

doDoubleValue

protected double doDoubleValue()
                        throws IOException

Specified by:

doDoubleValue in class AbstractXContentParser

Throws:

IOException

contentType

public XContentType contentType()

nextToken

public XContentParser.Token nextToken()
                               throws IOException

Throws:

IOException

skipChildren

public void skipChildren()
                  throws IOException

Throws:

IOException

currentToken

public XContentParser.Token currentToken()

currentName

public String currentName()
                   throws IOException

Throws:

IOException

text

public String text()
            throws IOException

Throws:

IOException

charBuffer

public CharBuffer charBuffer()
                      throws IOException

Description copied from interface: XContentParser

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

Throws:

IOException

objectText

public Object objectText()
                  throws IOException

Throws:

IOException

objectBytes

public Object objectBytes()
                   throws IOException

Throws:

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 IOException

Throws:

IOException

textLength

public int textLength()
               throws IOException

Throws:

IOException

textOffset

public int textOffset()
               throws IOException

Throws:

IOException

numberValue

public Number numberValue()
                   throws IOException

Throws:

IOException

numberType

public XContentParser.NumberType numberType()
                                     throws IOException

Throws:

IOException

binaryValue

public byte[] binaryValue()
                   throws IOException

Description copied from interface: XContentParser

Reads a plain binary value that was written via one of the following methods:

• 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.utf8Value(byte[], int, int)

these methods write UTF-8 encoded strings and must be read through:

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

Throws:

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

isClosed

public boolean isClosed()

Specified by:

isClosed in interface XContentParser

Specified by:

isClosed in class AbstractXContentParser

close

public void close()
           throws IOException

Throws:

IOException