Package net.ygbstudio.jbrave.core.domain.dto.web

Record Class ResultReference

java.lang.Object
java.lang.Record
net.ygbstudio.jbrave.core.domain.dto.web.ResultReference
Record Components:
type - The type of result being referenced.
index - The index position of the result in the results array.
all - A flag indicating if all results of the specified type are referenced.
public record ResultReference(String type, Integer index, Boolean all) extends Record
Represents a reference to a search result or a group of results. This is used in the Brave Search API to reference specific results or result sets in the API response.

  • Constructor Details

    • ResultReference

      public ResultReference(String type, Integer index, Boolean all)
      Creates an instance of a ResultReference record class.
      Parameters:
      type - the value for the type record component
      index - the value for the index record component
      all - the value for the all 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 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.

    • type

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

    • index

      public Integer index()
      Returns the value of the index record component.
      Returns:
      the value of the index record component

    • all

      public Boolean all()
      Returns the value of the all record component.
      Returns:
      the value of the all record component