com.hp.sdn.node

Class DefaultNodeFilter

java.lang.Object

com.hp.sdn.node.DefaultNodeFilter

All Implemented Interfaces:

NodeFilter

public class DefaultNodeFilter
extends Object
implements NodeFilter

Default implementation of NodeFilter which allows matching against any field in the Node. Any field which is specified will be considered a part of the match.

Note that some fields permit matching against a 'null' value. A match against 'null' means that the value is unknown. The following matches can be performed against a 'null' value:

• name(String)
• supplierId(SupplierId)
• intf(Interface)
• mac(MacAddress)
• cp(ConnectionPoint)
• deviceId(DeviceId)

Any attempt to match against 'null' for a field not specified above will yield an IllegalArgumentException.

Author:

Shaun Wackerly

Constructor Summary

Constructors

Constructor and Description
DefaultNodeFilter() Constructs a node filter which will match against any node.

Method Summary

Methods

Modifier and Type	Method and Description
DefaultNodeFilter	cp(ConnectionPoint cp) Modifies the current filter to match nodes with the given connection point.
DefaultNodeFilter	deviceId(DeviceId deviceId) Modifies the current filter to match nodes with the given device ID.
DefaultNodeFilter	id(NodeId id) Modifies the current filter to match the node with the given ID.
DefaultNodeFilter	intf(Interface intf) Modifies the current filter to match nodes with the given interface.
DefaultNodeFilter	ip(IpAddress ip) Modifies the current filter to match nodes with the given IP address.
DefaultNodeFilter	ip(IpRange range) Modifies the current filter to match nodes within the given IP range.
DefaultNodeFilter	mac(MacAddress mac) Modifies the current filter to match nodes with the given MAC.
DefaultNodeFilter	mac(MacRange range) Modifies the current filter to match nodes within the given MAC range.
boolean	matches(Node node) Returns whether the given node matches this filter or not.
DefaultNodeFilter	name(String name) Modifies the current filter to match nodes with the given name.
DefaultNodeFilter	segmentId(SegmentId segmentId) Modifies the current filter to match nodes with the given segment ID.
DefaultNodeFilter	supplierId(SupplierId supplierId) Modifies the current filter to match nodes with the given supplier ID.
DefaultNodeFilter	timeout(long timeout) Modifies the current filter to match nodes with the given timeout.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

DefaultNodeFilter

public DefaultNodeFilter()

Constructs a node filter which will match against any node.

Method Detail

matches

public boolean matches(Node node)

Description copied from interface: NodeFilter

Returns whether the given node matches this filter or not.

Specified by:

matches in interface NodeFilter

Parameters:

node - the given node

Returns:

true if the node matches, false if not

id

public DefaultNodeFilter id(NodeId id)

Modifies the current filter to match the node with the given ID.

Parameters:

id - node ID

Returns:

self, for chaining

Throws:

IllegalArgumentException - if an invalid ID is specified

name

public DefaultNodeFilter name(String name)

Modifies the current filter to match nodes with the given name.

Parameters:

name - node name

Returns:

self, for chaining

supplierId

public DefaultNodeFilter supplierId(SupplierId supplierId)

Modifies the current filter to match nodes with the given supplier ID.

Parameters:

supplierId - node supplier ID

Returns:

self, for chaining

ip

public DefaultNodeFilter ip(IpAddress ip)

Modifies the current filter to match nodes with the given IP address.

Parameters:

ip - node IP address

Returns:

self, for chaining

Throws:

IllegalArgumentException - if an invalid IP is specified

ip

public DefaultNodeFilter ip(IpRange range)

Modifies the current filter to match nodes within the given IP range.

Parameters:

range - node IP range

Returns:

self, for chaining

Throws:

IllegalArgumentException - if an invalid range is specified

segmentId

public DefaultNodeFilter segmentId(SegmentId segmentId)

Modifies the current filter to match nodes with the given segment ID.

Parameters:

segmentId - node segment ID

Returns:

self, for chaining

Throws:

IllegalArgumentException - if an invalid segment ID is specified

intf

public DefaultNodeFilter intf(Interface intf)

Modifies the current filter to match nodes with the given interface.

Parameters:

intf - node interface

Returns:

self, for chaining

mac

public DefaultNodeFilter mac(MacAddress mac)

Modifies the current filter to match nodes with the given MAC.

Parameters:

mac - node MAC address

Returns:

self, for chaining

mac

public DefaultNodeFilter mac(MacRange range)

Modifies the current filter to match nodes within the given MAC range.

Parameters:

range - node MAC address range

Returns:

self, for chaining

Throws:

IllegalArgumentException - if an invalid range is specified

cp

public DefaultNodeFilter cp(ConnectionPoint cp)

Modifies the current filter to match nodes with the given connection point. To match any port on a given device, use deviceId(DeviceId).

Parameters:

cp - node connection point

Returns:

self, for chaining

deviceId

public DefaultNodeFilter deviceId(DeviceId deviceId)

Modifies the current filter to match nodes with the given device ID. To match a specific port on a given device, use cp(ConnectionPoint).

Parameters:

deviceId - node device ID

Returns:

self, for chaining

timeout

public DefaultNodeFilter timeout(long timeout)

Modifies the current filter to match nodes with the given timeout.

Parameters:

timeout - node timeout

Returns:

self, for chaining

toString

public String toString()

Overrides:

toString in class Object