@PublicAPI(stability=UNCOMMITTED, mayInstantiate=false, mayExtend=false, mayInvoke=true) public enum IndexType extends Enum<IndexType>
Enum Constant and 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.
|
Modifier and Type | Method and Description |
---|---|
static IndexType |
forName(String indexName)
Retrieves the index type for the specified name.
|
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[] |
values()
Returns an array containing the constants of this enum type, in
the order they are declared.
|
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
public static IndexType[] values()
for (IndexType c : IndexType.values()) System.out.println(c);
public static IndexType valueOf(String name)
name
- the name of the enum constant to be returned.IllegalArgumentException
- if this enum type has no constant with the specified nameNullPointerException
- if the argument is nullpublic static IndexType forName(String indexName)
indexName
- The name for which to retrieve the
associated index type.null
if there is no
such index type.Copyright © 2010-2017 ForgeRock AS. All Rights Reserved.