Module org.elasticsearch.server

Package org.elasticsearch.index.mapper.blockloader.docvalues.tracking

Record Class TrackingNumericDocValues

java.lang.Object

java.lang.Record

org.elasticsearch.index.mapper.blockloader.docvalues.tracking.TrackingNumericDocValues

All Implemented Interfaces:

Closeable, AutoCloseable, Releasable

public record TrackingNumericDocValues(CircuitBreaker breaker, org.apache.lucene.index.NumericDocValues docValues)
extends Record
implements Releasable

Wraps a NumericDocValues, reserving some space in a CircuitBreaker while it is live.

Field Summary

Fields

Modifier and Type	Field	Description
static final long	ESTIMATED_SIZE	Circuit breaker space reserved for each reader.

Constructor Summary

Constructors

Constructor	Description
TrackingNumericDocValues(CircuitBreaker breaker, org.apache.lucene.index.NumericDocValues docValues)	Creates an instance of a TrackingNumericDocValues record class.

Method Summary

Modifier and Type	Method	Description
CircuitBreaker	breaker()	Returns the value of the breaker record component.
void	close()
org.apache.lucene.index.NumericDocValues	docValues()	Returns the value of the docValues record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static TrackingNumericDocValues	get(CircuitBreaker breaker, org.apache.lucene.index.LeafReaderContext context, String fieldName)
final int	hashCode()	Returns a hash code value for this object.
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

ESTIMATED_SIZE

public static final long ESTIMATED_SIZE

Circuit breaker space reserved for each reader. Measured in heap dumps around 500 bytes and this is an intention overestimate.

Constructor Details

TrackingNumericDocValues

public TrackingNumericDocValues(CircuitBreaker breaker,
 org.apache.lucene.index.NumericDocValues docValues)

Creates an instance of a TrackingNumericDocValues record class.

Parameters:

breaker - the value for the breaker record component

docValues - the value for the docValues record component

Method Details

get

public static TrackingNumericDocValues get(CircuitBreaker breaker,
 org.apache.lucene.index.LeafReaderContext context,
 String fieldName)
                                    throws IOException

Throws:

IOException

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Specified by:

close in interface Releasable

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.

breaker

public CircuitBreaker breaker()

Returns the value of the breaker record component.

Returns:

the value of the breaker record component

docValues

public org.apache.lucene.index.NumericDocValues docValues()

Returns the value of the docValues record component.

Returns:

the value of the docValues record component