Package net.ygbstudio.jbrave.api.options

Enum Class Units

java.lang.Object

java.lang.Enum<Units>

net.ygbstudio.jbrave.api.options.Units

All Implemented Interfaces:

Serializable, Comparable<Units>, Constable, BraveAPIConstant, ProvidedOption, SearchOption

public enum Units
extends Enum<Units>
implements ProvidedOption

Enumeration of the different units of measurement that can be used in the search methods.

See Also:

• SearchOption

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
IMPERIAL
METRIC

Field Summary

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
@NotNull @Unmodifiable SearchOptionCarrier<String>	toSearchOption()	Converts this search option 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 Units	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Units[]	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

METRIC

public static final Units METRIC

IMPERIAL

public static final Units IMPERIAL

Method Details

values

public static Units[] 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 Units 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

@Contract(pure=true)
@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: ProvidedOption

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

Specified by:

toSearchOption in interface ProvidedOption

Returns:

a SearchOptionCarrier representing this search option