Module org.apache.lucene.core

Package org.apache.lucene.codecs.perfield

Record Class PerFieldPostingsFormat.FieldsGroup

java.lang.Object

java.lang.Record

org.apache.lucene.codecs.perfield.PerFieldPostingsFormat.FieldsGroup

Record Components:

state - Custom SegmentWriteState for this group of fields, with the segmentSuffix uniqueified for this PostingsFormat

Enclosing class:

PerFieldPostingsFormat

static record PerFieldPostingsFormat.FieldsGroup(List<String> fields, int suffix, SegmentWriteState state)
extends Record

Group of fields written by one PostingsFormat

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static class	PerFieldPostingsFormat.FieldsGroup.Builder

Field Summary

Fields

Modifier and Type	Field	Description
private final List<String>	fields	The field for the fields record component.
private final SegmentWriteState	state	The field for the state record component.
private final int	suffix	The field for the suffix record component.

Constructor Summary

Constructors

Constructor	Description
FieldsGroup(List<String> fields, int suffix, SegmentWriteState state)	Creates an instance of a FieldsGroup record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
List<String>	fields()	Returns the value of the fields record component.
final int	hashCode()	Returns a hash code value for this object.
SegmentWriteState	state()	Returns the value of the state record component.
int	suffix()	Returns the value of the suffix 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

Field Details

fields

private final List<String> fields

The field for the fields record component.

suffix

private final int suffix

The field for the suffix record component.

state

private final SegmentWriteState state

The field for the state record component.

Constructor Details

FieldsGroup

FieldsGroup(List<String> fields,
 int suffix,
 SegmentWriteState state)

Creates an instance of a FieldsGroup record class.

Parameters:

fields - the value for the fields record component

suffix - the value for the suffix record component

state - the value for the state 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. 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.

fields

public List<String> fields()

Returns the value of the fields record component.

Returns:

the value of the fields record component

suffix

public int suffix()

Returns the value of the suffix record component.

Returns:

the value of the suffix record component

state

public SegmentWriteState state()

Returns the value of the state record component.

Returns:

the value of the state record component