Package net.ygbstudio.jbrave.api.response

Record Class ImageSearchApiResponse

java.lang.Object
java.lang.Record
net.ygbstudio.jbrave.api.response.ImageSearchApiResponse
Record Components:
type - The type of the response. This will always be "image_results".
query - The original query submitted by the user.
results - A list of image results provided by the API. Each result contains information about the image, such as its URL, width, height, and more.
extra - Additional information about the response, such as the total number of results and the search engine used.
All Implemented Interfaces:
ApiResponse
public record ImageSearchApiResponse(String type, ImageQuery query, List<ImageResult> results, Extra extra) extends Record implements ApiResponse
Represents the response from the Brave Search API for image searches. This class contains the original query, a list of image results, and extra information.

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; write(File) can be useful for that purpose.

  • Constructor Details

    • ImageSearchApiResponse

      public ImageSearchApiResponse(String type, ImageQuery query, List<ImageResult> results, Extra extra)
      Creates an instance of a ImageSearchApiResponse 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
      extra - the value for the extra record component

  • Method Details

    • from

      public static ImageSearchApiResponse from(File dataFile)

    • from

      public static ImageSearchApiResponse from(String dataString)

    • from

      public static ImageSearchApiResponse from(Reader dataReader)

    • from

      public static ImageSearchApiResponse from(@NotNull @NotNull HttpResponse<String> dataResponse)

    • write

      public void write(File target)
      Description copied from interface: ApiResponse
      Writes the response object to a file on the filesystem.
      Specified by:
      write in interface ApiResponse
      Parameters:
      target - the file to write the response object to.

    • toJson

      public String toJson()
      Description copied from interface: ApiResponse
      Serializes the response object to a JSON string.
      Specified by:
      toJson in interface ApiResponse
      Returns:
      a JSON string representation of the response object.

    • 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 ImageQuery query()
      Returns the value of the query record component.
      Returns:
      the value of the query record component

    • results

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

    • extra

      public Extra extra()
      Returns the value of the extra record component.
      Returns:
      the value of the extra record component