org.elasticsearch.common.xcontent.support

Class AbstractXContentParser

java.lang.Object

org.elasticsearch.common.xcontent.support.AbstractXContentParser

All Implemented Interfaces:

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

Direct Known Subclasses:

JsonXContentParser

public abstract class AbstractXContentParser
extends java.lang.Object
implements XContentParser

Nested Class Summary

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

XContentParser.NumberType, XContentParser.Token

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_NUMBER_COERCE_POLICY

Constructor Summary

Constructors

Constructor and Description
AbstractXContentParser(NamedXContentRegistry xContentRegistry)

Method Summary

Modifier and Type	Method and Description
boolean	booleanValue()
protected abstract boolean	doBooleanValue()
protected abstract double	doDoubleValue()
protected abstract float	doFloatValue()
protected abstract int	doIntValue()
protected abstract long	doLongValue()
protected abstract short	doShortValue()
double	doubleValue()
double	doubleValue(boolean coerce)
float	floatValue()
float	floatValue(boolean coerce)
NamedXContentRegistry	getXContentRegistry() The registry used to resolve XContentParser.namedObject(Class, String, Object).
int	intValue()
int	intValue(boolean coerce)
boolean	isBooleanValue() returns true if the current value is boolean in nature.
abstract 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.
short	shortValue()
short	shortValue(boolean coerce)
java.lang.String	textOrNull()
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 class java.lang.Object

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

Methods inherited from interface org.elasticsearch.common.xcontent.XContentParser

binaryValue, contentType, currentName, currentToken, getTokenLocation, hasTextCharacters, nextToken, numberType, numberValue, objectBytes, objectText, skipChildren, text, textCharacters, textLength, textOffset, utf8Bytes

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

close

Field Detail

DEFAULT_NUMBER_COERCE_POLICY

public static final boolean DEFAULT_NUMBER_COERCE_POLICY

See Also:

Constant Field Values

Constructor Detail

AbstractXContentParser

public AbstractXContentParser(NamedXContentRegistry xContentRegistry)

Method Detail

isBooleanValue

public boolean isBooleanValue()
                       throws java.io.IOException

Description copied from interface: XContentParser

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"

Specified by:

isBooleanValue in interface XContentParser

Throws:

java.io.IOException

booleanValue

public boolean booleanValue()
                     throws java.io.IOException

Specified by:

booleanValue in interface XContentParser

Throws:

java.io.IOException

doBooleanValue

protected abstract boolean doBooleanValue()
                                   throws java.io.IOException

Throws:

java.io.IOException

shortValue

public short shortValue()
                 throws java.io.IOException

Specified by:

shortValue in interface XContentParser

Throws:

java.io.IOException

shortValue

public short shortValue(boolean coerce)
                 throws java.io.IOException

Specified by:

shortValue in interface XContentParser

Throws:

java.io.IOException

doShortValue

protected abstract short doShortValue()
                               throws java.io.IOException

Throws:

java.io.IOException

intValue

public int intValue()
             throws java.io.IOException

Specified by:

intValue in interface XContentParser

Throws:

java.io.IOException

intValue

public int intValue(boolean coerce)
             throws java.io.IOException

Specified by:

intValue in interface XContentParser

Throws:

java.io.IOException

doIntValue

protected abstract int doIntValue()
                           throws java.io.IOException

Throws:

java.io.IOException

longValue

public long longValue()
               throws java.io.IOException

Specified by:

longValue in interface XContentParser

Throws:

java.io.IOException

longValue

public long longValue(boolean coerce)
               throws java.io.IOException

Specified by:

longValue in interface XContentParser

Throws:

java.io.IOException

doLongValue

protected abstract long doLongValue()
                             throws java.io.IOException

Throws:

java.io.IOException

floatValue

public float floatValue()
                 throws java.io.IOException

Specified by:

floatValue in interface XContentParser

Throws:

java.io.IOException

floatValue

public float floatValue(boolean coerce)
                 throws java.io.IOException

Specified by:

floatValue in interface XContentParser

Throws:

java.io.IOException

doFloatValue

protected abstract float doFloatValue()
                               throws java.io.IOException

Throws:

java.io.IOException

doubleValue

public double doubleValue()
                   throws java.io.IOException

Specified by:

doubleValue in interface XContentParser

Throws:

java.io.IOException

doubleValue

public double doubleValue(boolean coerce)
                   throws java.io.IOException

Specified by:

doubleValue in interface XContentParser

Throws:

java.io.IOException

doDoubleValue

protected abstract double doDoubleValue()
                                 throws java.io.IOException

Throws:

java.io.IOException

textOrNull

public final java.lang.String textOrNull()
                                  throws java.io.IOException

Specified by:

textOrNull in interface XContentParser

Throws:

java.io.IOException

utf8BytesOrNull

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

Description copied from interface: XContentParser

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 XContentParser.binaryValue()

Specified by:

utf8BytesOrNull in interface XContentParser

Throws:

java.io.IOException

map

public java.util.Map<java.lang.String,java.lang.Object> map()
                                                     throws java.io.IOException

Specified by:

map in interface XContentParser

Throws:

java.io.IOException

mapOrdered

public java.util.Map<java.lang.String,java.lang.Object> mapOrdered()
                                                            throws java.io.IOException

Specified by:

mapOrdered in interface XContentParser

Throws:

java.io.IOException

mapStrings

public java.util.Map<java.lang.String,java.lang.String> mapStrings()
                                                            throws java.io.IOException

Specified by:

mapStrings in interface XContentParser

Throws:

java.io.IOException

mapStringsOrdered

public java.util.Map<java.lang.String,java.lang.String> mapStringsOrdered()
                                                                   throws java.io.IOException

Specified by:

mapStringsOrdered in interface XContentParser

Throws:

java.io.IOException

list

public java.util.List<java.lang.Object> list()
                                      throws java.io.IOException

Specified by:

list in interface XContentParser

Throws:

java.io.IOException

listOrderedMap

public java.util.List<java.lang.Object> listOrderedMap()
                                                throws java.io.IOException

Specified by:

listOrderedMap in interface XContentParser

Throws:

java.io.IOException

namedObject

public <T> T namedObject(java.lang.Class<T> categoryClass,
                         java.lang.String name,
                         java.lang.Object context)
                  throws java.io.IOException

Description copied from interface: XContentParser

Parse an object by name.

Specified by:

namedObject in interface XContentParser

Throws:

java.io.IOException

getXContentRegistry

public NamedXContentRegistry getXContentRegistry()

Description copied from interface: XContentParser

The registry used to resolve XContentParser.namedObject(Class, String, Object). Use this when building a sub-parser from this parser.

Specified by:

getXContentRegistry in interface XContentParser

isClosed

public abstract boolean isClosed()

Specified by:

isClosed in interface XContentParser