com.cisco.provisioning.cpe.extensions.configuration
Enum DHCPDict

java.lang.Object
  java.lang.Enum<DHCPDict>
      com.cisco.provisioning.cpe.extensions.configuration.DHCPDict

All Implemented Interfaces:

Serializable, Comparable<DHCPDict>

public enum DHCPDict
extends Enum<DHCPDict>

Enumerated type for specifying DHCPConfig dictionary type.

Enum Constant Summary

ENVIRONMENT
DHCPConfig Environment dictionary identifier.

INFORM
DHCPConfig Inform dictionary identifier.

PREDNS_ENVIRONMENT
DHCPConfig pre-dns-add-forward environment identifier.

RELAY_REQUEST
DHCPConfig Relay-forward request dictionary identifier.

RELAY_RESPONSE
DHCPConfig Relay-reply response dictionary identifier.

REQUEST
DHCPConfig Request dictionary identifier.

RESERVED_0
Reserved for future use.

RESPONSE
DHCPConfig Response dictionary identifier.

Method Summary

boolean	isAvailable(Capabilities capabilities) Returns true if this DHCPDict is available in the given provisioning group.
static DHCPDict	valueOf(String name) Returns the enum constant of this type with the specified name.
static DHCPDict[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

RESERVED_0

public static final DHCPDict RESERVED_0

Reserved for future use.

REQUEST

public static final DHCPDict REQUEST

DHCPConfig Request dictionary identifier.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V1 or greater.

RESPONSE

public static final DHCPDict RESPONSE

DHCPConfig Response dictionary identifier.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V1 or greater.

ENVIRONMENT

public static final DHCPDict ENVIRONMENT

DHCPConfig Environment dictionary identifier.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V1 or greater.

PREDNS_ENVIRONMENT

public static final DHCPDict PREDNS_ENVIRONMENT

DHCPConfig pre-dns-add-forward environment identifier.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V1 or greater.

INFORM

public static final DHCPDict INFORM

DHCPConfig Inform dictionary identifier.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V1 or greater.

RELAY_REQUEST

public static final DHCPDict RELAY_REQUEST

DHCPConfig Relay-forward request dictionary identifier.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V3 or greater.

RELAY_RESPONSE

public static final DHCPDict RELAY_RESPONSE

DHCPConfig Relay-reply response dictionary identifier.

Requires the provisioning group to be enabled for ProvGroupCapabilitiesKeys.DHCP_CONFIGURATION_V3 or greater.

Method Detail

values

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

Returns:

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

valueOf

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

isAvailable

public boolean isAvailable(Capabilities capabilities)

Returns true if this DHCPDict is available in the given provisioning group. Otherwise returns false.

Parameters:

capabilities - the available capabilities.

Returns:

true if this DHCPDict is available in the given provisioning group. Otherwise returns false.