Package org.onosproject.ui.model.topo

Class UiRegionDeviceLink

  • public class UiRegionDeviceLink
extends UiLink
    Designates a link between a region node and a device.

    • Field Summary

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      DeviceId device()
      Returns the identity of the device.
      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.
      java.lang.String endPortB()
      Returns the port number (as a string) for end-point B, if applicable.
      PortNumber port()
      Returns the identity of the device port.
      RegionId region()
      Returns the identity of the region.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • UiRegionDeviceLink

        public UiRegionDeviceLink​(UiTopology topology,
                          UiLinkId id)
        Creates a region to device UI link. Note that it is expected that the link identifier is one that has a region ID at one end, and a device ID at the other
        Parameters:
        topology - parent topology
        id - canonicalized link identifier
        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

      • endPortB

        public java.lang.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

      • region

        public RegionId region()
        Returns the identity of the region.
        Returns:
        region ID

      • device

        public DeviceId device()
        Returns the identity of the device.
        Returns:
        device ID

      • port

        public PortNumber port()
        Returns the identity of the device port.
        Returns:
        device port number