Module org.elasticsearch.server

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

Record Class BinaryAndCounts

java.lang.Object

java.lang.Record

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

public record BinaryAndCounts(TrackingBinaryDocValues binary, TrackingNumericDocValues counts)
extends Record

A TrackingBinaryDocValues containing encoded values and an associated TrackingNumericDocValues containing the counts of encoded values.

Constructor Summary

Constructors

Constructor	Description
BinaryAndCounts(TrackingBinaryDocValues binary, TrackingNumericDocValues counts)	Creates an instance of a BinaryAndCounts record class.

Method Summary

Modifier and Type	Method	Description
TrackingBinaryDocValues	binary()	Returns the value of the binary record component.
TrackingNumericDocValues	counts()	Returns the value of the counts record component.
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static BinaryAndCounts	get(CircuitBreaker breaker, org.apache.lucene.index.LeafReaderContext context, String fieldName, boolean skipCountsIfOne)	Atomically load the BinaryAndCounts.
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

Constructor Details

BinaryAndCounts

public BinaryAndCounts(TrackingBinaryDocValues binary,
 @Nullable
 TrackingNumericDocValues counts)

Creates an instance of a BinaryAndCounts record class.

Parameters:

binary - the value for the binary record component

counts - the value for the counts record component

Method Details

get

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

Atomically load the BinaryAndCounts. If the last parameter is true then counts() is nullable. When it is null then all counts are 1.

Throws:

IOException

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.

binary

public TrackingBinaryDocValues binary()

Returns the value of the binary record component.

Returns:

the value of the binary record component

counts

@Nullable
public TrackingNumericDocValues counts()

Returns the value of the counts record component.

Returns:

the value of the counts record component