org.opendaylight.vtn.manager.internal.util.flow

Class VNodeHop

java.lang.Object

org.opendaylight.vtn.manager.internal.util.flow.VNodeHop

public final class VNodeHop
extends Object

VNodeHop describes a hop in the virtual packet routing within the VTN.

The route of the packet from the source to the destination virtual node is represented by a sequence of VNodeHop instances.

Constructor Summary

Constructors

Constructor and Description
VNodeHop() Construct a new instance which indicates the data flow is terminated.
VNodeHop(VNodeIdentifier<?> ident, VirtualRouteReason res) Construct a new instance.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o) Determine whether the given object is identical to this object.
VNodeIdentifier<?>	getPath() Return the location of the virtual node.
VirtualRouteReason	getReason() Return the reason why the packet is forwarded to the virtual node.
int	hashCode() Return the hash code of this object.
VirtualRouteBuilder	toVirtualRouteBuilder() Convert this instance into a VirtualRouteBuilder instance.
static List<VirtualRoute>	toVirtualRouteList(List<VNodeHop> vhops) Convert a list of VNodeHop instances into a list of VirtualRoute instances.

Methods inherited from class java.lang.Object

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

Constructor Detail

VNodeHop

public VNodeHop()

Construct a new instance which indicates the data flow is terminated.

VNodeHop

public VNodeHop(VNodeIdentifier<?> ident,
                VirtualRouteReason res)

Construct a new instance.

Parameters:

ident - A VNodeIdentifier instance that specifies the location of the virtual node inside the VTN.

res - A VirtualRouteReason instance that represents the reason why the packet is forwarded.

Method Detail

toVirtualRouteList

public static List<VirtualRoute> toVirtualRouteList(List<VNodeHop> vhops)

Convert a list of VNodeHop instances into a list of VirtualRoute instances.

Parameters:

vhops - A list of VNodeHop instances.

Returns:

A list of VirtualRoute instances if the given list is not empty. null if empty.

getPath

public VNodeIdentifier<?> getPath()

Return the location of the virtual node.

Returns:

A VNodeIdentifier instance that represents the location of the virtual node. null is returned if this instance indicates that the data flow is terminated without packet forwarding.

getReason

public VirtualRouteReason getReason()

Return the reason why the packet is forwarded to the virtual node.

Returns:

A VirtualRouteReason instance that represents the reason why the packet is forwarded. null is returned if this instance indicates that the data flow is terminated without packet forwarding.

toVirtualRouteBuilder

public VirtualRouteBuilder toVirtualRouteBuilder()

Convert this instance into a VirtualRouteBuilder instance.

Returns:

A VirtualRouteBuilder instance.

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.