Enum IndexType
- java.lang.Object
-
- java.lang.Enum<IndexType>
-
- com.unboundid.directory.sdk.ds.types.IndexType
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Comparable<IndexType>
@ThreadSafety(level=COMPLETELY_THREADSAFE) public enum IndexType extends java.lang.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
Enum Constants Enum Constant Description 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
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static IndexType
forName(java.lang.String indexName)
Retrieves theIndexType
for the specified name.java.lang.String
toString()
Retrieves the human-readable name for thisIndexType
.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.
-
-
-
Enum Constant Detail
-
PRESENCE
public static final IndexType 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).
-
EQUALITY
public static final IndexType EQUALITY
Used to denote an equality index, which may be used to identify entries containing a specified value for the associated attribute.
-
SUBSTRING
public static final IndexType 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. That substring assertion may contain any or all of subInitial, subAny, and subFinal elements.
-
SUBINITIAL
public static final IndexType 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.
-
SUBANY
public static final IndexType 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
public static final IndexType 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.
-
GREATER_OR_EQUAL
public static final IndexType 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
public static final IndexType 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.
-
APPROXIMATE
public static final IndexType 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.
-
-
Method Detail
-
values
public static IndexType[] 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 (IndexType c : IndexType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static IndexType 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 namejava.lang.NullPointerException
- if the argument is null
-
forName
public static IndexType forName(java.lang.String indexName)
Retrieves theIndexType
for the specified name.- Parameters:
indexName
- The name for which to retrieve the associated index type.- Returns:
- The requested index type, or
null
if there is no such index type.
-
-