Package org.opensearch.core.xcontent

Interface XContentParser

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

AbstractXContentParser, MapXContentParser, XContentSubParser

@PublicApi(since="1.0.0")
public interface XContentParser
extends Closeable

Interface for pull - parsing XContent see XContentType for supported types.

To obtain an instance of this class use the following pattern:

     MediaType mediaType = MediaTypeRegistry.JSON;
     XContentParser parser = mediaType.xContent().createParser(
          NamedXContentRegistry.EMPTY, ParserField."{\"key\" : \"value\"}");
 

Opensearch.api:

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	XContentParser.NumberType	Supported numeric types
static enum	XContentParser.Token	Supported serializable tokens

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()
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 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 interface java.io.Closeable

close

Method Details

contentType

MediaType contentType()

nextToken

XContentParser.Token nextToken()
                        throws IOException

Throws:

IOException

skipChildren

void skipChildren()
           throws IOException

Throws:

IOException

currentToken

XContentParser.Token currentToken()

currentName

String currentName()
            throws IOException

Throws:

IOException

map

Map<String,Object> map()
                throws IOException

Throws:

IOException

mapOrdered

Map<String,Object> mapOrdered()
                       throws IOException

Throws:

IOException

mapStrings

Map<String,String> mapStrings()
                       throws IOException

Throws:

IOException

map

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

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

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

List<Object> list()
           throws IOException

Throws:

IOException

listOrderedMap

List<Object> listOrderedMap()
                     throws IOException

Throws:

IOException

text

String text()
     throws IOException

Throws:

IOException

textOrNull

String textOrNull()
           throws IOException

Throws:

IOException

charBufferOrNull

CharBuffer charBufferOrNull()
                     throws IOException

Throws:

IOException

charBuffer

CharBuffer charBuffer()
               throws IOException

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

Throws:

IOException

objectText

Object objectText()
           throws IOException

Throws:

IOException

objectBytes

Object objectBytes()
            throws IOException

Throws:

IOException

hasTextCharacters

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.

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

char[] textCharacters()
               throws IOException

Throws:

IOException

textLength

int textLength()
        throws IOException

Throws:

IOException

textOffset

int textOffset()
        throws IOException

Throws:

IOException

numberValue

Number numberValue()
            throws IOException

Throws:

IOException

numberType

XContentParser.NumberType numberType()
                              throws IOException

Throws:

IOException

shortValue

short shortValue(boolean coerce)
          throws IOException

Throws:

IOException

intValue

int intValue(boolean coerce)
      throws IOException

Throws:

IOException

longValue

long longValue(boolean coerce)
        throws IOException

Throws:

IOException

floatValue

float floatValue(boolean coerce)
          throws IOException

Throws:

IOException

doubleValue

double doubleValue(boolean coerce)
            throws IOException

Throws:

IOException

bigIntegerValue

BigInteger bigIntegerValue(boolean coerce)
                    throws IOException

Throws:

IOException

shortValue

short shortValue()
          throws IOException

Throws:

IOException

intValue

int intValue()
      throws IOException

Throws:

IOException

longValue

long longValue()
        throws IOException

Throws:

IOException

floatValue

float floatValue()
          throws IOException

Throws:

IOException

doubleValue

double doubleValue()
            throws IOException

Throws:

IOException

bigIntegerValue

BigInteger bigIntegerValue()
                    throws IOException

Throws:

IOException

isBooleanValue

boolean isBooleanValue()
                throws IOException

Returns:

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

Throws:

IOException

booleanValue

boolean booleanValue()
              throws IOException

Throws:

IOException

binaryValue

byte[] binaryValue()
            throws IOException

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:

• text() ()}
• textOrNull() ()}
• textCharacters() ()}}

Throws:

IOException

getTokenLocation

XContentLocation getTokenLocation()

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

namedObject

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

Parse an object by name.

Throws:

IOException

getXContentRegistry

NamedXContentRegistry getXContentRegistry()

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

isClosed

boolean isClosed()

getDeprecationHandler

DeprecationHandler getDeprecationHandler()

The callback to notify when parsing encounters a deprecated field.