Module org.apache.lucene.core

Package org.apache.lucene.index

Record Class IndexWriter.IndexWriterMergeSource

java.lang.Object

java.lang.Record

org.apache.lucene.index.IndexWriter.IndexWriterMergeSource

All Implemented Interfaces:

MergeScheduler.MergeSource

Enclosing class:

IndexWriter

private static record IndexWriter.IndexWriterMergeSource(IndexWriter writer)
extends Record
implements MergeScheduler.MergeSource

Field Summary

Fields

Modifier and Type	Field	Description
private final IndexWriter	writer	The field for the writer record component.

Constructor Summary

Constructors

Modifier	Constructor	Description
private	IndexWriterMergeSource(IndexWriter writer)	Creates an instance of a IndexWriterMergeSource record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
MergePolicy.OneMerge	getNextMerge()	The MergeScheduler calls this method to retrieve the next merge requested by the MergePolicy
final int	hashCode()	Returns a hash code value for this object.
boolean	hasPendingMerges()	Expert: returns true if there are merges waiting to be scheduled.
void	merge(MergePolicy.OneMerge merge)	Merges the indicated segments, replacing them in the stack with a single segment.
void	onMergeFinished(MergePolicy.OneMerge merge)	Does finishing for a merge.
String	toString()	Returns a string representation of this record class.
IndexWriter	writer()	Returns the value of the writer record component.

Methods inherited from class java.lang.Object

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

Field Details

writer

private final IndexWriter writer

The field for the writer record component.

Constructor Details

IndexWriterMergeSource

private IndexWriterMergeSource(IndexWriter writer)

Creates an instance of a IndexWriterMergeSource record class.

Parameters:

writer - the value for the writer record component

Method Details

getNextMerge

public MergePolicy.OneMerge getNextMerge()

Description copied from interface: MergeScheduler.MergeSource

The MergeScheduler calls this method to retrieve the next merge requested by the MergePolicy

Specified by:

getNextMerge in interface MergeScheduler.MergeSource

onMergeFinished

public void onMergeFinished(MergePolicy.OneMerge merge)

Description copied from interface: MergeScheduler.MergeSource

Does finishing for a merge.

Specified by:

onMergeFinished in interface MergeScheduler.MergeSource

hasPendingMerges

public boolean hasPendingMerges()

Description copied from interface: MergeScheduler.MergeSource

Expert: returns true if there are merges waiting to be scheduled.

Specified by:

hasPendingMerges in interface MergeScheduler.MergeSource

merge

public void merge(MergePolicy.OneMerge merge)
           throws IOException

Description copied from interface: MergeScheduler.MergeSource

Merges the indicated segments, replacing them in the stack with a single segment.

Specified by:

merge in interface MergeScheduler.MergeSource

Throws:

IOException

toString

public 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.

writer

public IndexWriter writer()

Returns the value of the writer record component.

Returns:

the value of the writer record component