Package net.solarnetwork.util

Enum Class SearchFilter.CompareOperator

java.lang.Object

java.lang.Enum<SearchFilter.CompareOperator>

net.solarnetwork.util.SearchFilter.CompareOperator

All Implemented Interfaces:

Serializable, Comparable<SearchFilter.CompareOperator>, Constable

Enclosing class:

SearchFilter

public static enum SearchFilter.CompareOperator
extends Enum<SearchFilter.CompareOperator>

A comparison operator for a single filter.

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
APPROX	Approximately match the attribute value to this attribute value.
EQUAL	Match exactly this attribute value.
GREATER_THAN	Match attribute values greater than this attribute value.
GREATER_THAN_EQUAL	Match attribute values greater than or equal to this attribute value.
LESS_THAN	Match attribute values less than this attribute value.
LESS_THAN_EQUAL	Match attribute values less than or equal to this attribute value.
NOT_EQUAL	Match anything but exactly this attribute value.
OVERLAP	For array comparison, an overlap operator.
PRESENT	Match if the attribute name is present, regardless of its value.
SUBSTRING	Match a substring (this attribute value) within attribute values.
SUBSTRING_AT_START	Match a substring (this attribute value) at the start of an attribute value.

Method Summary

Modifier and Type	Method	Description
static SearchFilter.CompareOperator	forKey(String key)	Get an enum value from a key value.
String	toString()
static SearchFilter.CompareOperator	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SearchFilter.CompareOperator[]	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

EQUAL

public static final SearchFilter.CompareOperator EQUAL

Match exactly this attribute value.

NOT_EQUAL

public static final SearchFilter.CompareOperator NOT_EQUAL

Match anything but exactly this attribute value.

LESS_THAN

public static final SearchFilter.CompareOperator LESS_THAN

Match attribute values less than this attribute value.

LESS_THAN_EQUAL

public static final SearchFilter.CompareOperator LESS_THAN_EQUAL

Match attribute values less than or equal to this attribute value.

GREATER_THAN

public static final SearchFilter.CompareOperator GREATER_THAN

Match attribute values greater than this attribute value.

GREATER_THAN_EQUAL

public static final SearchFilter.CompareOperator GREATER_THAN_EQUAL

Match attribute values greater than or equal to this attribute value.

SUBSTRING

public static final SearchFilter.CompareOperator SUBSTRING

Match a substring (this attribute value) within attribute values.

SUBSTRING_AT_START

public static final SearchFilter.CompareOperator SUBSTRING_AT_START

Match a substring (this attribute value) at the start of an attribute value.

PRESENT

public static final SearchFilter.CompareOperator PRESENT

Match if the attribute name is present, regardless of its value.

APPROX

public static final SearchFilter.CompareOperator APPROX

Approximately match the attribute value to this attribute value.

OVERLAP

public static final SearchFilter.CompareOperator OVERLAP

For array comparison, an overlap operator.

Method Details

values

public static SearchFilter.CompareOperator[] 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 SearchFilter.CompareOperator 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

toString

public String toString()

Overrides:

toString in class Enum<SearchFilter.CompareOperator>

forKey

public static SearchFilter.CompareOperator forKey(String key)

Get an enum value from a key value.

Parameters:

key - the key of the enum to get

Returns:

the enum, or null if not supported

Since:

1.1