org.opendaylight.vtn.manager.internal.util.inventory

Class SalNode

java.lang.Object

org.opendaylight.vtn.manager.internal.util.inventory.SalNode

Direct Known Subclasses:

SalPort

public class SalNode
extends Object

This class represents SAL node identifier corresponding to OpenFlow switch.

Field Summary

Fields

Modifier and Type	Field and Description
protected static char	MD_ID_SEPARATOR Separator of Node/NodeConnector ID.

Constructor Summary

Constructors

Constructor and Description
SalNode(long id) Construct a new instance.
SalNode(long id, String str) Construct a new instance with specifying a string representation of this instance.

Method Summary

Modifier and Type	Method and Description
static SalNode	checkedCreate(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId nid) Convert the given MD-SAL node ID into a SalNode instance with value checking.
static SalNode	checkedCreate(String id) Convert a string representation of MD-SAL node ID into a SalNode instance with value checking.
static SalNode	create(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId id) Convert a MD-SAL node ID into a SalNode instance.
static SalNode	create(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey key) Convert a MD-SAL node key into a SalNode instance.
static SalNode	create(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef ref) Convert a MD-SAL node reference into a SalNode instance.
static SalNode	create(String id) Convert a string representation of MD-SAL node ID into a SalNode instance.
boolean	equals(Object o) Determine whether the given object is identical to this object.
boolean	equalsNode(SalNode snode) Determine whether the given node has the same node number or not.
org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow>	getFlowIdentifier(Short tid, org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId fid) Return an instance identifier for the specified MD-SAL flow entry.
org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode>	getFlowNodeIdentifier() Return an instance identifier that specifies flow-capable-node for the node corresponding to this instance.
org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table>	getFlowTableIdentifier(Short tid) Return an instance identifier for the specified flow table in the node corresponding to this instance.
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId	getNodeId() Return a NodeId instance corresponding to this instance.
org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node>	getNodeIdentifier() Return an instance identifier that specifies MD-SAL node instance.
protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node>	getNodeIdentifierBuilder() Return an instance identifier builder that contains an instance identifier for a MD-SAL node.
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey	getNodeKey() Return a NodeKey instance corresponding to this instance.
long	getNodeNumber() Return a node number.
org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef	getNodeRef() Return a NodeRef instance corresponding to this instance.
org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnNode>	getVtnNodeIdentifier() Return an instance identifier for a VTN node associated with this instance.
protected org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder<VtnNode>	getVtnNodeIdentifierBuilder() Return an instance identifier builder that contains an instance identifier for a VTN node.
VtnNodeKey	getVtnNodeKey() Return a VtnNodeKey instance corresponding to this instance.
int	hashCode() Return the hash code of this object.
String	toNodeString() Return a string which identifies the switch corresponding to this instance.
protected StringBuilder	toNodeStringBuilder() Return a StringBuilder instance that contains a string representation of a node identifier.
String	toString() Return a string representation of this object.
protected StringBuilder	toStringBuilder() Return a StringBuilder instance that contains a string representation of this instance.

Methods inherited from class java.lang.Object

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

Field Detail

MD_ID_SEPARATOR

protected static final char MD_ID_SEPARATOR

Separator of Node/NodeConnector ID.

See Also:

Constant Field Values

Constructor Detail

SalNode

public SalNode(long id)

Construct a new instance.

Parameters:

id - A node identifier.

SalNode

public SalNode(long id,
               String str)

Construct a new instance with specifying a string representation of this instance.

Parameters:

id - A node identifier.

str - A string representation of this instance.

Method Detail

create

public static final SalNode create(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId id)

Convert a MD-SAL node ID into a SalNode instance.

Parameters:

id - A NodeId instance.

Returns:

A SalNode instance on success. null on failure.

create

public static final SalNode create(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef ref)

Convert a MD-SAL node reference into a SalNode instance.

Parameters:

ref - A NodeRef instance.

Returns:

A SalNode instance on success. null on failure.

create

public static final SalNode create(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey key)

Convert a MD-SAL node key into a SalNode instance.

Parameters:

key - A NodeKey instance.

Returns:

A SalNode instance on success. null on failure.

create

public static SalNode create(String id)

Convert a string representation of MD-SAL node ID into a SalNode instance.

Parameters:

id - A string representation of MD-SAL node ID.

Returns:

A SalNode instance on success. null on failure.

checkedCreate

public static SalNode checkedCreate(org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId nid)
                             throws RpcException

Convert the given MD-SAL node ID into a SalNode instance with value checking.

Parameters:

nid - A NodeId instance.

Returns:

A SalNode instance.

Throws:

RpcException - An invalid node ID is passed to nid.

checkedCreate

public static SalNode checkedCreate(String id)
                             throws RpcException

Convert a string representation of MD-SAL node ID into a SalNode instance with value checking.

Parameters:

id - A string representation of MD-SAL node ID.

Returns:

A SalNode instance.

Throws:

RpcException - An invalid node ID is passed to id.

getNodeNumber

public final long getNodeNumber()

Return a node number.

Returns:

A node identifier.

getNodeId

public final org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeId getNodeId()

Return a NodeId instance corresponding to this instance.

Returns:

A NodeId instance.

getNodeKey

public final org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.NodeKey getNodeKey()

Return a NodeKey instance corresponding to this instance.

Returns:

A NodeKey instance.

getNodeRef

public org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.NodeRef getNodeRef()

Return a NodeRef instance corresponding to this instance.

Returns:

An NodeRef instance.

getNodeIdentifier

public final org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node> getNodeIdentifier()

Return an instance identifier that specifies MD-SAL node instance.

Returns:

An instance identifier for a MD-SAL node.

getFlowNodeIdentifier

public final org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowCapableNode> getFlowNodeIdentifier()

Return an instance identifier that specifies flow-capable-node for the node corresponding to this instance.

Returns:

An instance identifier for the flow-capable-node.

getFlowTableIdentifier

public final org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.Table> getFlowTableIdentifier(Short tid)

Return an instance identifier for the specified flow table in the node corresponding to this instance.

Parameters:

tid - Identifier for the table.

Returns:

An instance identifier for the specified flow table.

getFlowIdentifier

public final org.opendaylight.yangtools.yang.binding.InstanceIdentifier<org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.tables.table.Flow> getFlowIdentifier(Short tid,
                                                                                                                                                                                    org.opendaylight.yang.gen.v1.urn.opendaylight.flow.inventory.rev130819.FlowId fid)

Return an instance identifier for the specified MD-SAL flow entry.

Parameters:

tid - The identifier for the flow table.

fid - The identifier for the flow entry.

Returns:

An instance identifier for the specified MD-SAL flow entry.

getVtnNodeKey

public final VtnNodeKey getVtnNodeKey()

Return a VtnNodeKey instance corresponding to this instance.

Returns:

A VtnNodeKey instance.

getVtnNodeIdentifier

public final org.opendaylight.yangtools.yang.binding.InstanceIdentifier<VtnNode> getVtnNodeIdentifier()

Return an instance identifier for a VTN node associated with this instance.

Returns:

An instance identifier for a VTN node.

toNodeString

public String toNodeString()

Return a string which identifies the switch corresponding to this instance.

Returns:

A string which identifies the switch.

equalsNode

public final boolean equalsNode(SalNode snode)

Determine whether the given node has the same node number or not.

Parameters:

snode - A SalNode instance to be compared.

Returns:

true only if the given node has the same node number as this instance.

toStringBuilder

protected StringBuilder toStringBuilder()

Return a StringBuilder instance that contains a string representation of this instance.

Returns:

A StringBuilder instance.

toNodeStringBuilder

protected final StringBuilder toNodeStringBuilder()

Return a StringBuilder instance that contains a string representation of a node identifier.

Returns:

A StringBuilder instance.

getNodeIdentifierBuilder

protected final org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder<org.opendaylight.yang.gen.v1.urn.opendaylight.inventory.rev130819.nodes.Node> getNodeIdentifierBuilder()

Return an instance identifier builder that contains an instance identifier for a MD-SAL node.

Returns:

An instance identifier builder for a MD-SAL node.

getVtnNodeIdentifierBuilder

protected final org.opendaylight.yangtools.yang.binding.InstanceIdentifier.InstanceIdentifierBuilder<VtnNode> getVtnNodeIdentifierBuilder()

Return an instance identifier builder that contains an instance identifier for a VTN node.

Returns:

An instance identifier builder for a VTN node.

equals

public boolean equals(Object o)

Determine whether the given object is identical to this object.

Overrides:

equals in class Object

Parameters:

o - An object to be compared.

Returns:

true if identical. Otherwise false.

hashCode

public int hashCode()

Return the hash code of this object.

Overrides:

hashCode in class Object

Returns:

The hash code.

toString

public final String toString()

Return a string representation of this object.

This method returns a string representation of MD-SAL node identifier.

Overrides:

toString in class Object

Returns:

A string representation of this object.