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

Record Class LocationDescription

java.lang.Object
java.lang.Record
net.ygbstudio.jbrave.core.domain.dto.web.LocationDescription
Record Components:
type - The type of location
id - A unique identifier for the location within the Brave Search system.
description - A human-readable description of the location, providing context or additional details about the place.
public record LocationDescription(String type, String id, String description) extends Record
Represents descriptive information about a specific location in search results. This is used in the Brave Search API to provide structured location data along with a human-readable description.

  • Constructor Details

    • LocationDescription

      public LocationDescription(String type, String id, String description)
      Creates an instance of a LocationDescription record class.
      Parameters:
      type - the value for the type record component
      id - the value for the id record component
      description - the value for the description 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

    • id

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

    • description

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