Module org.elasticsearch.server

Package org.elasticsearch.index.mapper

Record Class IgnoredSourceFieldMapper.NameValue

java.lang.Object

java.lang.Record

org.elasticsearch.index.mapper.IgnoredSourceFieldMapper.NameValue

Enclosing class:

IgnoredSourceFieldMapper

public static record IgnoredSourceFieldMapper.NameValue(String name, int parentOffset, org.apache.lucene.util.BytesRef value, LuceneDocument doc)
extends Record

Constructor Summary

Constructors

Constructor	Description
NameValue(String name, int parentOffset, org.apache.lucene.util.BytesRef value, LuceneDocument doc)	Creates an instance of a NameValue record class.

Method Summary

Modifier and Type	Method	Description
LuceneDocument	doc()	Returns the value of the doc record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static IgnoredSourceFieldMapper.NameValue	fromContext(DocumentParserContext context, String name, org.apache.lucene.util.BytesRef value)	Factory method, for use with fields under the parent object.
final int	hashCode()	Returns a hash code value for this object.
String	name()	Returns the value of the name record component.
int	parentOffset()	Returns the value of the parentOffset record component.
final String	toString()	Returns a string representation of this record class.
org.apache.lucene.util.BytesRef	value()	Returns the value of the value record component.

Methods inherited from class java.lang.Object

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

Constructor Details

NameValue

public NameValue(String name,
 int parentOffset,
 org.apache.lucene.util.BytesRef value,
 LuceneDocument doc)

Creates an instance of a NameValue record class.

Parameters:

name - the value for the name record component

parentOffset - the value for the parentOffset record component

value - the value for the value record component

doc - the value for the doc record component

Method Details

fromContext

public static IgnoredSourceFieldMapper.NameValue fromContext(DocumentParserContext context,
 String name,
 org.apache.lucene.util.BytesRef value)

Factory method, for use with fields under the parent object. It doesn't apply to objects at root level.

Parameters:

context - the parser context, containing a non-null parent

name - the fully-qualified field name, including the path from root

value - the value to store

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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.

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

parentOffset

public int parentOffset()

Returns the value of the parentOffset record component.

Returns:

the value of the parentOffset record component

value

public org.apache.lucene.util.BytesRef value()

Returns the value of the value record component.

Returns:

the value of the value record component

doc

public LuceneDocument doc()

Returns the value of the doc record component.

Returns:

the value of the doc record component