org.apache.directory.ldap.client.api.search

Enum FilterOperator

java.lang.Object

java.lang.Enum<FilterOperator>

org.apache.directory.ldap.client.api.search.FilterOperator

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<FilterOperator>

 enum FilterOperator
extends java.lang.Enum<FilterOperator>

The operators that can be used in a Filter :

• AND: the '&' operator
• OR: the '|' operator
• NOT: the '!' operator
• EQUAL: the '=' operator
• LESS_THAN_OR_EQUAL: the '<=' operator
• GREATER_THAN_OR_EQUAL: the '>=' operator
• PRESENT: the '=*' operator
• APPROXIMATELY_EQUAL: the '~=' operator

Enum Constant Summary

Enum Constants

Enum Constant and Description
AND
APPROXIMATELY_EQUAL
EQUAL
EXTENSIBLE_EQUAL
GREATER_THAN_OR_EQUAL
LESS_THAN_OR_EQUAL
NOT
OR
PRESENT

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	operator The String representing the operator in a FIlter

Method Summary

Modifier and Type	Method and Description
java.lang.String	operator()
static FilterOperator	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FilterOperator[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AND

public static final FilterOperator AND

OR

public static final FilterOperator OR

NOT

public static final FilterOperator NOT

APPROXIMATELY_EQUAL

public static final FilterOperator APPROXIMATELY_EQUAL

EQUAL

public static final FilterOperator EQUAL

PRESENT

public static final FilterOperator PRESENT

GREATER_THAN_OR_EQUAL

public static final FilterOperator GREATER_THAN_OR_EQUAL

LESS_THAN_OR_EQUAL

public static final FilterOperator LESS_THAN_OR_EQUAL

EXTENSIBLE_EQUAL

public static final FilterOperator EXTENSIBLE_EQUAL

Field Detail

operator

private java.lang.String operator

The String representing the operator in a FIlter

Method Detail

values

public static FilterOperator[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (FilterOperator c : FilterOperator.values())
    System.out.println(c);

Returns:

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

valueOf

public static FilterOperator valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

operator

public java.lang.String operator()

Returns:

The String representation of the operator