Enum Class IndexEntry.IndexMatchType

java.lang.Object
java.lang.Enum<IndexEntry.IndexMatchType>
com.isode.dsapi.config.IndexEntry.IndexMatchType
All Implemented Interfaces:
Serializable, Comparable<IndexEntry.IndexMatchType>, Constable
Enclosing class:
IndexEntry

public static enum IndexEntry.IndexMatchType extends Enum<IndexEntry.IndexMatchType>
Index match types.
  • Enum Constant Details

  • Method Details

    • values

      public static IndexEntry.IndexMatchType[] 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 IndexEntry.IndexMatchType 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
    • getIndexMatchType

      public static IndexEntry.IndexMatchType getIndexMatchType(String shortStr)
      Return matching type for the string.
      Parameters:
      shortStr - given short string
      Returns:
      Matching type or UNKNOWN_MATCH if not found
    • toString

      public String toString()
      Return the "friendly" String representation of this type, for example, "Approximate".
      Overrides:
      toString in class Enum<IndexEntry.IndexMatchType>
      Returns:
      a String representation of this value; never null.
    • getShortName

      public String getShortName()
      Return the abbreviated String representation of this type, for example, "approx".
      Returns:
      a short String representing this type; never null.