Package org.opensearch.core.xcontent
package org.opensearch.core.xcontent
Base XContent Core Classes
-
ClassDescriptionAbstractObjectParser<Value,
Context> Superclass forObjectParserandConstructingObjectParser.Base class for parsing serializable contentConstructingObjectParser<Value,Context> LikeObjectParserbut works with objects that have constructors whose arguments are mixed in with its other settings.ContextParser<Context,T> Reads an object from a parser using some context.Callback for notifying the creator of theXContentParserthat parsing hit a deprecated field.Extension point to customize the error message for unknown fields.InstantiatingObjectParser<Value,Context> LikeConstructingObjectParserbut works with objects which have a constructor that matches declared fields.InstantiatingObjectParser.Builder<Value,Context> Builder for the Instantiating Object ParserWraps a map generated by XContentParser's map() method into XContent ParserAbstracts a Media Type and a format parameter.Parses supported internet media typesA media type object that contains all the information provided on a Content-Type or Accept headerThrown whenNamedXContentRegistrycannot locate a named object to parse for a particular nameMain registry for serializable content (e.g., field mappers, aggregations)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.ObjectParser.NamedObjectParser<T,Context> Functional interface for instantiating and parsing named objects.ObjectParser.Parser<Value,Context> Main parser interfaceDefines how to consume a parsed undefined fieldSupported Value Types for Parsable ObjectsObjectParserHelper<Value,Context> This class provides helpers forObjectParserthat allow dealing with classes outside of the xcontent dependencies.Helper class to navigate nested objects using dot notationMarks the constructor that should be used by InstantiatingObjectParser if multiple constructors with the same number of arguments exist.An interface allowing to transfer an object to "XContent" using anXContentBuilder.Delegates mapped parameters to base Params classMapped parameter base classBase parameters classAn interface allowing to transfer an object to "XContent" using anXContentBuilder.An interface allowing to transfer an object to "XContent" using anXContentBuilder.A generic abstraction on top of handling content, inspired by JSON and pull parsing.A utility to build XContent (ie json).Interface for transforming complex objects into their "raw" equivalents for human-readable fieldsThe writer interface for the serializable content builderThis interface provides a way for non-JDK classes to plug in a way to serialize to xcontent.Base class to generate serializable contentCore XContent Helper UtilitiesSimple data structure representing the line and column number of a position in some XContent e.g.Thrown when one of the XContent parsers cannot parse something.Interface for pull - parsingXContentseeXContentTypefor supported types.Supported numeric typesSupported serializable tokensA set of static methods to getXContentParser.TokenfromXContentParserwhile checking for their types and throwParsingExceptionif needed.Wrapper for a XContentParser that makes a single object/array look like a complete document.