com.unboundid.ldap.sdk.persist

Enum PersistFilterType

java.lang.Object

java.lang.Enum<PersistFilterType>

com.unboundid.ldap.sdk.persist.PersistFilterType

All Implemented Interfaces:

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

public enum PersistFilterType
extends java.lang.Enum<PersistFilterType>

This enum defines a set of filter types for filters that may be generated for an object using the LDAP SDK persistence framework. Classes created by GenerateSourceFromSchema (including the generate-source-from-schema command-line tool) will include methods that may be used to generate filters for object contents.

Enum Constant Summary

Enum Constants

Enum Constant and Description
APPROXIMATELY_EQUAL_TO The filter type that may be used to generate an approximate match filter, like "(attrName~=value)".
CONTAINS The filter type that may be used to generate a substring filter with a subAny element, like "(attrName=*value*)".
ENDS_WITH The filter type that may be used to generate a substring filter with a subFinal element, like "(attrName=*value)".
EQUALITY The filter type that may be used to generate an equality filter, like "(attrName=value)".
GREATER_OR_EQUAL The filter type that may be used to generate a greater-than-or-equal-to filter, like "(attrName>=value)".
LESS_OR_EQUAL The filter type that may be used to generate a less-than-or-equal-to filter, like "(attrName<=value)".
PRESENCE The filter type that may be used to generate a presence filter, like "(attrName=*)".
STARTS_WITH The filter type that may be used to generate a substring filter with a subInitial element, like "(attrName=value*)".

Method Summary

Modifier and Type	Method and Description
static PersistFilterType	forName(java.lang.String name) Retrieves the filter type with the specified name.
static PersistFilterType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PersistFilterType[]	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

PRESENCE

public static final PersistFilterType PRESENCE

The filter type that may be used to generate a presence filter, like "(attrName=*)".

EQUALITY

public static final PersistFilterType EQUALITY

The filter type that may be used to generate an equality filter, like "(attrName=value)".

STARTS_WITH

public static final PersistFilterType STARTS_WITH

The filter type that may be used to generate a substring filter with a subInitial element, like "(attrName=value*)".

ENDS_WITH

public static final PersistFilterType ENDS_WITH

The filter type that may be used to generate a substring filter with a subFinal element, like "(attrName=*value)".

CONTAINS

public static final PersistFilterType CONTAINS

The filter type that may be used to generate a substring filter with a subAny element, like "(attrName=*value*)".

GREATER_OR_EQUAL

public static final PersistFilterType GREATER_OR_EQUAL

The filter type that may be used to generate a greater-than-or-equal-to filter, like "(attrName>=value)".

LESS_OR_EQUAL

public static final PersistFilterType LESS_OR_EQUAL

The filter type that may be used to generate a less-than-or-equal-to filter, like "(attrName<=value)".

APPROXIMATELY_EQUAL_TO

public static final PersistFilterType APPROXIMATELY_EQUAL_TO

The filter type that may be used to generate an approximate match filter, like "(attrName~=value)".

Method Detail

values

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

Returns:

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

valueOf

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

forName

@Nullable
public static PersistFilterType forName(@NotNull
                                                  java.lang.String name)

Retrieves the filter type with the specified name.

Parameters:

name - The name of the filter type to retrieve. It must not be null.

Returns:

The requested filter type, or null if no such type is defined.