com.cisco.provisioning.cpe.events
Class SystemConfigEventType

java.lang.Object
  com.cisco.provisioning.cpe.internal.BaseEnum
      com.cisco.provisioning.cpe.events.SystemConfigEventType

All Implemented Interfaces:

Externalizable, Serializable, Comparable

Direct Known Subclasses:

ServerConfigEventType

public class SystemConfigEventType
extends com.cisco.provisioning.cpe.internal.BaseEnum
implements Externalizable

The SystemConfigEventType class provides an enumeration of SystemConfigEventTypes which may be signaled by a SystemConfigEvent.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.cisco.provisioning.cpe.internal.BaseEnum

com.cisco.provisioning.cpe.internal.BaseEnum.CompareDifferentClassEnumException

Field Summary

static SystemConfigEventType	ADD_CLASS_OF_SERVICE Constant for the system configuration event type ADD COS.
static SystemConfigEventType	BPR Constant for the system configuration even type.
static SystemConfigEventType	CablehomeWanData Constant for the system configuration event type CablehomeWanData.
static SystemConfigEventType	CablehomeWanMan Constant for the system configuration event type CablehomeWanMan.
static SystemConfigEventType	Computer Constant for the system configuration event type Computer.
static SystemConfigEventType	CustomCPE Constant for the system configuration event type CustomCPE.
static SystemConfigEventType	CustomPropertyDefs Constant for the system configuration event type CustomPropertyDefs.
static SystemConfigEventType	DELETE_CLASS_OF_SERVICE Constant for the system configuration event type Delete COS.
static SystemConfigEventType	DOCSIS Constant for the system configuration event type DOCSIS.
static SystemConfigEventType	ExtensionPointSettings Constant for the system configuration event type ExtensionPointSettings.
static SystemConfigEventType	LICENSE Constant for the system configuration event type LICENSE.
static SystemConfigEventType	PacketCableMTA Constant for the system configuration event type PacketCableMTA.
static SystemConfigEventType	PUBLISH Constant for the system configuration event type PUBLISH.
static SystemConfigEventType	STB Constant for the system configuration event type STB.
static SystemConfigEventType	TFTP Constant for the system configuration event type TFTP.
static SystemConfigEventType	USER Cosntant for the system configuration event type USER.

Fields inherited from class com.cisco.provisioning.cpe.internal.BaseEnum

NAME, VALUE

Constructor Summary

SystemConfigEventType()
This constructor is needed for externalization.

Method Summary

static SystemConfigEventType	getNamed(String name) Returns the SystemConfigEventType object with the selected name (or null if it does not exist).
static SortedSet	getSortedSet() Return a sorted set of the enumeration codes associated with the enumeration type defined in this class.
static SystemConfigEventType	getValued(int value) Returns the SystemConfigEventType object with the selected value (or null if it does not exist).
static Iterator	iterator() Return an iterator over the enumeration codes associated with the enumeration type defined in this class.
static int	maxVal() Return the maximum ordinal value in this enumeration, or -1 if no enumeration codes are defined.
void	readExternal(ObjectInput in) Externalizable interface.
static int	size() Return an integer giving the total number of enumeration codes associated with this enumeration type.
void	writeExternal(ObjectOutput out) Externalizable interface.

Methods inherited from class com.cisco.provisioning.cpe.internal.BaseEnum

compareNames, compareTo, compareValues, getName, getSortByNameComparator, getValue, toString, toStringWithValue

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

BPR

public static final SystemConfigEventType BPR

Constant for the system configuration even type.

CustomPropertyDefs

public static final SystemConfigEventType CustomPropertyDefs

Constant for the system configuration event type CustomPropertyDefs.

DOCSIS

public static final SystemConfigEventType DOCSIS

Constant for the system configuration event type DOCSIS.

ExtensionPointSettings

public static final SystemConfigEventType ExtensionPointSettings

Constant for the system configuration event type ExtensionPointSettings.

TFTP

public static final SystemConfigEventType TFTP

Constant for the system configuration event type TFTP.

Computer

public static final SystemConfigEventType Computer

Constant for the system configuration event type Computer.

CustomCPE

public static final SystemConfigEventType CustomCPE

Constant for the system configuration event type CustomCPE.

ADD_CLASS_OF_SERVICE

public static final SystemConfigEventType ADD_CLASS_OF_SERVICE

Constant for the system configuration event type ADD COS.

DELETE_CLASS_OF_SERVICE

public static final SystemConfigEventType DELETE_CLASS_OF_SERVICE

Constant for the system configuration event type Delete COS.

PUBLISH

public static final SystemConfigEventType PUBLISH

Constant for the system configuration event type PUBLISH.

LICENSE

public static final SystemConfigEventType LICENSE

Constant for the system configuration event type LICENSE.

USER

public static final SystemConfigEventType USER

Cosntant for the system configuration event type USER.

PacketCableMTA

public static final SystemConfigEventType PacketCableMTA

Constant for the system configuration event type PacketCableMTA.

CablehomeWanMan

public static final SystemConfigEventType CablehomeWanMan

Constant for the system configuration event type CablehomeWanMan.

CablehomeWanData

public static final SystemConfigEventType CablehomeWanData

Constant for the system configuration event type CablehomeWanData.

STB

public static final SystemConfigEventType STB

Constant for the system configuration event type STB.

Constructor Detail

SystemConfigEventType

public SystemConfigEventType()

This constructor is needed for externalization.

Note: This constructor is ONLY used for externalization.

Method Detail

getNamed

public static SystemConfigEventType getNamed(String name)

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

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

Parameters:

name - the name associated with the desired instance of SystemConfigEventType

Returns:

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

getSortedSet

public static SortedSet getSortedSet()

Return a sorted set of the enumeration codes associated with the enumeration type defined in this class.

The set returned does not support modifications. Set methods would modify the set will throw an UnsupportedOperationException.

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

Returns:

a sorted set of the enumeration codes.

getValued

public static SystemConfigEventType getValued(int value)

Returns the SystemConfigEventType object with the selected value (or null if it does not exist).

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

Parameters:

value - the value associated with the desired instance of SystemConfigEventType

Returns:

the SystemConfigEventType object with the selected value (or null if it does not exist).

iterator

public static Iterator iterator()

Return an iterator over the enumeration codes associated with the enumeration type defined in this class.

The iterator returned does not support modifications. The remove method will throw an UnsupportedOperationException.

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

Returns:

an iterator over the enumeration codes.

maxVal

public static int maxVal()

Return the maximum ordinal value in this enumeration, or -1 if no enumeration codes are defined.

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

Returns:

the maximum ordinal value.

size

public static int size()

Return an integer giving the total number of enumeration codes associated with this enumeration type.

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

Returns:

the total number of enumeration codes.

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Externalizable interface. The object implements the readExternal method to restore its contents by calling the methods of DataInput for primitive types and readObject for objects, strings and arrays. The readExternal method must read the values in the same sequence and with the same types as were written by writeExternal.

Specified by:

readExternal in interface Externalizable

Overrides:

readExternal in class com.cisco.provisioning.cpe.internal.BaseEnum

Parameters:

in - the stream to read data from in order to restore the object

Throws:

IOException - if I/O errors occur

ClassNotFoundException - If the class for an object being restored cannot be found.

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Externalizable interface. The object implements the writeExternal method to save its contents by calling the methods of DataOutput for its primitive values or calling the writeObject method of ObjectOutput for objects, strings, and arrays.

Specified by:

writeExternal in interface Externalizable

Overrides:

writeExternal in class com.cisco.provisioning.cpe.internal.BaseEnum

Parameters:

out - the stream to write the object to

Throws:

IOException - Includes any I/O exceptions that may occur