Package net.ygbstudio.jbrave.core.domain

Interface ProvidedOption

All Superinterfaces:

BraveAPIConstant, SearchOption

All Known Subinterfaces:

CountryIdentifier, LanguageIdentifier, RegionLocaleIdentifier, SearchFilterOption

All Known Implementing Classes:

Country, Freshness, MarketLocale, ResultFilter, SafeSearch, SearchLanguage, Units

public non-sealed interface ProvidedOption
extends SearchOption

An interface representing a search option that provides a key and a value for a URL parameter.

If a class implements this interface, the correctness of the implementation implies that an option enum includes a method to convert it to a SearchOptionCarrier. Subinterfaces of this interface may include constants that align with the Brave Search API documentation to ensure that all options are supported and their parameter construction is correct.

See Also:

• SearchOption

Field Summary

Fields

Modifier and Type	Field	Description
static final String	UNITS

Fields inherited from interface net.ygbstudio.jbrave.core.domain.BraveAPIConstant

SEARCH_API_BASE

Method Summary

Modifier and Type	Method	Description
SearchOptionCarrier<String>	toSearchOption()	Converts this search option to a SearchOptionCarrier that can be used to build a URL parameter.

Methods inherited from interface net.ygbstudio.jbrave.core.domain.BraveAPIConstant

urlParam, value

Field Details

UNITS

static final String UNITS

See Also:

• Constant Field Values

Method Details

toSearchOption

SearchOptionCarrier<String> toSearchOption()

Converts this search option to a SearchOptionCarrier that can be used to build a URL parameter.

Returns:

a SearchOptionCarrier representing this search option