Record Class DocValueField

java.lang.Object
java.lang.Record
org.springframework.data.elasticsearch.core.query.DocValueField
public record DocValueField(String field, @Nullable String format) extends Record
Record defining a docvalue_field to be used in a query.
Since:
5.1
Author:
Peter-Josef Meisch

  • Constructor Details

    • DocValueField

      public DocValueField(String field, @Nullable String format)
      Creates an instance of a DocValueField record class.
      Parameters:
      field - the value for the field record component
      format - the value for the format record component

    • DocValueField

      public DocValueField(String field)

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

    • field

      public String field()
      Returns the value of the field record component.
      Returns:
      the value of the field record component

    • format

      public @Nullable String format()
      Returns the value of the format record component.
      Returns:
      the value of the format record component