Record Class ToMask

java.lang.Object
java.lang.Record
org.elasticsearch.compute.data.ToMask
All Implemented Interfaces:
Closeable, AutoCloseable, org.elasticsearch.core.Releasable

public record ToMask(BooleanVector mask, boolean hadMultivaluedFields) extends Record implements org.elasticsearch.core.Releasable
Result from calling BooleanBlock.toMask(). closing this will close the contained mask(). If you want to keep a reference to it then you'll have to RefCounted.incRef() it.
  • Constructor Summary

    Constructors
    Constructor
    Description
    ToMask(BooleanVector mask, boolean hadMultivaluedFields)
    Creates an instance of a ToMask record class.
  • Method Summary

    Modifier and Type
    Method
    Description
    void
     
    final boolean
    Indicates whether some other object is "equal to" this one.
    boolean
    Returns the value of the hadMultivaluedFields record component.
    final int
    Returns a hash code value for this object.
    Returns the value of the mask record component.
    final String
    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

    • ToMask

      public ToMask(BooleanVector mask, boolean hadMultivaluedFields)
      Creates an instance of a ToMask record class.
      Parameters:
      mask - the value for the mask record component
      hadMultivaluedFields - the value for the hadMultivaluedFields record component
  • Method Details

    • close

      public void close()
      Specified by:
      close in interface AutoCloseable
      Specified by:
      close in interface Closeable
      Specified by:
      close in interface org.elasticsearch.core.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. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with '=='.
      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.
    • mask

      public BooleanVector mask()
      Returns the value of the mask record component.
      Returns:
      the value of the mask record component
    • hadMultivaluedFields

      public boolean hadMultivaluedFields()
      Returns the value of the hadMultivaluedFields record component.
      Returns:
      the value of the hadMultivaluedFields record component