Package net.ygbstudio.jbrave.api.response

Record Class SpellcheckSearchApiResponse

java.lang.Object
java.lang.Record
net.ygbstudio.jbrave.api.response.SpellcheckSearchApiResponse
Record Components:
type - The type of the response.
query - The original query submitted by the user.
results - A list of spell check results provided by the API.
All Implemented Interfaces:
ApiResponse
public record SpellcheckSearchApiResponse(String type, OriginalQuery query, List<SpellCheckResult> results) extends Record implements ApiResponse
Represents the response from the Brave Search API for spell check. This class contains the original query and a list of spell check results.

This response record contains methods to deserialise and serialise instances.

Factory methods are available for String, File, Reader, and HttpResponse inputs. You can also write the contents of a response object to the filesystem; ApiResponse.write(File) can be useful for that purpose.

  • Constructor Details

    • SpellcheckSearchApiResponse

      public SpellcheckSearchApiResponse(String type, OriginalQuery query, List<SpellCheckResult> results)
      Creates an instance of a SpellcheckSearchApiResponse record class.
      Parameters:
      type - the value for the type record component
      query - the value for the query record component
      results - the value for the results record component

  • Method Details

    • from

      public static SpellcheckSearchApiResponse from(File dataFile)
      Deserializes a SpellcheckSearchApiResponse from a JSON File.
      Parameters:
      dataFile - the file containing the JSON response data
      Returns:
      the deserialized response

    • from

      public static SpellcheckSearchApiResponse from(String dataString)
      Deserializes a SpellcheckSearchApiResponse from a JSON String.
      Parameters:
      dataString - the string containing the JSON response data
      Returns:
      the deserialized response

    • from

      public static SpellcheckSearchApiResponse from(Reader dataReader)
      Deserializes a SpellcheckSearchApiResponse from a JSON Reader.
      Parameters:
      dataReader - the reader supplying the JSON response data
      Returns:
      the deserialized response

    • from

      public static SpellcheckSearchApiResponse from(@NotNull @NotNull HttpResponse<String> dataResponse)
      Deserializes a SpellcheckSearchApiResponse from the body of an HTTP response.
      Parameters:
      dataResponse - the HTTP response whose body contains the JSON response data
      Returns:
      the deserialized response

    • 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

    • query

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

    • results

      public List<SpellCheckResult> results()
      Returns the value of the results record component.
      Returns:
      the value of the results record component