Package org.opensearch.core.xcontent

Class NamedXContentRegistry

java.lang.Object

org.opensearch.core.xcontent.NamedXContentRegistry

@PublicApi(since="1.0.0")
public class NamedXContentRegistry
extends Object

Main registry for serializable content (e.g., field mappers, aggregations)

Opensearch.api:

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	NamedXContentRegistry.Entry	An entry in the NamedXContentRegistry containing the name of the object and the parser that can parse it.

Field Summary

Fields

Modifier and Type	Field	Description
static final NamedXContentRegistry	EMPTY	The empty NamedXContentRegistry for use when you are sure that you aren't going to call XContentParser.namedObject(Class, String, Object).

Constructor Summary

Constructors

Constructor	Description
NamedXContentRegistry(List<NamedXContentRegistry.Entry> entries)

Method Summary

Modifier and Type	Method	Description
<T, C> T	parseNamedObject(Class<T> categoryClass, String name, XContentParser parser, C context)	Parse a named object, throwing an exception if the parser isn't found.

Methods inherited from class java.lang.Object

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

Field Details

EMPTY

public static final NamedXContentRegistry EMPTY

The empty NamedXContentRegistry for use when you are sure that you aren't going to call XContentParser.namedObject(Class, String, Object). Be *very* careful with this singleton because a parser using it will fail every call to XContentParser.namedObject(Class, String, Object). Every non-test usage really should be checked thoroughly and marked with a comment about how it was checked. That way anyone that sees code that uses it knows that it is potentially dangerous.

Constructor Details

NamedXContentRegistry

public NamedXContentRegistry(List<NamedXContentRegistry.Entry> entries)

Method Details

parseNamedObject

public <T,
C> T parseNamedObject(Class<T> categoryClass,
 String name,
 XContentParser parser,
 C context)
                          throws IOException

Parse a named object, throwing an exception if the parser isn't found. Throws an NamedObjectNotFoundException if the categoryClass isn't registered because this is almost always a bug. Throws an NamedObjectNotFoundException if the categoryClass is registered but the name isn't.

Throws:

NamedObjectNotFoundException - if the categoryClass or name is not registered

IOException