Module org.apache.lucene.core

Package org.apache.lucene.index

Class MergePolicy.MergeSpecification

java.lang.Object

org.apache.lucene.index.MergePolicy.MergeSpecification

Enclosing class:

MergePolicy

public static class MergePolicy.MergeSpecification
extends Object

A MergeSpecification instance provides the information necessary to perform multiple merges. It simply contains a list of MergePolicy.OneMerge instances.

Field Summary

Fields

Modifier and Type	Field	Description
final List<MergePolicy.OneMerge>	merges	The subset of segments to be included in the primitive merge.

Constructor Summary

Constructors

Constructor	Description
MergeSpecification()	Sole constructor.

Method Summary

Modifier and Type	Method	Description
void	add(MergePolicy.OneMerge merge)	Adds the provided MergePolicy.OneMerge to this specification.
(package private) boolean	await()	Waits, until interrupted, for all merges to complete.
(package private) boolean	await(long timeout, TimeUnit unit)	Waits if necessary for at most the given time for all merges.
(package private) CompletableFuture<Void>	getMergeCompletedFutures()
String	segString(Directory dir)	Returns a description of the merges in this specification.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

merges

public final List<MergePolicy.OneMerge> merges

The subset of segments to be included in the primitive merge.

Constructor Details

MergeSpecification

public MergeSpecification()

Sole constructor. Use add(MergePolicy.OneMerge) to add merges.

Method Details

add

public void add(MergePolicy.OneMerge merge)

Adds the provided MergePolicy.OneMerge to this specification.

segString

public String segString(Directory dir)

Returns a description of the merges in this specification.

toString

public String toString()

Overrides:

toString in class Object

getMergeCompletedFutures

CompletableFuture<Void> getMergeCompletedFutures()

await

boolean await()

Waits, until interrupted, for all merges to complete.

await

boolean await(long timeout,
 TimeUnit unit)

Waits if necessary for at most the given time for all merges.