com.cisco.provisioning.cpe.api
Class MACAddress

java.lang.Object
  com.cisco.provisioning.cpe.api.Key
      com.cisco.provisioning.cpe.api.DeviceID
          com.cisco.provisioning.cpe.api.MACAddress

All Implemented Interfaces:

Serializable

public final class MACAddress
extends DeviceID

Creates a new device identifier using MACAddress.

See Also:

Serialized Form

Field Summary

static long

serialVersionUID Serialization version UID constant for this class

Constructor Summary

MACAddress(String deviceId)
Use this constructor to create a new MACAddress device identifier.

Method Summary

boolean	equals(Object obj) Determines if this MACAddressDeviceID object is equal to the specified object.
KeyType	getKeyType() Get the Key Type of this object.
int	hashCode() The hash code of this object.
boolean	validate() Validate the id string for correct format.

Methods inherited from class com.cisco.provisioning.cpe.api.DeviceID

getDeviceId, getInstance, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

Serialization version UID constant for this class

See Also:

Constant Field Values

Constructor Detail

MACAddress

public MACAddress(String deviceId)

Use this constructor to create a new MACAddress device identifier.

This method will throw an APIArgumentException if the specified MACAddress string identifier is invalid or is specified as null.

Parameters:

deviceId - The string containing the MACAddress identifer. This value is required and cannot be specified as null. If it is specified as null the runtime exception APIArgumentException will be thrown.

Method Detail

equals

public boolean equals(Object obj)

Determines if this MACAddressDeviceID object is equal to the specified object.

Overrides:

equals in class DeviceID

Returns:

true if the specified object is equal to this object. false if the objects are not equal.

getKeyType

public KeyType getKeyType()

Get the Key Type of this object.

Specified by:

getKeyType in class Key

Returns:

the key type of this object.

hashCode

public int hashCode()

The hash code of this object. See Object.hashCode for more information

Overrides:

hashCode in class DeviceID

Returns:

The hascode of this object

validate

public boolean validate()

Validate the id string for correct format.

Specified by:

validate in class DeviceID

Returns:

true if format is valid. false if format is invalid.