Package org.opensearch.common.xcontent

Interface Summary

Interface	Description
ContextParser<Context,T>	Reads an object from a parser using some context.
DeprecationHandler	Callback for notifying the creator of the XContentParser that parsing hit a deprecated field.
ErrorOnUnknown	Extension point to customize the error message for unknown fields.
ObjectParser.NamedObjectParser<T,Context>	Functional interface for instantiating and parsing named objects.
ObjectParser.Parser<Value,Context>
ObjectParser.UnknownFieldConsumer<Value>	Defines how to consume a parsed undefined field
ToXContent	An interface allowing to transfer an object to "XContent" using an XContentBuilder.
ToXContent.Params
ToXContentFragment	An interface allowing to transfer an object to "XContent" using an XContentBuilder.
ToXContentObject	An interface allowing to transfer an object to "XContent" using an XContentBuilder.
XContent	A generic abstraction on top of handling content, inspired by JSON and pull parsing.
XContentBuilder.HumanReadableTransformer	Interface for transforming complex objects into their "raw" equivalents for human-readable fields
XContentBuilder.Writer
XContentBuilderExtension	This interface provides a way for non-JDK classes to plug in a way to serialize to xcontent.
XContentGenerator
XContentParser	Interface for pull - parsing XContent see XContentType for supported types.

Class Summary

Class	Description
AbstractObjectParser<Value,Context>	Superclass for ObjectParser and ConstructingObjectParser.
ConstructingObjectParser<Value,Context>	Like ObjectParser but works with objects that have constructors whose arguments are mixed in with its other settings.
InstantiatingObjectParser<Value,Context>	Like ConstructingObjectParser but works with objects which have a constructor that matches declared fields.
InstantiatingObjectParser.Builder<Value,Context>
NamedXContentRegistry
NamedXContentRegistry.Entry	An entry in the NamedXContentRegistry containing the name of the object and the parser that can parse it.
ObjectParser<Value,Context>	A declarative, stateless parser that turns XContent into setter calls.
ObjectPath	Helper class to navigate nested objects using dot notation
ToXContent.DelegatingMapParams
ToXContent.MapParams
XContentBuilder	A utility to build XContent (ie json).
XContentFactory	A one stop to use XContent and XContentBuilder.
XContentLocation	Simple data structure representing the line and column number of a position in some XContent e.g.
XContentSubParser	Wrapper for a XContentParser that makes a single object/array look like a complete document.
XContentUtils

Enum Summary

Enum	Description
ObjectParser.ValueType
XContentParser.NumberType
XContentParser.Token
XContentType	The content type of XContent.

Exception Summary

Exception	Description
NamedObjectNotFoundException	Thrown when NamedXContentRegistry cannot locate a named object to parse for a particular name
XContentParseException	Thrown when one of the XContent parsers cannot parse something.

Annotation Types Summary

Annotation Type	Description
ParserConstructor	Marks the constructor that should be used by InstantiatingObjectParser if multiple constructors with the same number of arguments exist.