Package org.opensearch.core.xcontent

Class XContentSubParser

java.lang.Object

org.opensearch.core.xcontent.XContentSubParser

All Implemented Interfaces:

Closeable, AutoCloseable, XContentParser

public class XContentSubParser
extends Object
implements XContentParser

Wrapper for a XContentParser that makes a single object/array look like a complete document.

The wrapper prevents the parsing logic to consume tokens outside of the wrapped object as well as skipping to the end of the object in case of a parsing error. The wrapper is intended to be used for parsing objects that should be ignored if they are malformed.

Nested Class Summary

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

XContentParser.NumberType, XContentParser.Token

Constructor Summary

Constructors

Constructor	Description
XContentSubParser(XContentParser parser)

Method Summary

Modifier and Type	Method	Description
BigInteger	bigIntegerValue()
BigInteger	bigIntegerValue(boolean coerce)
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.
boolean	booleanValue()
CharBuffer	charBuffer()	Returns a CharBuffer holding UTF-8 bytes.
CharBuffer	charBufferOrNull()
void	close()
MediaType	contentType()
String	currentName()
XContentParser.Token	currentToken()
double	doubleValue()
double	doubleValue(boolean coerce)
float	floatValue()
float	floatValue(boolean coerce)
DeprecationHandler	getDeprecationHandler()	The callback to notify when parsing encounters a deprecated field.
XContentLocation	getTokenLocation()	Used for error reporting to highlight where syntax errors occur in content being parsed.
NamedXContentRegistry	getXContentRegistry()	The registry used to resolve XContentParser.namedObject(Class, String, Object).
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()
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.
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()

Methods inherited from class java.lang.Object

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

Constructor Details

XContentSubParser

public XContentSubParser(XContentParser parser)

Method Details

contentType

public MediaType contentType()

Specified by:

contentType in interface XContentParser

nextToken

public XContentParser.Token nextToken()
                               throws IOException

Specified by:

nextToken in interface XContentParser

Throws:

IOException

skipChildren

public void skipChildren()
                  throws IOException

Specified by:

skipChildren in interface XContentParser

Throws:

IOException

currentToken

public XContentParser.Token currentToken()

Specified by:

currentToken in interface XContentParser

currentName

public String currentName()
                   throws IOException

Specified by:

currentName 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

text

public String text()
            throws IOException

Specified by:

text in interface XContentParser

Throws:

IOException

textOrNull

public 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

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()

Specified by:

charBuffer in interface XContentParser

Throws:

IOException

objectText

public Object objectText()
                  throws IOException

Specified by:

objectText in interface XContentParser

Throws:

IOException

objectBytes

public Object objectBytes()
                   throws IOException

Specified by:

objectBytes in interface XContentParser

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.

Specified by:

hasTextCharacters in interface XContentParser

textCharacters

public char[] textCharacters()
                      throws IOException

Specified by:

textCharacters in interface XContentParser

Throws:

IOException

textLength

public int textLength()
               throws IOException

Specified by:

textLength in interface XContentParser

Throws:

IOException

textOffset

public int textOffset()
               throws IOException

Specified by:

textOffset in interface XContentParser

Throws:

IOException

numberValue

public Number numberValue()
                   throws IOException

Specified by:

numberValue in interface XContentParser

Throws:

IOException

numberType

public XContentParser.NumberType numberType()
                                     throws IOException

Specified by:

numberType in interface XContentParser

Throws:

IOException

shortValue

public short shortValue(boolean coerce)
                 throws IOException

Specified by:

shortValue in interface XContentParser

Throws:

IOException

intValue

public int intValue(boolean coerce)
             throws IOException

Specified by:

intValue in interface XContentParser

Throws:

IOException

longValue

public long longValue(boolean coerce)
               throws IOException

Specified by:

longValue in interface XContentParser

Throws:

IOException

floatValue

public float floatValue(boolean coerce)
                 throws IOException

Specified by:

floatValue in interface XContentParser

Throws:

IOException

doubleValue

public double doubleValue(boolean coerce)
                   throws IOException

Specified by:

doubleValue in interface XContentParser

Throws:

IOException

bigIntegerValue

public BigInteger bigIntegerValue(boolean coerce)
                           throws IOException

Specified by:

bigIntegerValue in interface XContentParser

Throws:

IOException

shortValue

public short shortValue()
                 throws IOException

Specified by:

shortValue in interface XContentParser

Throws:

IOException

intValue

public int intValue()
             throws IOException

Specified by:

intValue in interface XContentParser

Throws:

IOException

longValue

public long longValue()
               throws IOException

Specified by:

longValue in interface XContentParser

Throws:

IOException

floatValue

public float floatValue()
                 throws IOException

Specified by:

floatValue in interface XContentParser

Throws:

IOException

doubleValue

public double doubleValue()
                   throws IOException

Specified by:

doubleValue in interface XContentParser

Throws:

IOException

bigIntegerValue

public BigInteger bigIntegerValue()
                           throws IOException

Specified by:

bigIntegerValue in interface XContentParser

Throws:

IOException

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

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() ()}}

Specified by:

binaryValue in interface XContentParser

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.

Specified by:

getTokenLocation in interface XContentParser

Returns:

last token's location or null if cannot be determined

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

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException