Package org.opensearch.core.xcontent

Class NamedXContentRegistry.Entry

java.lang.Object

org.opensearch.core.xcontent.NamedXContentRegistry.Entry

Enclosing class:

NamedXContentRegistry

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

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
final Class<?>	categoryClass	The class that this entry can read.
final ParseField	name	A name for the entry which is unique within the categoryClass.

Constructor Summary

Constructors

Constructor	Description
Entry(Class<T> categoryClass, ParseField name, org.opensearch.common.CheckedFunction<XContentParser,? extends T,IOException> parser)	Creates a new entry which can be stored by the registry.
Entry(Class<T> categoryClass, ParseField name, ContextParser<Object,? extends T> parser)	Creates a new entry which can be stored by the registry.

Method Summary

Methods inherited from class java.lang.Object

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

Field Details

categoryClass

public final Class<?> categoryClass

The class that this entry can read.

name

public final ParseField name

A name for the entry which is unique within the categoryClass.

Constructor Details

Entry

public Entry(Class<T> categoryClass,
 ParseField name,
 org.opensearch.common.CheckedFunction<XContentParser,? extends T,IOException> parser)

Creates a new entry which can be stored by the registry.

Entry

public Entry(Class<T> categoryClass,
 ParseField name,
 ContextParser<Object,? extends T> parser)

Creates a new entry which can be stored by the registry. Prefer Entry(Class, ParseField, CheckedFunction) unless you need a context to carry around while parsing.