Package net.ygbstudio.jbrave.core.model

Enum Class SearchOptions

java.lang.Object

java.lang.Enum<SearchOptions>

net.ygbstudio.jbrave.core.model.SearchOptions

All Implemented Interfaces:

Serializable, Comparable<SearchOptions>, Constable, BraveAPIConstant, ClientProvidedOption, SearchOption

public enum SearchOptions
extends Enum<SearchOptions>
implements ClientProvidedOption

Enumeration of the search options available in the Brave API.

These options can be used to modify the behavior of the API requests.

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
COUNT
ENABLE_RICH_CALLBACK
EXTRA_SNIPPETS
GOGGLES
INCLUDE_FETCH_METADATA
OFFSET
OPERATORS
RICH
SPELLCHECK
SUMMARY
TEXT_DECORATIONS

Field Summary

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

SEARCH_API_BASE

Method Summary

Modifier and Type	Method	Description
static @NotNull BraveSearchOption<Integer>	count(int count)	Create a new instance of BraveSearchOption with COUNT and the given value.
static @NotNull BraveSearchOption<Boolean>	enableRichCallback(boolean enableRichCallback)	Creates a new instance of BraveSearchOption with ENABLE_RICH_CALLBACK and the given value.
static @NotNull BraveSearchOption<Boolean>	extraSnippets(boolean extraSnippets)	Create a new instance of BraveSearchOption with EXTRA_SNIPPETS and the given value.
static @NotNull BraveSearchOption<String>	goggles(@NotNull URI gogglesUri)	Creates a new instance of BraveSearchOption with GOGGLES and the given value.
static @NotNull BraveSearchOption<Boolean>	includeFetchMetadata(boolean includeFetchMetadata)	Creates a new instance of BraveSearchOption with INCLUDE_FETCH_METADATA and the given value.
static @NotNull BraveSearchOption<Integer>	offset(int offset)	Create a new instance of BraveSearchOption with OFFSET and the given value.
static @NotNull BraveSearchOption<Boolean>	operators(boolean operators)	Create a new instance of BraveSearchOption with OPERATORS and the given value.
static @NotNull BraveSearchOption<Boolean>	rich(boolean rich)	Creates a new instance of BraveSearchOption with RICH and the given value.
static @NotNull BraveSearchOption<Boolean>	spellCheck(boolean spellCheck)	Create a new instance of BraveSearchOption with SPELLCHECK and the given value.
static @NotNull BraveSearchOption<Boolean>	summary(boolean summary)	Create a new instance of BraveSearchOption with SUMMARY and the given value.
static @NotNull BraveSearchOption<Boolean>	textDecorations(boolean textDecorations)	Create a new instance of BraveSearchOption with TEXT_DECORATIONS and the given value.
@NotNull String	urlParam()	Returns the URL parameter associated with this constant.
String	value()	Returns the value of the constant.
static SearchOptions	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SearchOptions[]	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

COUNT

public static final SearchOptions COUNT

OFFSET

public static final SearchOptions OFFSET

TEXT_DECORATIONS

public static final SearchOptions TEXT_DECORATIONS

SPELLCHECK

public static final SearchOptions SPELLCHECK

EXTRA_SNIPPETS

public static final SearchOptions EXTRA_SNIPPETS

ENABLE_RICH_CALLBACK

public static final SearchOptions ENABLE_RICH_CALLBACK

SUMMARY

public static final SearchOptions SUMMARY

OPERATORS

public static final SearchOptions OPERATORS

GOGGLES

public static final SearchOptions GOGGLES

RICH

public static final SearchOptions RICH

INCLUDE_FETCH_METADATA

public static final SearchOptions INCLUDE_FETCH_METADATA

Method Details

values

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

count

@Contract("_ -> new")
@NotNull
public static @NotNull BraveSearchOption<Integer> count(int count)

Create a new instance of BraveSearchOption with COUNT and the given value.

Parameters:

count - the value for COUNT

Returns:

a new instance of BraveSearchOption

Throws:

IllegalArgumentException - if the specified count is less than one.

offset

@Contract("_ -> new")
@NotNull
public static @NotNull BraveSearchOption<Integer> offset(int offset)

Create a new instance of BraveSearchOption with OFFSET and the given value.

Parameters:

offset - the value for OFFSET

Returns:

a new instance of BraveSearchOption

Throws:

IllegalArgumentException - if specified offset is less than zero.

textDecorations

@Contract("_ -> new")
@NotNull
public static @NotNull BraveSearchOption<Boolean> textDecorations(boolean textDecorations)

Create a new instance of BraveSearchOption with TEXT_DECORATIONS and the given value.

Parameters:

textDecorations - the value for TEXT_DECORATIONS

Returns:

a new instance of BraveSearchOption

spellCheck

@Contract("_ -> new")
@NotNull
public static @NotNull BraveSearchOption<Boolean> spellCheck(boolean spellCheck)

Create a new instance of BraveSearchOption with SPELLCHECK and the given value.

Parameters:

spellCheck - the value for SPELLCHECK

Returns:

a new instance of BraveSearchOption

extraSnippets

@Contract("_ -> new")
@NotNull
public static @NotNull BraveSearchOption<Boolean> extraSnippets(boolean extraSnippets)

Create a new instance of BraveSearchOption with EXTRA_SNIPPETS and the given value.

Parameters:

extraSnippets - the value for EXTRA_SNIPPETS

Returns:

a new instance of BraveSearchOption

summary

@Contract("_ -> new")
@NotNull
public static @NotNull BraveSearchOption<Boolean> summary(boolean summary)

Create a new instance of BraveSearchOption with SUMMARY and the given value.

Parameters:

summary - the value for SUMMARY

Returns:

a new instance of BraveSearchOption

operators

@Contract("_ -> new")
@NotNull
public static @NotNull BraveSearchOption<Boolean> operators(boolean operators)

Create a new instance of BraveSearchOption with OPERATORS and the given value.

Parameters:

operators - the value for OPERATORS

Returns:

a new instance of BraveSearchOption

enableRichCallback

@Contract("_ -> new")
@NotNull
public static @NotNull BraveSearchOption<Boolean> enableRichCallback(boolean enableRichCallback)

Creates a new instance of BraveSearchOption with ENABLE_RICH_CALLBACK and the given value.

Parameters:

enableRichCallback - the value for ENABLE_RICH_CALLBACK

Returns:

a new instance of BraveSearchOption

goggles

@Contract("_ -> new")
@NotNull
public static @NotNull BraveSearchOption<String> goggles(@NotNull
 @NotNull URI gogglesUri)

Creates a new instance of BraveSearchOption with GOGGLES and the given value.

Parameters:

gogglesUri - the value for GOGGLES, the URI must be a valid URL too

Returns:

a new instance of BraveSearchOption

Throws:

BraveGogglesIdentifierException - if the given gogglesUri is not a valid URL candidate

includeFetchMetadata

@Contract("_ -> new")
@NotNull
public static @NotNull BraveSearchOption<Boolean> includeFetchMetadata(boolean includeFetchMetadata)

Creates a new instance of BraveSearchOption with INCLUDE_FETCH_METADATA and the given value.

Parameters:

includeFetchMetadata - the value for INCLUDE_FETCH_METADATA

Returns:

a new instance of BraveSearchOption

rich

@Contract("_ -> new")
@NotNull
public static @NotNull BraveSearchOption<Boolean> rich(boolean rich)

Creates a new instance of BraveSearchOption with RICH and the given value.

Parameters:

rich - the value for RICH

Returns:

a new instance of BraveSearchOption