Module org.elasticsearch.server

Package org.elasticsearch.plugins

Record Class SearchPlugin.GenericNamedWriteableSpec

java.lang.Object

java.lang.Record

org.elasticsearch.plugins.SearchPlugin.GenericNamedWriteableSpec

Enclosing interface:

SearchPlugin

public static record SearchPlugin.GenericNamedWriteableSpec(String name, Writeable.Reader<? extends GenericNamedWriteable> reader)
extends Record

Specification of GenericNamedWriteable classes that can be serialized/deserialized as generic objects in search results.

Constructor Summary

Constructors

Constructor	Description
GenericNamedWriteableSpec(String name, Writeable.Reader<? extends GenericNamedWriteable> reader)	Creates an instance of a GenericNamedWriteableSpec record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
Writeable.Reader<? extends GenericNamedWriteable>	reader()	Returns the value of the reader record component.
final String	toString()	Returns a string representation of this record class.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

GenericNamedWriteableSpec

public GenericNamedWriteableSpec(String name,
 Writeable.Reader<? extends GenericNamedWriteable> reader)

Creates an instance of a GenericNamedWriteableSpec record class.

Parameters:

name - the value for the name record component

reader - the value for the reader record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

name

public String name()

Returns the value of the name record component.

Returns:

the value of the name record component

reader

public Writeable.Reader<? extends GenericNamedWriteable> reader()

Returns the value of the reader record component.

Returns:

the value of the reader record component