Package net.ygbstudio.jbrave.core.builders

Class BraveWebSearchRequest

java.lang.Object

net.ygbstudio.jbrave.core.builders.AbstractBraveRequestBuilder<BraveWebSearchRequest>

net.ygbstudio.jbrave.core.builders.BraveWebSearchRequest

All Implemented Interfaces:

BraveWebRequest, VerticalHeaderBuilder<BraveWebRequest>, WebHeaderBuilder<BraveWebRequest>

public final class BraveWebSearchRequest
extends AbstractBraveRequestBuilder<BraveWebSearchRequest>
implements BraveWebRequest

Builds a Brave web search request.

It configures the request URI and the request headers (user agent, cache control, API version, subscription token, and the geolocation headers) and builds the underlying HttpRequest.

Clients typically configure web search requests through BraveWebQuery's withHeaders consumer, which receives this builder as a WebHeaderBuilder typed with BraveWebRequest.

Instances are created with builder() and can be reused after calling AbstractBraveRequestBuilder.clear().

Field Summary

Fields inherited from class net.ygbstudio.jbrave.core.builders.AbstractBraveRequestBuilder

headers, headersAttached, internalRequestBuilder, requestURI

Method Summary

Modifier and Type	Method	Description
static BraveWebSearchRequest	builder()	Creates a new instance of BraveWebSearchRequest.
BraveWebSearchRequest	queryAddress(URI uri)	Sets the URI for the request.
BraveWebSearchRequest	withApiVersion(String apiVersion)	Adds an API version header to the request.
BraveWebSearchRequest	withCacheControl(String cacheControl)	Adds a cache control header to the request.
BraveWebSearchRequest	withCity(String city)	Adds a city header to the request.
BraveWebSearchRequest	withCountry(String country)	Adds a country header to the request.
BraveWebSearchRequest	withLatitude(double latitude)	Adds a latitude header to the request.
BraveWebSearchRequest	withLongitude(double longitude)	Adds a longitude header to the request.
BraveWebSearchRequest	withPostalCode(String postalCode)	Adds a postal code header to the request.
BraveWebSearchRequest	withState(String state)	Adds a state header to the request.
BraveWebSearchRequest	withStateName(String stateName)	Adds a state name header to the request.
BraveWebSearchRequest	withTimezone(@NotNull ZoneId timezone)	Adds a timezone header to the request.
BraveWebSearchRequest	withToken(String subscriptionToken)	Adds a brave subscription token header to the request.
BraveWebSearchRequest	withUserAgent(String userAgent)	Adds a user agent header to the request.

Methods inherited from class net.ygbstudio.jbrave.core.builders.AbstractBraveRequestBuilder

addHeader, attachHeaders, build, clear, clearRetainURI, queryURI, self, subscriptionMissing

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

builder

public static BraveWebSearchRequest builder()

Creates a new instance of BraveWebSearchRequest.

Returns:

a new instance of BraveWebSearchRequest

queryAddress

public BraveWebSearchRequest queryAddress(URI uri)

Sets the URI for the request.

Parameters:

uri - the request URI

Returns:

the current instance of BraveWebSearchRequest

withLatitude

public BraveWebSearchRequest withLatitude(double latitude)

Adds a latitude header to the request.

Specified by:

withLatitude in interface WebHeaderBuilder<BraveWebRequest>

Parameters:

latitude - the latitude value to set

Returns:

the current instance of BraveWebSearchRequest

withLongitude

public BraveWebSearchRequest withLongitude(double longitude)

Adds a longitude header to the request.

Specified by:

withLongitude in interface WebHeaderBuilder<BraveWebRequest>

Parameters:

longitude - the longitude value to set

Returns:

the current instance of BraveWebSearchRequest

withTimezone

public BraveWebSearchRequest withTimezone(@NotNull
 @NotNull ZoneId timezone)

Adds a timezone header to the request.

Specified by:

withTimezone in interface WebHeaderBuilder<BraveWebRequest>

Parameters:

timezone - the timezone value to set

Returns:

the current instance of BraveWebSearchRequest

withCountry

public BraveWebSearchRequest withCountry(String country)

Adds a country header to the request.

Specified by:

withCountry in interface WebHeaderBuilder<BraveWebRequest>

Parameters:

country - the country value to set

Returns:

the current instance of BraveWebSearchRequest

withCity

public BraveWebSearchRequest withCity(String city)

Adds a city header to the request.

Specified by:

withCity in interface WebHeaderBuilder<BraveWebRequest>

Parameters:

city - the city value to set

Returns:

the current instance of BraveWebSearchRequest

withState

public BraveWebSearchRequest withState(String state)

Adds a state header to the request.

Specified by:

withState in interface WebHeaderBuilder<BraveWebRequest>

Parameters:

state - the state value to set

Returns:

the current instance of BraveWebSearchRequest

withStateName

public BraveWebSearchRequest withStateName(String stateName)

Adds a state name header to the request.

Specified by:

withStateName in interface WebHeaderBuilder<BraveWebRequest>

Parameters:

stateName - the state name value to set

Returns:

the current instance of BraveWebSearchRequest

withPostalCode

public BraveWebSearchRequest withPostalCode(String postalCode)

Adds a postal code header to the request.

Specified by:

withPostalCode in interface WebHeaderBuilder<BraveWebRequest>

Parameters:

postalCode - the postal code value to set

Returns:

the current instance of BraveWebSearchRequest

withUserAgent

public BraveWebSearchRequest withUserAgent(String userAgent)

Adds a user agent header to the request.

Specified by:

withUserAgent in interface VerticalHeaderBuilder<BraveWebRequest>

Parameters:

userAgent - the user agent value to set

Returns:

the current instance of BraveWebSearchRequest

withCacheControl

public BraveWebSearchRequest withCacheControl(String cacheControl)

Adds a cache control header to the request.

Specified by:

withCacheControl in interface VerticalHeaderBuilder<BraveWebRequest>

Parameters:

cacheControl - the cache control value to set

Returns:

the current instance of BraveWebSearchRequest

withApiVersion

public BraveWebSearchRequest withApiVersion(String apiVersion)

Adds an API version header to the request.

Specified by:

withApiVersion in interface VerticalHeaderBuilder<BraveWebRequest>

Parameters:

apiVersion - the API version value to set

Returns:

the current instance of BraveWebSearchRequest

withToken

public BraveWebSearchRequest withToken(String subscriptionToken)

Adds a brave subscription token header to the request.

Parameters:

subscriptionToken - the subscription token to set

Returns:

the current instance of BraveWebSearchRequest