Package net.ygbstudio.jbrave.api.response

Record Class SuggestSearchApiResponse

java.lang.Object

java.lang.Record

net.ygbstudio.jbrave.api.response.SuggestSearchApiResponse

Record Components:

type - The type of the response.

query - The original query submitted by the user.

results - A list of suggestion results provided by the API.

All Implemented Interfaces:

ApiResponse

public record SuggestSearchApiResponse(String type, OriginalQuery query, List<SuggestResult> results)
extends Record
implements ApiResponse

Represents the response from the Brave Search API for suggestions. This class contains the string query and a list of suggestion 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; write(File) can be useful for that purpose.

Constructor Summary

Constructors

Constructor	Description
SuggestSearchApiResponse(String type, OriginalQuery query, List<SuggestResult> results)	Creates an instance of a SuggestSearchApiResponse record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
static SuggestSearchApiResponse	from(File dataFile)
static SuggestSearchApiResponse	from(Reader dataReader)
static SuggestSearchApiResponse	from(String dataString)
static SuggestSearchApiResponse	from(@NotNull HttpResponse<String> dataResponse)
final int	hashCode()	Returns a hash code value for this object.
OriginalQuery	query()	Returns the value of the query record component.
List<SuggestResult>	results()	Returns the value of the results record component.
String	toJson()	Serializes the response object to a JSON string.
final String	toString()	Returns a string representation of this record class.
String	type()	Returns the value of the type record component.
void	write(File target)	Writes the response object to a file on the filesystem.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

SuggestSearchApiResponse

public SuggestSearchApiResponse(String type,
 OriginalQuery query,
 List<SuggestResult> results)

Creates an instance of a SuggestSearchApiResponse 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 SuggestSearchApiResponse from(File dataFile)

from

public static SuggestSearchApiResponse from(String dataString)

from

public static SuggestSearchApiResponse from(Reader dataReader)

from

public static SuggestSearchApiResponse 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 OriginalQuery query()

Returns the value of the query record component.

Returns:

the value of the query record component

results

public List<SuggestResult> results()

Returns the value of the results record component.

Returns:

the value of the results record component