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

Record Class TrackingBinaryDocValues

java.lang.Object
java.lang.Record
org.elasticsearch.index.mapper.blockloader.docvalues.tracking.TrackingBinaryDocValues
All Implemented Interfaces:
Closeable, AutoCloseable, Releasable
public record TrackingBinaryDocValues(CircuitBreaker breaker, org.apache.lucene.index.BinaryDocValues docValues) extends Record implements Releasable
Wraps a BinaryDocValues, reserving some space in a CircuitBreaker while it is live.

  • Constructor Summary

    Constructors
    Constructor
    Description
    TrackingBinaryDocValues(CircuitBreaker breaker, org.apache.lucene.index.BinaryDocValues docValues)
    Creates an instance of a TrackingBinaryDocValues 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.BinaryDocValues
    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 TrackingBinaryDocValues
    get(CircuitBreaker breaker, org.apache.lucene.index.LeafReaderContext context, String fieldName)
     
    static TrackingBinaryDocValues
    get(CircuitBreaker breaker, org.apache.lucene.index.LeafReaderContext context, org.apache.lucene.util.IOFunction<org.apache.lucene.index.LeafReaderContext,org.apache.lucene.index.BinaryDocValues> supplier)
     
    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

    • TrackingBinaryDocValues

      public TrackingBinaryDocValues(CircuitBreaker breaker, org.apache.lucene.index.BinaryDocValues docValues)
      Creates an instance of a TrackingBinaryDocValues record class.
      Parameters:
      breaker - the value for the breaker record component
      docValues - the value for the docValues record component

  • Method Details

    • get

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

    • get

      public static TrackingBinaryDocValues get(CircuitBreaker breaker, org.apache.lucene.index.LeafReaderContext context, org.apache.lucene.util.IOFunction<org.apache.lucene.index.LeafReaderContext,org.apache.lucene.index.BinaryDocValues> supplier) 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.BinaryDocValues docValues()
      Returns the value of the docValues record component.
      Returns:
      the value of the docValues record component