Package net.ygbstudio.jbrave.core.model

Enum Class BraveSearchOperator

java.lang.Object

java.lang.Enum<BraveSearchOperator>

net.ygbstudio.jbrave.core.model.BraveSearchOperator

All Implemented Interfaces:

Serializable, Comparable<BraveSearchOperator>, Constable

public enum BraveSearchOperator
extends Enum<BraveSearchOperator>

Enumeration of the search operators supported by the Brave Search API.

Each constant carries the literal prefix appended to a value when an operator string is built via SearchOperatorBuilder (for example filetype:html or site:example.com). isLogicalOperator() identifies the logical combinators AND, OR, and NOT.

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
AND	Logical AND operator.
EXT	File extension search operator.
FILETYPE	Filetype search operator.
INBODY	Body content search operator.
INPAGE	Page content search operator.
INTITLE	Title content search operator.
LANG	Language search operator.
LOC	Location search operator.
MINUS	Exclusion operator (-).
NOT	Logical NOT operator.
OR	Logical OR operator.
PLUS	Inclusion operator (+).
QUOTE	Exact match operator (wraps a value in double quotes).
SITE	Site restriction operator.

Method Summary

Modifier and Type	Method	Description
boolean	isLogicalOperator()	Returns true if the operator is a logical operator (AND, OR, NOT).
String	toString()
static BraveSearchOperator	valueOf(String name)	Returns the enum constant of this class with the specified name.
static BraveSearchOperator[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

EXT

public static final BraveSearchOperator EXT

File extension search operator.

FILETYPE

public static final BraveSearchOperator FILETYPE

Filetype search operator.

INTITLE

public static final BraveSearchOperator INTITLE

Title content search operator.

INBODY

public static final BraveSearchOperator INBODY

Body content search operator.

INPAGE

public static final BraveSearchOperator INPAGE

Page content search operator.

LANG

public static final BraveSearchOperator LANG

Language search operator.

LOC

public static final BraveSearchOperator LOC

Location search operator.

SITE

public static final BraveSearchOperator SITE

Site restriction operator.

PLUS

public static final BraveSearchOperator PLUS

Inclusion operator (+).

MINUS

public static final BraveSearchOperator MINUS

Exclusion operator (-).

QUOTE

public static final BraveSearchOperator QUOTE

Exact match operator (wraps a value in double quotes).

AND

public static final BraveSearchOperator AND

Logical AND operator.

OR

public static final BraveSearchOperator OR

Logical OR operator.

NOT

public static final BraveSearchOperator NOT

Logical NOT operator.

Method Details

values

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

isLogicalOperator

@Contract(pure=true)
public boolean isLogicalOperator()

Returns true if the operator is a logical operator (AND, OR, NOT).

Returns:

true if the operator is a logical operator

toString

public String toString()

Overrides:

toString in class Enum<BraveSearchOperator>