Package org.opends.server.types
Enum IndexType
- java.lang.Object
-
- java.lang.Enum<IndexType>
-
- org.opends.server.types.IndexType
-
- All Implemented Interfaces:
Serializable
,Comparable<IndexType>
@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public enum IndexType extends Enum<IndexType>
This class implements an enumeration that may be used to define the ways in which an attribute may be indexed within the 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.ORDERING
Used to denote an ordering index, which may be used to identify entries with one or more values that are less than, equal to or greater than 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).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 String
toString()
Retrieves the human-readable name for this index type.static IndexType
valueOf(String name)
Returns the enum constant of this type with the specified name.static IndexType
valueOf(Matcher.MatcherType matcherType)
Returns theIndexType
associated with the provided comparison matcher type (equality, substrings, greater or equal, less or equal, present, or approximate).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.
-
ORDERING
public static final IndexType ORDERING
Used to denote an ordering index, which may be used to identify entries with one or more values that are less than, equal to or greater than 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(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:
IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is null
-
valueOf
public static IndexType valueOf(Matcher.MatcherType matcherType)
Returns theIndexType
associated with the provided comparison matcher type (equality, substrings, greater or equal, less or equal, present, or approximate).- Parameters:
matcherType
- The comparison matcher type.- Returns:
- The
IndexType
associated with the provided comparison matcher type. - Throws:
IllegalArgumentException
- IfmatcherType
was not a comparison matcher type.
-
-