com.cisco.provisioning.cpe.events
Class ServerConfigEventType

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

All Implemented Interfaces:

Externalizable, Serializable, Comparable

public class ServerConfigEventType
extends SystemConfigEventType
implements Externalizable

The ServerConfigEventType class provides an enumeration of SystemConfigEventTypes which may be signaled by a SystemConfigEvent of subclass SystemConfigListener.SERVER_DEFAULTS_CHANGE.

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 ServerConfigEventType	Agent Constant for the system configuration event type Agent.
static ServerConfigEventType	CNR Constant for the system configuration event type CNR.
static ServerConfigEventType	DPE Constant for the system configuration event type DPE.
static ServerConfigEventType	RDU Constant for the system configuration event type RDU.

Fields inherited from class com.cisco.provisioning.cpe.events.SystemConfigEventType

ADD_CLASS_OF_SERVICE, BPR, CablehomeWanData, CablehomeWanMan, Computer, CustomCPE, CustomPropertyDefs, DELETE_CLASS_OF_SERVICE, DOCSIS, ExtensionPointSettings, LICENSE, PacketCableMTA, PUBLISH, STB, TFTP, USER

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

NAME, VALUE

Constructor Summary

ServerConfigEventType()
Default constructor needed for externalization.

Method Summary

static SystemConfigEventType	getNamed(String name) Returns the ServerConfigEventType 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 ServerConfigEventType 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

Agent

public static final ServerConfigEventType Agent

Constant for the system configuration event type Agent.

CNR

public static final ServerConfigEventType CNR

Constant for the system configuration event type CNR.

DPE

public static final ServerConfigEventType DPE

Constant for the system configuration event type DPE.

RDU

public static final ServerConfigEventType RDU

Constant for the system configuration event type RDU.

Constructor Detail

ServerConfigEventType

public ServerConfigEventType()

Default constructor needed for externalization.

Note: This constructor is ONLY used for externalization. Use the defined constants instead.

Method Detail

getNamed

public static SystemConfigEventType getNamed(String name)

Returns the ServerConfigEventType 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 ServerConfigEventType object.

Parameters:

name - the name associated with the desired instance of ServerConfigEventType

Returns:

the ServerConfigEventType 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 ServerConfigEventType 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 ServerConfigEventType object.

Parameters:

value - the value associated with the desired instance of ServerConfigEventType

Returns:

the ServerConfigEventType 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 SystemConfigEventType

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 SystemConfigEventType

Parameters:

out - the stream to write the object to

Throws:

IOException - Includes any I/O exceptions that may occur