com.hp.sdn.model

Class DefaultNodeInfo

java.lang.Object

com.hp.sdn.model.AbstractModelInfo<NodeInfo.Field>

com.hp.sdn.model.DefaultNodeInfo

All Implemented Interfaces:

ModelInfo<NodeInfo.Field>, NodeInfo

public class DefaultNodeInfo
extends AbstractModelInfo<NodeInfo.Field>
implements NodeInfo

Default implementation of NodeInfo. Any data which is not explicitly specified (even if null) will be considered unspecified.

Author:

Shaun Wackerly

Nested Class Summary

Nested classes/interfaces inherited from interface com.hp.sdn.model.NodeInfo

NodeInfo.Field

Constructor Summary

Constructors

Constructor and Description
DefaultNodeInfo() Constructs a default node info object with all fields unspecified.
DefaultNodeInfo(Node node) Constructs a default node info object from the given node.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
int	hashCode()
NodeLocation	location() Returns the most recent node location.
DefaultNodeInfo	location(NodeLocation location) Modifies the current info by specifying the node location.
MacAddress	mac() Returns the node's MAC address.
DefaultNodeInfo	mac(MacAddress mac) Modifies the current info by specifying the node MAC address.
Interface	netInterface() Returns the network interface through which the node attaches to the network.
DefaultNodeInfo	netInterface(Interface intf) Modifies the current info by specifying the node interface.
long	timeout() Returns the time offset (in seconds) at which the node will be removed.
DefaultNodeInfo	timeout(long timeout) Modifies the current info by specifying the node timeout.
String	toString()
NetworkElement.Type	type() Returns the node type.

Methods inherited from class com.hp.sdn.model.AbstractModelInfo

dirtyFields, markDirty

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.hp.sdn.model.ModelInfo

dirtyFields

Constructor Detail

DefaultNodeInfo

public DefaultNodeInfo()

Constructs a default node info object with all fields unspecified.

DefaultNodeInfo

public DefaultNodeInfo(Node node)

Constructs a default node info object from the given node. All fields specified in the node will be specified in the info object.

Parameters:

node - the given node

Method Detail

netInterface

public DefaultNodeInfo netInterface(Interface intf)

Modifies the current info by specifying the node interface. To clear the interface, specify null.

Parameters:

intf - node interface

Returns:

self, for chaining

mac

public DefaultNodeInfo mac(MacAddress mac)

Modifies the current info by specifying the node MAC address. To clear the MAC address, specify null.

Parameters:

mac - node mac

Returns:

self, for chaining

timeout

public DefaultNodeInfo timeout(long timeout)

Modifies the current info by specifying the node timeout.

Parameters:

timeout - node timeout in seconds

Returns:

self, for chaining

location

public DefaultNodeInfo location(NodeLocation location)

Modifies the current info by specifying the node location. To clear the node location, specify null.

Parameters:

location - node location

Returns:

self, for chaining

type

public NetworkElement.Type type()

Description copied from interface: NodeInfo

Returns the node type. If the type has not been specified, then null is returned.

Specified by:

type in interface NodeInfo

Returns:

node type; null if unspecified

netInterface

public Interface netInterface()

Description copied from interface: NodeInfo

Returns the network interface through which the node attaches to the network. This is an interface on the node itself, not the interface on a Device to which the node is attached.

Specified by:

netInterface in interface NodeInfo

Returns:

node network interface; null if unspecified

mac

public MacAddress mac()

Description copied from interface: NodeInfo

Returns the node's MAC address. If the MAC has not been specified, then null is returned.

Specified by:

mac in interface NodeInfo

Returns:

node MAC; null if unspecified

location

public NodeLocation location()

Description copied from interface: NodeInfo

Returns the most recent node location. If the location has not been specified, then null is returned.

Specified by:

location in interface NodeInfo

Returns:

node location; null if unspecified

timeout

public long timeout()

Description copied from interface: NodeInfo

Returns the time offset (in seconds) at which the node will be removed. A value of Long.MAX_VALUE indicates an infinite offset, which means the node will never be automatically removed. A value of 0 indicates that the value has not been specified.

Specified by:

timeout in interface NodeInfo

Returns:

node removal time offset, in seconds

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object