Package org.ldaptive

Enum DerefAliases

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<DerefAliases>

    public enum DerefAliases
    extends java.lang.Enum<DerefAliases>
    Enum to define how aliases are dereferenced.
    Author:
    Middleware Services
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      ALWAYS
      dereference when searching for the starting entry and when searching the entries beneath the starting point.
      FINDING
      dereference when searching for the starting entry but not when searching the entries beneath the starting point.
      NEVER
      never dereference aliases.
      SEARCHING
      dereference when searching the entries beneath the starting point but not when searching for the starting entry.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static DerefAliases valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static DerefAliases[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      • Methods inherited from class java.lang.Enum

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait
    • Enum Constant Detail

      • NEVER

        public static final DerefAliases NEVER
        never dereference aliases.
      • SEARCHING

        public static final DerefAliases SEARCHING
        dereference when searching the entries beneath the starting point but not when searching for the starting entry.
      • FINDING

        public static final DerefAliases FINDING
        dereference when searching for the starting entry but not when searching the entries beneath the starting point.
      • ALWAYS

        public static final DerefAliases ALWAYS
        dereference when searching for the starting entry and when searching the entries beneath the starting point.
    • Method Detail

      • values

        public static DerefAliases[] 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 (DerefAliases c : DerefAliases.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static DerefAliases 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 name
        java.lang.NullPointerException - if the argument is null