org.onosproject.ui.model.topo

Class UiRegionLink

java.lang.Object

org.onosproject.ui.model.topo.UiElement

org.onosproject.ui.model.topo.UiLink

org.onosproject.ui.model.topo.UiRegionLink

public class UiRegionLink
extends UiLink

Designates a link between two region nodes.

Field Summary

Fields inherited from class org.onosproject.ui.model.topo.UiLink

id, topology

Constructor Summary

Constructors

Constructor and Description
UiRegionLink(UiTopology topology, UiLinkId id) Creates a region to region UI link.

Method Summary

Modifier and Type	Method and Description
java.lang.String	endPointA() Returns the identifier of end-point A in string form.
java.lang.String	endPointB() Returns the identifier of end-point B in string form.
RegionId	regionA() Returns the identity of the first region.
RegionId	regionB() Returns the identity of the second region.

Methods inherited from class org.onosproject.ui.model.topo.UiLink

endPortA, endPortB, id, idAsString, toString, type

Methods inherited from class org.onosproject.ui.model.topo.UiElement

destroy, name

Methods inherited from class java.lang.Object

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

Constructor Detail

UiRegionLink

public UiRegionLink(UiTopology topology,
                    UiLinkId id)

Creates a region to region UI link. Note that it is expected that the link identifier is one that has region IDs as source and destination.

Parameters:

topology - parent topology

id - canonicalized link ID

Throws:

java.lang.IllegalArgumentException - if the link ID is not region-region

Method Detail

endPointA

public java.lang.String endPointA()

Description copied from class: UiLink

Returns the identifier of end-point A in string form.

Specified by:

endPointA in class UiLink

Returns:

end point A identifier

endPointB

public java.lang.String endPointB()

Description copied from class: UiLink

Returns the identifier of end-point B in string form.

Specified by:

endPointB in class UiLink

Returns:

end point B identifier

regionA

public RegionId regionA()

Returns the identity of the first region.

Returns:

first region ID

regionB

public RegionId regionB()

Returns the identity of the second region.

Returns:

second region ID