com.cisco.provisioning.cpe.api.search
Class MACAddressPattern

java.lang.Object
  com.cisco.provisioning.cpe.api.search.Pattern
      com.cisco.provisioning.cpe.api.search.DeviceIDPattern
          com.cisco.provisioning.cpe.api.search.MACAddressPattern

All Implemented Interfaces:

Serializable

public final class MACAddressPattern
extends DeviceIDPattern
implements Serializable

Creates a new pattern for matching MAC Addresses

See Also:

Serialized Form

Field Summary

static long

serialVersionUID

Constructor Summary

MACAddressPattern(String pattern)
Use this constructor to create a new MACAddressPattern This method will throw an APIArgumentException if the specified pattern is invalid or is specified as null.

Method Summary

boolean	equals(Object obj) Determines if this MACAddressPattern object is equal to the specified object.
int	hashCode() The hash code of this object.

Methods inherited from class com.cisco.provisioning.cpe.api.search.DeviceIDPattern

toString

Methods inherited from class com.cisco.provisioning.cpe.api.search.Pattern

getPattern

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

public static final long serialVersionUID

See Also:

Constant Field Values

Constructor Detail

MACAddressPattern

public MACAddressPattern(String pattern)

Use this constructor to create a new MACAddressPattern

This method will throw an APIArgumentException if the specified pattern is invalid or is specified as null. A valid pattern is a non-null String that begins with the type and length MAC address prefix, include 0 or more bytes to match against, and end with a single asterisk (*). Partial octet end of the string is not allowed.
The following are VALID MAC address patterns:

• 1,6,*
• 1,6,00:00:*
• 1,6,00:00:00:00:00:00
• 1,1,aa
• *

The following are INVALID MAC address patterns:

• 1,6,*00:00
• 1,*,00:00:00
• 1,6,*:00:00*
• 1,6,00:0*

Parameters:

pattern - A valid string to match items against. This value is required and cannot be specified as null. If it is specified as null or if it is an invalid regex pattern the runtime exception APIArgumentException will be thrown.

Method Detail

hashCode

public int hashCode()

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

Overrides:

hashCode in class DeviceIDPattern

Returns:

The hascode of this object

equals

public boolean equals(Object obj)

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

Overrides:

equals in class DeviceIDPattern

Returns:

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