org.opends.server.types
Enum FilterType

java.lang.Object
  java.lang.Enum<FilterType>
      org.opends.server.types.FilterType

All Implemented Interfaces:

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

@PublicAPI(stability=UNCOMMITTED,
           mayInstantiate=false,
           mayExtend=false,
           mayInvoke=true)
public enum FilterType
extends java.lang.Enum<FilterType>

This enumeration defines the set of possible filter types that may be used for search filters. This is based on the LDAP specification defined in RFC 2251.

Enum Constant Summary

AND
The filter type for AND filters.

APPROXIMATE_MATCH
The filter type for approximate filters.

EQUALITY
The filter type for equality filters.

EXTENSIBLE_MATCH
The filter type for extensible matching filters.

GREATER_OR_EQUAL
The filter type for greater or equal filters.

LESS_OR_EQUAL
The filter type for less or equal filters.

NOT
The filter type for NOT filters.

OR
The filter type for OR filters.

PRESENT
The filter type for presence filters.

SUBSTRING
The filter type for substring filters.

Method Summary

byte	getBERType() Retrieves the LDAP BER type for this filter type.
java.lang.String	toString() Retrieves a string representation of this filter type.
static FilterType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static FilterType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AND

public static final FilterType AND

The filter type for AND filters.

OR

public static final FilterType OR

The filter type for OR filters.

NOT

public static final FilterType NOT

The filter type for NOT filters.

EQUALITY

public static final FilterType EQUALITY

The filter type for equality filters.

SUBSTRING

public static final FilterType SUBSTRING

The filter type for substring filters.

GREATER_OR_EQUAL

public static final FilterType GREATER_OR_EQUAL

The filter type for greater or equal filters.

LESS_OR_EQUAL

public static final FilterType LESS_OR_EQUAL

The filter type for less or equal filters.

PRESENT

public static final FilterType PRESENT

The filter type for presence filters.

APPROXIMATE_MATCH

public static final FilterType APPROXIMATE_MATCH

The filter type for approximate filters.

EXTENSIBLE_MATCH

public static final FilterType EXTENSIBLE_MATCH

The filter type for extensible matching filters.

Method Detail

values

public static FilterType[] 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 (FilterType c : FilterType.values())
    System.out.println(c);

Returns:

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

valueOf

public static FilterType 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

getBERType

public byte getBERType()

Retrieves the LDAP BER type for this filter type.

Returns:

The LDAP BER type for this filter type.

toString

public java.lang.String toString()

Retrieves a string representation of this filter type.

Overrides:

toString in class java.lang.Enum<FilterType>

Returns:

A string representation of this filter type.