Package com.unboundid.util

Enum DebugType

java.lang.Object
java.lang.Enum<DebugType>
com.unboundid.util.DebugType
All Implemented Interfaces:
Serializable, Comparable<DebugType>, java.lang.constant.Constable
@ThreadSafety(level=COMPLETELY_THREADSAFE) public enum DebugType extends Enum<DebugType>
This enumeration defines a set of debugging types that are used by the LDAP SDK.

  • 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
    ASN1
    The debug type that will be used for debugging information about ASN.1 elements written to or read from a directory server.
    CODING_ERROR
    The debug type that will be used for information about coding errors or other types of incorrect uses of the LDAP SDK.
    CONNECT
    The debug type that will be used for debugging information about connection establishment and termination.
    CONNECTION_POOL
    The debug type that will be used for information about connection pool interaction.
    EXCEPTION
    The debug type that will be used for debugging information about exceptions that are caught.
    LDAP
    The debug type that will be used for debugging information about LDAP requests sent to or received from a directory server.
    LDIF
    The debug type that will be used for debugging information about LDIF entries or change records read or written.
    MONITOR
    The debug type that will be used for information about monitor entry parsing.
    OTHER
    The debug type that will be used for debug messages not applicable to any of the other categories.

  • Method Summary

    Modifier and Type
    Method
    Description
    static DebugType
    forName(String name)
    Retrieves the debug type with the specified name.
    String
    getName()
    Retrieves the name for this debug type.
    static String
    getTypeNameList()
    Retrieves a comma-delimited list of the defined debug type names.
    String
    toString()
    Retrieves a string representation of this debug type.
    static DebugType
    valueOf(String name)
    Returns the enum constant of this type with the specified name.
    static DebugType[]
    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, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

    Methods inherited from class java.lang.Object

    getClass, notify, notifyAll, wait, wait, wait

  • Enum Constant Details

    • ASN1

      public static final DebugType ASN1
      The debug type that will be used for debugging information about ASN.1 elements written to or read from a directory server.

    • CONNECT

      public static final DebugType CONNECT
      The debug type that will be used for debugging information about connection establishment and termination.

    • EXCEPTION

      public static final DebugType EXCEPTION
      The debug type that will be used for debugging information about exceptions that are caught.

    • LDAP

      public static final DebugType LDAP
      The debug type that will be used for debugging information about LDAP requests sent to or received from a directory server.

    • CONNECTION_POOL

      public static final DebugType CONNECTION_POOL
      The debug type that will be used for information about connection pool interaction.

    • LDIF

      public static final DebugType LDIF
      The debug type that will be used for debugging information about LDIF entries or change records read or written.

    • MONITOR

      public static final DebugType MONITOR
      The debug type that will be used for information about monitor entry parsing.

    • CODING_ERROR

      public static final DebugType CODING_ERROR
      The debug type that will be used for information about coding errors or other types of incorrect uses of the LDAP SDK.

    • OTHER

      public static final DebugType OTHER
      The debug type that will be used for debug messages not applicable to any of the other categories.

  • Method Details

    • values

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

    • valueOf

      public static DebugType 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 name
      NullPointerException - if the argument is null

    • getName

      @NotNull public String getName()
      Retrieves the name for this debug type.
      Returns:
      The name for this debug type.

    • forName

      @Nullable public static DebugType forName(@NotNull String name)
      Retrieves the debug type with the specified name.
      Parameters:
      name - The name of the debug type to retrieve. It must not be null.
      Returns:
      The requested debug type, or null if there is no such debug type.

    • getTypeNameList

      @NotNull public static String getTypeNameList()
      Retrieves a comma-delimited list of the defined debug type names.
      Returns:
      A comma-delimited list of the defined debug type names.

    • toString

      @NotNull public String toString()
      Retrieves a string representation of this debug type.
      Overrides:
      toString in class Enum<DebugType>
      Returns:
      A string representation of this debug type.