|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |
java.lang.Objectjava.lang.Enum<IndexType>
com.unboundid.directory.sdk.ds.types.IndexType
@ThreadSafety(level=COMPLETELY_THREADSAFE) public enum IndexType
This class implements an enumeration that may be used to define the ways in which an attribute may be indexed within the directory server.
Enum Constant Summary | |
---|---|
APPROXIMATE
Used to denote an approximate index, which may be used to identify entries with one or more values that are approximately equal to a specified value. |
|
EQUALITY
Used to denote an equality index, which may be used to identify entries containing a specified value for the associated attribute. |
|
GREATER_OR_EQUAL
Used to denote a greater-or-equal index, which may be used to identify entries with one or more values that are greater than or equal to a specified value. |
|
LESS_OR_EQUAL
Used to denote a less-or-equal index, which may be used to identify entries with one or more values that are less than or equal to a specified value. |
|
PRESENCE
Used to denote a presence index, which may be used to identify entries containing the associated attribute (regardless of the value for that attribute). |
|
SUBANY
Used to denote a subAny index, which may be used to identify entries with one or more values for the associated attribute that contain a specified string. |
|
SUBFINAL
Used to denote a subFinal index, which may be used to identify entries with one or more values for the associated attribute that end with a specified string. |
|
SUBINITIAL
Used to denote a subInitial index, which may be used to identify entries with one or more values for the associated attribute that begin with a specified string. |
|
SUBSTRING
Used to denote a substring index, which may be used to identify entries with one or more values for the associated attribute that match a given substring assertion. |
Method Summary | |
---|---|
static IndexType |
forName(java.lang.String indexName)
Retrieves the IndexType for the specified name. |
java.lang.String |
toString()
Retrieves the human-readable name for this IndexType . |
static IndexType |
valueOf(java.lang.String name)
Returns the enum constant of this type with the specified name. |
static IndexType[] |
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 |
---|
public static final IndexType PRESENCE
public static final IndexType EQUALITY
public static final IndexType SUBSTRING
public static final IndexType SUBINITIAL
public static final IndexType SUBANY
public static final IndexType SUBFINAL
public static final IndexType GREATER_OR_EQUAL
public static final IndexType LESS_OR_EQUAL
public static final IndexType APPROXIMATE
Method Detail |
---|
public static IndexType[] values()
for (IndexType c : IndexType.values()) System.out.println(c);
public static IndexType valueOf(java.lang.String name)
name
- the name of the enum constant to be returned.
java.lang.IllegalArgumentException
- if this enum type has no constant
with the specified name
java.lang.NullPointerException
- if the argument is nullpublic static IndexType forName(java.lang.String indexName)
IndexType
for the specified name.
indexName
- The name for which to retrieve the
associated index type.
null
if there is no
such index type.public java.lang.String toString()
IndexType
.
toString
in class java.lang.Enum<IndexType>
IndexType
.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | ENUM CONSTANTS | FIELD | METHOD | DETAIL: ENUM CONSTANTS | FIELD | METHOD |