Package org.opensearch.core.xcontent

Class AbstractXContentParser

java.lang.Object

org.opensearch.core.xcontent.AbstractXContentParser

All Implemented Interfaces:

Closeable, AutoCloseable, XContentParser

Direct Known Subclasses:

MapXContentParser

public abstract class AbstractXContentParser
extends Object
implements XContentParser

Base class for parsing serializable content

Opensearch.internal:

Nested Class Summary

Nested classes/interfaces inherited from interface org.opensearch.core.xcontent.XContentParser

XContentParser.NumberType, XContentParser.Token

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_NUMBER_COERCE_POLICY

Constructor Summary

Constructors

Constructor	Description
AbstractXContentParser(NamedXContentRegistry xContentRegistry, DeprecationHandler deprecationHandler)

Method Summary

Modifier and Type	Method	Description
BigInteger	bigIntegerValue()
BigInteger	bigIntegerValue(boolean coerce)
boolean	booleanValue()
CharBuffer	charBufferOrNull()
protected abstract BigInteger	doBigIntegerValue()
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)
DeprecationHandler	getDeprecationHandler()	The callback to notify when parsing encounters a deprecated field.
NamedXContentRegistry	getXContentRegistry()	The registry used to resolve XContentParser.namedObject(Class, String, Object).
int	intValue()
int	intValue(boolean coerce)
boolean	isBooleanValue()
abstract boolean	isClosed()
List<Object>	list()
List<Object>	listOrderedMap()
long	longValue()
long	longValue(boolean coerce)
Map<String,Object>	map()
<T> Map<String,T>	map(Supplier<Map<String,T>> mapFactory, org.opensearch.common.CheckedFunction<XContentParser,T,IOException> mapValueParser)	Returns an instance of Map holding parsed map.
Map<String,Object>	mapOrdered()
Map<String,String>	mapStrings()
<T> T	namedObject(Class<T> categoryClass, String name, Object context)	Parse an object by name.
static Object	readValue(XContentParser parser, Supplier<Map<String,Object>> mapFactory)
short	shortValue()
short	shortValue(boolean coerce)
final String	textOrNull()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.io.Closeable

close

Methods inherited from interface org.opensearch.core.xcontent.XContentParser

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

Field Details

DEFAULT_NUMBER_COERCE_POLICY

public static final boolean DEFAULT_NUMBER_COERCE_POLICY

See Also:

• Constant Field Values

Constructor Details

AbstractXContentParser

public AbstractXContentParser(NamedXContentRegistry xContentRegistry,
 DeprecationHandler deprecationHandler)

Method Details

isBooleanValue

public boolean isBooleanValue()
                       throws IOException

Specified by:

isBooleanValue in interface XContentParser

Returns:

true iff the current value is either boolean (true or false) or one of "false", "true".

Throws:

IOException

booleanValue

public boolean booleanValue()
                     throws IOException

Specified by:

booleanValue in interface XContentParser

Throws:

IOException

doBooleanValue

protected abstract boolean doBooleanValue()
                                   throws IOException

Throws:

IOException

shortValue

public short shortValue()
                 throws IOException

Specified by:

shortValue in interface XContentParser

Throws:

IOException

shortValue

public short shortValue(boolean coerce)
                 throws IOException

Specified by:

shortValue in interface XContentParser

Throws:

IOException

doShortValue

protected abstract short doShortValue()
                               throws IOException

Throws:

IOException

intValue

public int intValue()
             throws IOException

Specified by:

intValue in interface XContentParser

Throws:

IOException

intValue

public int intValue(boolean coerce)
             throws IOException

Specified by:

intValue in interface XContentParser

Throws:

IOException

doIntValue

protected abstract int doIntValue()
                           throws IOException

Throws:

IOException

longValue

public long longValue()
               throws IOException

Specified by:

longValue in interface XContentParser

Throws:

IOException

longValue

public long longValue(boolean coerce)
               throws IOException

Specified by:

longValue in interface XContentParser

Throws:

IOException

doLongValue

protected abstract long doLongValue()
                             throws IOException

Throws:

IOException

floatValue

public float floatValue()
                 throws IOException

Specified by:

floatValue in interface XContentParser

Throws:

IOException

floatValue

public float floatValue(boolean coerce)
                 throws IOException

Specified by:

floatValue in interface XContentParser

Throws:

IOException

doFloatValue

protected abstract float doFloatValue()
                               throws IOException

Throws:

IOException

doubleValue

public double doubleValue()
                   throws IOException

Specified by:

doubleValue in interface XContentParser

Throws:

IOException

doubleValue

public double doubleValue(boolean coerce)
                   throws IOException

Specified by:

doubleValue in interface XContentParser

Throws:

IOException

doDoubleValue

protected abstract double doDoubleValue()
                                 throws IOException

Throws:

IOException

bigIntegerValue

public BigInteger bigIntegerValue()
                           throws IOException

Specified by:

bigIntegerValue in interface XContentParser

Throws:

IOException

bigIntegerValue

public BigInteger bigIntegerValue(boolean coerce)
                           throws IOException

Specified by:

bigIntegerValue in interface XContentParser

Throws:

IOException

doBigIntegerValue

protected abstract BigInteger doBigIntegerValue()
                                         throws IOException

Throws:

IOException

textOrNull

public final String textOrNull()
                        throws IOException

Specified by:

textOrNull in interface XContentParser

Throws:

IOException

charBufferOrNull

public CharBuffer charBufferOrNull()
                            throws IOException

Specified by:

charBufferOrNull in interface XContentParser

Throws:

IOException

map

public Map<String,Object> map()
                       throws IOException

Specified by:

map in interface XContentParser

Throws:

IOException

mapOrdered

public Map<String,Object> mapOrdered()
                              throws IOException

Specified by:

mapOrdered in interface XContentParser

Throws:

IOException

mapStrings

public Map<String,String> mapStrings()
                              throws IOException

Specified by:

mapStrings in interface XContentParser

Throws:

IOException

map

public <T> Map<String,T> map(Supplier<Map<String,T>> mapFactory,
 org.opensearch.common.CheckedFunction<XContentParser,T,IOException> mapValueParser)
                      throws IOException

Description copied from interface: XContentParser

Returns an instance of Map holding parsed map. Serves as a replacement for the "map", "mapOrdered" and "mapStrings" methods above.

Specified by:

map in interface XContentParser

Type Parameters:

T - map value type

Parameters:

mapFactory - factory for creating new Map objects

mapValueParser - parser for parsing a single map value

Returns:

Map object

Throws:

IOException

list

public List<Object> list()
                  throws IOException

Specified by:

list in interface XContentParser

Throws:

IOException

listOrderedMap

public List<Object> listOrderedMap()
                            throws IOException

Specified by:

listOrderedMap in interface XContentParser

Throws:

IOException

readValue

public static Object readValue(XContentParser parser,
 Supplier<Map<String,Object>> mapFactory)
                        throws IOException

Throws:

IOException

namedObject

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

Description copied from interface: XContentParser

Parse an object by name.

Specified by:

namedObject in interface XContentParser

Throws:

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

getDeprecationHandler

public DeprecationHandler getDeprecationHandler()

Description copied from interface: XContentParser

The callback to notify when parsing encounters a deprecated field.

Specified by:

getDeprecationHandler in interface XContentParser