org.onosproject.ui.model.topo

Class UiEdgeLink

java.lang.Object

org.onosproject.ui.model.topo.UiElement

org.onosproject.ui.model.topo.UiLink

org.onosproject.ui.model.topo.UiEdgeLink

public class UiEdgeLink
extends UiLink

Designates a link between a device and a host; that is, an edge link.

Field Summary

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

id, topology

Constructor Summary

Constructors

Constructor and Description
UiEdgeLink(UiTopology topology, UiLinkId id) Creates a UI link.

Method Summary

Modifier and Type	Method and Description
void	attachEdgeLink(EdgeLink elink) Attaches the given edge link to this UI link.
protected void	destroy() Removes all external references, and prepares the instance for garbage collection.
String	endPointA() Returns the identifier of end-point A in string form.
String	endPointB() Returns the identifier of end-point B in string form.
String	endPortB() Returns the port number (as a string) for end-point B, if applicable.

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

endPortA, id, idAsString, toString, type

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

name

Methods inherited from class java.lang.Object

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

Constructor Detail

UiEdgeLink

public UiEdgeLink(UiTopology topology,
                  UiLinkId id)

Creates a UI link.

Parameters:

topology - parent topology

id - canonicalized link identifier

Method Detail

endPointA

public 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 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

endPortB

public String endPortB()

Description copied from class: UiLink

Returns the port number (as a string) for end-point B, if applicable. This default implementation returns null, indicating not-applicable. Subclasses only need to override this method if end-point B has an associated port.

Overrides:

endPortB in class UiLink

Returns:

port number for end-point B

destroy

protected void destroy()

Description copied from class: UiElement

Removes all external references, and prepares the instance for garbage collection. This default implementation does nothing.

Overrides:

destroy in class UiElement

attachEdgeLink

public void attachEdgeLink(EdgeLink elink)

Attaches the given edge link to this UI link. This method will throw an exception if this UI link is not representative of the supplied link.

Parameters:

elink - edge link to attach

Throws:

IllegalArgumentException - if the link is not appropriate