Package net.ygbstudio.jbrave.core.domain.provided

Interface LanguageIdentifier

All Superinterfaces:

BraveAPIConstant, ProvidedOption, SearchOption

All Known Implementing Classes:

SearchLanguage

public interface LanguageIdentifier
extends ProvidedOption

An interface representing a language identifier.

Each language identifier has a BraveAPIConstant.value() method that is used to get the parameter value for the API requests.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	URL_PARAM	The URL parameter name for the search language option ("search_lang").

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

SEARCH_API_BASE

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

UNITS

Method Summary

Modifier and Type	Method	Description
SearchOptionCarrier<String>	toSearchOption()	Converts this language identifier to a SearchOptionCarrier for use in a search request.
static @NotNull String	urlParam(@NotNull LanguageIdentifier languageIdentifier)	Generates the URL parameter for this language identifier.

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

urlParam, value

Field Details

URL_PARAM

static final String URL_PARAM

The URL parameter name for the search language option ("search_lang").

See Also:

• Constant Field Values

Method Details

toSearchOption

SearchOptionCarrier<String> toSearchOption()

Converts this language identifier to a SearchOptionCarrier for use in a search request.

Specified by:

toSearchOption in interface ProvidedOption

Returns:

the SearchOptionCarrier representing this language

urlParam

@NotNull
static @NotNull String urlParam(@NotNull
 @NotNull LanguageIdentifier languageIdentifier)

Generates the URL parameter for this language identifier.

The URL parameter has the format "search_lang=<value>", where "<value>" is the value of this identifier.

Parameters:

languageIdentifier - the identifier to generate the URL parameter for

Returns:

the URL parameter for the given identifier