com.unboundid.ldap.sdk.unboundidds.extensions
Enum GetConfigurationType

java.lang.Object
  extended by java.lang.Enum<GetConfigurationType>
      extended by com.unboundid.ldap.sdk.unboundidds.extensions.GetConfigurationType
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<GetConfigurationType>

@ThreadSafety(level=COMPLETELY_THREADSAFE)
public enum GetConfigurationType
extends java.lang.Enum<GetConfigurationType>

NOTE: This class is part of the Commercial Edition of the UnboundID LDAP SDK for Java. It is not available for use in applications that include only the Standard Edition of the LDAP SDK, and is not supported for use in conjunction with non-UnboundID products.
This enum defines the types of configurations that may be obtained using the get configuration extended operation.


Enum Constant Summary
ACTIVE
          The type used to specify the current active configuration.
ARCHIVED
          The type used to specify an archived configuration that was previously in effect.
BASELINE
          The type used to specify the baseline configuration for the current server version.
 
Method Summary
static GetConfigurationType forBERType(byte berType)
          Retrieves the get configuration type value that has the specified BER type.
static GetConfigurationType forIntValue(int intValue)
          Retrieves the get configuration type value that has the specified integer value.
 byte getBERType()
          Retrieves the BER type that should be used when this configuration type needs to be encoded in a get configuration request.
 int getIntValue()
          Retrieves the integer value that should be used when this configuration type needs to be encoded as an enumerated element in a get configuration result.
static GetConfigurationType valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static GetConfigurationType[] 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

ACTIVE

public static final GetConfigurationType ACTIVE
The type used to specify the current active configuration.


BASELINE

public static final GetConfigurationType BASELINE
The type used to specify the baseline configuration for the current server version.


ARCHIVED

public static final GetConfigurationType ARCHIVED
The type used to specify an archived configuration that was previously in effect.

Method Detail

values

public static GetConfigurationType[] 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 (GetConfigurationType c : GetConfigurationType.values())
    System.out.println(c);

Returns:
an array containing the constants of this enum type, in the order they are declared

valueOf

public static GetConfigurationType 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

getBERType

public byte getBERType()
Retrieves the BER type that should be used when this configuration type needs to be encoded in a get configuration request.

Returns:
The BER type that should be used when this configuration type needs to be encoded in a get configuration request.

getIntValue

public int getIntValue()
Retrieves the integer value that should be used when this configuration type needs to be encoded as an enumerated element in a get configuration result.

Returns:
The integer value that should be used when this configuration type needs to be encoded as an enumerated element in a get configuration result.

forBERType

public static GetConfigurationType forBERType(byte berType)
Retrieves the get configuration type value that has the specified BER type.

Parameters:
berType - The BER type for the get configuration type value to retrieve.
Returns:
The get configuration type value for the specified BER type, or null if there is no enum value with the specified BER type.

forIntValue

public static GetConfigurationType forIntValue(int intValue)
Retrieves the get configuration type value that has the specified integer value.

Parameters:
intValue - The integer value for the get configuration type value to retrieve.
Returns:
The get configuration type value for the specified integer value, or null if there is no enum value with the specified integer value.