Module org.apache.lucene.core
Package org.apache.lucene.index

Record Class FieldInfos.FieldDimensions

java.lang.Object
java.lang.Record
org.apache.lucene.index.FieldInfos.FieldDimensions
Enclosing class:
FieldInfos
private static record FieldInfos.FieldDimensions(int dimensionCount, int indexDimensionCount, int dimensionNumBytes) extends Record

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    private final int
    dimensionCount
    The field for the dimensionCount record component.
    private final int
    dimensionNumBytes
    The field for the dimensionNumBytes record component.
    private final int
    indexDimensionCount
    The field for the indexDimensionCount record component.

  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    FieldDimensions(int dimensionCount, int indexDimensionCount, int dimensionNumBytes)
    Creates an instance of a FieldDimensions record class.

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    dimensionCount()
    Returns the value of the dimensionCount record component.
    int
    dimensionNumBytes()
    Returns the value of the dimensionNumBytes record component.
    final boolean
    equals(Object o)
    Indicates whether some other object is "equal to" this one.
    final int
    hashCode()
    Returns a hash code value for this object.
    int
    indexDimensionCount()
    Returns the value of the indexDimensionCount record component.
    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

    • dimensionCount

      private final int dimensionCount
      The field for the dimensionCount record component.

    • indexDimensionCount

      private final int indexDimensionCount
      The field for the indexDimensionCount record component.

    • dimensionNumBytes

      private final int dimensionNumBytes
      The field for the dimensionNumBytes record component.

  • Constructor Details

    • FieldDimensions

      private FieldDimensions(int dimensionCount, int indexDimensionCount, int dimensionNumBytes)
      Creates an instance of a FieldDimensions record class.
      Parameters:
      dimensionCount - the value for the dimensionCount record component
      indexDimensionCount - the value for the indexDimensionCount record component
      dimensionNumBytes - the value for the dimensionNumBytes record component

  • Method Details

    • 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 '=='.
      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.

    • dimensionCount

      public int dimensionCount()
      Returns the value of the dimensionCount record component.
      Returns:
      the value of the dimensionCount record component

    • indexDimensionCount

      public int indexDimensionCount()
      Returns the value of the indexDimensionCount record component.
      Returns:
      the value of the indexDimensionCount record component

    • dimensionNumBytes

      public int dimensionNumBytes()
      Returns the value of the dimensionNumBytes record component.
      Returns:
      the value of the dimensionNumBytes record component