Package org.opends.server.types

Enum Class IndexType

java.lang.Object
java.lang.Enum<IndexType>
org.opends.server.types.IndexType
All Implemented Interfaces:
Serializable, Comparable<IndexType>, java.lang.constant.Constable
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.

  • Nested Class Summary

    Nested classes/interfaces inherited from class java.lang.Enum

    Enum.EnumDesc<E extends Enum<E>>

  • 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

    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 class with the specified name.
    static IndexType[]
    values()
    Returns an array containing the constants of this enum class, in the order they are declared.

    Methods inherited from class java.lang.Enum

    clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • 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 Details

    • values

      public static IndexType[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared

    • valueOf

      public static IndexType valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name
      NullPointerException - if the argument is null

    • toString

      public String toString()
      Retrieves the human-readable name for this index type.
      Overrides:
      toString in class Enum<IndexType>
      Returns:
      The human-readable name for this index type.