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

Record Class SuggestResult

java.lang.Object
java.lang.Record
net.ygbstudio.jbrave.core.domain.dto.result.SuggestResult
Record Components:
query - The suggested query string.
isEntity - Indicates if the suggestion is an entity.
title - The title of the suggestion.
description - A brief description of the suggestion.
img - The URL of an image associated with the suggestion.
public record SuggestResult(String query, Boolean isEntity, String title, String description, String img) extends Record
Represents a suggestion result in search responses. This class provides structured data about search suggestions in the Brave Search API results.

  • Constructor Details

    • SuggestResult

      public SuggestResult(String query, Boolean isEntity, String title, String description, String img)
      Creates an instance of a SuggestResult record class.
      Parameters:
      query - the value for the query record component
      isEntity - the value for the isEntity record component
      title - the value for the title record component
      description - the value for the description record component
      img - the value for the img 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.

    • query

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

    • isEntity

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

    • title

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

    • description

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

    • img

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