Package com.atlassian.confluence.plugins.opensearch.client

Record Class CreateIndexRequestWithBM25Similarity.Bm25Settings

java.lang.Object
java.lang.Record
com.atlassian.confluence.plugins.opensearch.client.CreateIndexRequestWithBM25Similarity.Bm25Settings
Record Components:
k1 -
b -
Enclosing class:
CreateIndexRequestWithBM25Similarity
public static record CreateIndexRequestWithBM25Similarity.Bm25Settings(float k1, float b) extends Record
BM25 similarity parameters

  • Constructor Summary

    Constructors
    Constructor
    Description
    Bm25Settings(float k1, float b)
    Creates an instance of a Bm25Settings record class.

  • Method Summary

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

  • Constructor Details

    • Bm25Settings

      public Bm25Settings(float k1, float b)
      Creates an instance of a Bm25Settings record class.
      Parameters:
      k1 - the value for the k1 record component
      b - the value for the b record component

  • Method Details

    • getType

      public String getType()

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

    • k1

      public float k1()
      Returns the value of the k1 record component.
      Returns:
      the value of the k1 record component

    • b

      public float b()
      Returns the value of the b record component.
      Returns:
      the value of the b record component