Package net.ygbstudio.jbrave.api.options

Enum Class SearchLanguage

java.lang.Object

java.lang.Enum<SearchLanguage>

net.ygbstudio.jbrave.api.options.SearchLanguage

All Implemented Interfaces:

Serializable, Comparable<SearchLanguage>, Constable, BraveAPIConstant, LanguageIdentifier, ProvidedOption, SearchOption

public enum SearchLanguage
extends Enum<SearchLanguage>
implements LanguageIdentifier

Enum representing the different language identifiers supported by the Brave Search API.

See Also:

• LanguageIdentifier

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ARABIC
BASQUE
BENGALI
BULGARIAN
CATALAN
CHINESE_SIMPLIFIED
CHINESE_TRADITIONAL
CROATIAN
CZECH
DANISH
DUTCH
ENGLISH
ENGLISH_UNITED_KINGDOM
ESTONIAN
FINNISH
FRENCH
GALICIAN
GERMAN
GREEK
GUJARATI
HEBREW
HINDI
HUNGARIAN
ICELANDIC
ITALIAN
JAPANESE
KANNADA
KOREAN
LATVIAN
LITHUANIAN
MALAY
MALAYALAM
MARATHI
NORWEGIAN_BOKMAL
POLISH
PORTUGUESE_BRAZIL
PORTUGUESE_PORTUGAL
PUNJABI
ROMANIAN
RUSSIAN
SERBIAN_CYRILIC
SLOVAK
SLOVENIAN
SPANISH
SWEDISH
TAMIL
TELUGU
THAI
TURKISH
UKRAINIAN
VIETNAMESE

Field Summary

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

SEARCH_API_BASE

Fields inherited from interface net.ygbstudio.jbrave.core.domain.provided.LanguageIdentifier

URL_PARAM

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

UNITS

Method Summary

Modifier and Type	Method	Description
@NotNull @Unmodifiable SearchOptionCarrier<String>	toSearchOption()	Converts this language identifier to a SearchOptionCarrier that can be used to build a URL parameter.
@NotNull String	urlParam()	Returns the URL parameter associated with this constant.
String	value()	Returns the value of the constant.
static SearchLanguage	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SearchLanguage[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ARABIC

public static final SearchLanguage ARABIC

BASQUE

public static final SearchLanguage BASQUE

BENGALI

public static final SearchLanguage BENGALI

BULGARIAN

public static final SearchLanguage BULGARIAN

CATALAN

public static final SearchLanguage CATALAN

CHINESE_SIMPLIFIED

public static final SearchLanguage CHINESE_SIMPLIFIED

CHINESE_TRADITIONAL

public static final SearchLanguage CHINESE_TRADITIONAL

CROATIAN

public static final SearchLanguage CROATIAN

CZECH

public static final SearchLanguage CZECH

DANISH

public static final SearchLanguage DANISH

DUTCH

public static final SearchLanguage DUTCH

ENGLISH

public static final SearchLanguage ENGLISH

ENGLISH_UNITED_KINGDOM

public static final SearchLanguage ENGLISH_UNITED_KINGDOM

ESTONIAN

public static final SearchLanguage ESTONIAN

FINNISH

public static final SearchLanguage FINNISH

FRENCH

public static final SearchLanguage FRENCH

GALICIAN

public static final SearchLanguage GALICIAN

GERMAN

public static final SearchLanguage GERMAN

GREEK

public static final SearchLanguage GREEK

GUJARATI

public static final SearchLanguage GUJARATI

HEBREW

public static final SearchLanguage HEBREW

HINDI

public static final SearchLanguage HINDI

HUNGARIAN

public static final SearchLanguage HUNGARIAN

ICELANDIC

public static final SearchLanguage ICELANDIC

ITALIAN

public static final SearchLanguage ITALIAN

JAPANESE

public static final SearchLanguage JAPANESE

KANNADA

public static final SearchLanguage KANNADA

KOREAN

public static final SearchLanguage KOREAN

LATVIAN

public static final SearchLanguage LATVIAN

LITHUANIAN

public static final SearchLanguage LITHUANIAN

MALAY

public static final SearchLanguage MALAY

MALAYALAM

public static final SearchLanguage MALAYALAM

MARATHI

public static final SearchLanguage MARATHI

NORWEGIAN_BOKMAL

public static final SearchLanguage NORWEGIAN_BOKMAL

POLISH

public static final SearchLanguage POLISH

PORTUGUESE_BRAZIL

public static final SearchLanguage PORTUGUESE_BRAZIL

PORTUGUESE_PORTUGAL

public static final SearchLanguage PORTUGUESE_PORTUGAL

PUNJABI

public static final SearchLanguage PUNJABI

ROMANIAN

public static final SearchLanguage ROMANIAN

RUSSIAN

public static final SearchLanguage RUSSIAN

SERBIAN_CYRILIC

public static final SearchLanguage SERBIAN_CYRILIC

SLOVAK

public static final SearchLanguage SLOVAK

SLOVENIAN

public static final SearchLanguage SLOVENIAN

SPANISH

public static final SearchLanguage SPANISH

SWEDISH

public static final SearchLanguage SWEDISH

TAMIL

public static final SearchLanguage TAMIL

TELUGU

public static final SearchLanguage TELUGU

THAI

public static final SearchLanguage THAI

TURKISH

public static final SearchLanguage TURKISH

UKRAINIAN

public static final SearchLanguage UKRAINIAN

VIETNAMESE

public static final SearchLanguage VIETNAMESE

Method Details

values

public static SearchLanguage[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static SearchLanguage valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

value

public String value()

Description copied from interface: BraveAPIConstant

Returns the value of the constant. Must be implemented by the enum constants.

Specified by:

value in interface BraveAPIConstant

Returns:

the value of the constant

urlParam

@NotNull
public @NotNull String urlParam()

Description copied from interface: BraveAPIConstant

Returns the URL parameter associated with this constant. It can be implemented by default at the interface level with the value of the parameter.

This method is used to generate the URL parameter for the API requests and represents a unit of option/parameterName/parameterConstant + "=" + parameterValue.

A parameterValue may be provided by the API or require that the client provides it. By default, all options/parameters names are provided by the API.

Specified by:

urlParam in interface BraveAPIConstant

Returns:

the URL parameter associated with this constant

See Also:

• ClientProvidedOption
• ProvidedOption
• Brave API Web Search - Query Parameters

toSearchOption

@Contract(" -> new")
@NotNull
public @NotNull @Unmodifiable SearchOptionCarrier<String> toSearchOption()

Description copied from interface: LanguageIdentifier

Converts this language identifier to a SearchOptionCarrier that can be used to build a URL parameter.

Specified by:

toSearchOption in interface LanguageIdentifier

Specified by:

toSearchOption in interface ProvidedOption

Returns:

a SearchOptionCarrier representing this identifier