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

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

All Implemented Interfaces:

Serializable, Comparable<OptionSyntax>

public enum OptionSyntax
extends Enum<OptionSyntax>

Enumerated type for specifying DOCSIS custom option type. Custom options are those options that have no option description that describes them. Instead, custom options have explicit pre-defined syntax type that identifies the TLV encoding implementation. Each enumerated value is specified using a public static reference. Each syntax value has an integer equivalents, starting at zero (getValue() method) and a string value equal to the enumerated type (toString()).

See Also:

DOCSISOptionFactory, OptionValue

Enum Constant Summary

ASCII
Custom ascii option.

COMPOUND
Custom compound option

HEX
Custom hex option

IPADDRESS
Custom IP address option

NOLV
Custom option (number only, no length/value)

SNMP
Custom snmp option

Method Summary

String	toString() Returns the textual representation of this object.
static OptionSyntax	valueOf(String name) Returns the enum constant of this type with the specified name.
static OptionSyntax[]	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

HEX

public static final OptionSyntax HEX

Custom hex option

ASCII

public static final OptionSyntax ASCII

Custom ascii option.

IPADDRESS

public static final OptionSyntax IPADDRESS

Custom IP address option

NOLV

public static final OptionSyntax NOLV

Custom option (number only, no length/value)

COMPOUND

public static final OptionSyntax COMPOUND

Custom compound option

SNMP

public static final OptionSyntax SNMP

Custom snmp option

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Returns the textual representation of this object.

Overrides:

toString in class Enum<OptionSyntax>

Returns:

the textual representation of this object.