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

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

All Implemented Interfaces:

Serializable, Comparable<OptionDescType>

public enum OptionDescType
extends Enum<OptionDescType>

Enumerated type for specifying DOCSIS option technology. This value is passed to the DOCSIS OptionManager and DOCSIS Template Parser to determine the allowable options and formats for file encoding/decoding. The enumerated values have integer equivalents, starting at zero.

Enum Constant Summary

CABLEHOME10
OptionDescType CableHome 1.0 identifier.

DOCSIS10
OptionDescType DOCSIS 1.0 identifier.

DOCSIS11
OptionDescType DOCSIS 1.1 identifier.

DOCSIS20
OptionDescType DOCSIS 2.0 identifier.

DOCSIS30
OptionDescType DOCSIS 3.0 identifier.

PKTCBL10
OptionDescType PacketCable 1.0 identifier.

Method Summary

static OptionDescType	getNamed(String name) Returns the OptionDescType object with the given name (or null if it does not exist).
static OptionDescType	getTechnologyDefault(TechnologyType technology) Return the OptionDescType default for the matching technology identifier.
TechnologyType	getTechnologyType() Return the technology type associated with this OptionDescType instance.
static OptionDescType	getTechnologyVersion(TechnologyType technology, String version) Return the OptionDescType matching the given technology and version.
String	getVersionString() Return the version string of this OptionDescType instance.
boolean	isAvailable(Capabilities capabilities) Returns true if this DHCPSpecialValue is available in the given provisioning group.
String	toString() Returns the textual representation of this object.
static OptionDescType	valueOf(String name) Returns the enum constant of this type with the specified name.
static OptionDescType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DOCSIS10

public static final OptionDescType DOCSIS10

OptionDescType DOCSIS 1.0 identifier.

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

DOCSIS11

public static final OptionDescType DOCSIS11

OptionDescType DOCSIS 1.1 identifier.

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

PKTCBL10

public static final OptionDescType PKTCBL10

OptionDescType PacketCable 1.0 identifier.

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

CABLEHOME10

public static final OptionDescType CABLEHOME10

OptionDescType CableHome 1.0 identifier.

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

DOCSIS20

public static final OptionDescType DOCSIS20

OptionDescType DOCSIS 2.0 identifier.

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

DOCSIS30

public static final OptionDescType DOCSIS30

OptionDescType DOCSIS 3.0 identifier.

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

Method Detail

values

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

Returns:

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

valueOf

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

getNamed

public static OptionDescType getNamed(String name)

Returns the OptionDescType object with the given name (or null if it does not exist).

Parameters:

name - the name associated with the desired instance of OptionDescType.

Returns:

the OptionDescType object with the given name (or null if it does not exist).

getTechnologyVersion

public static OptionDescType getTechnologyVersion(TechnologyType technology,
                                                  String version)

Return the OptionDescType matching the given technology and version.

Parameters:

technology - Technology type

version - version string (major.minor)

Returns:

OptionDescType or null if not found

getTechnologyDefault

public static OptionDescType getTechnologyDefault(TechnologyType technology)

Return the OptionDescType default for the matching technology identifier. Every supported technology has a default grammar version, often the latest grammar version (with latest functionality/TLVs), is the default supported.

Note: This method is for internal BAC use only. Please use the constants defined on this class to retrieve the desired object.

Parameters:

technology - identifier (see TechnologyType)

Returns:

the OptionDescType object with the selected name (or null if it does not exist).

toString

public String toString()

Returns the textual representation of this object.

Overrides:

toString in class Enum<OptionDescType>

Returns:

the textual representation of this object.

getVersionString

public String getVersionString()

Return the version string of this OptionDescType instance. Returns the major.minor version as String object. Call this method when an OptionDescType instance is provided and version number is needed.

Returns:

version string

getTechnologyType

public TechnologyType getTechnologyType()

Return the technology type associated with this OptionDescType instance.

Returns:

TechnologyType

isAvailable

public boolean isAvailable(Capabilities capabilities)

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

Parameters:

capabilities - the available capabilities.

Returns:

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