Package org.onosproject.net.optical.device

Class OmsPortHelper

  • @Beta
public final class OmsPortHelper
extends java.lang.Object
    OMS port related helpers.

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.util.Optional<OmsPort> asOmsPort​(org.onosproject.net.Port port)  
      static org.onosproject.net.device.PortDescription omsPortDescription​(org.onosproject.net.device.PortDescription base, org.onlab.util.Frequency minFrequency, org.onlab.util.Frequency maxFrequency, org.onlab.util.Frequency grid, org.onosproject.net.SparseAnnotations annotations)
      Creates OMS port description based on the supplied information.
      static org.onosproject.net.device.PortDescription omsPortDescription​(org.onosproject.net.PortNumber number, boolean isEnabled, org.onlab.util.Frequency minFrequency, org.onlab.util.Frequency maxFrequency, org.onlab.util.Frequency grid)
      Creates OMS port description based on the supplied information.
      static org.onosproject.net.device.PortDescription omsPortDescription​(org.onosproject.net.PortNumber number, boolean isEnabled, org.onlab.util.Frequency minFrequency, org.onlab.util.Frequency maxFrequency, org.onlab.util.Frequency grid, org.onosproject.net.SparseAnnotations annotations)
      Creates OMS port description based on the supplied information.
      static org.onosproject.net.Annotations stripHandledAnnotations​(org.onosproject.net.Annotations input)
      Returns Annotations not used by the port type projection.

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • omsPortDescription

        public static org.onosproject.net.device.PortDescription omsPortDescription​(org.onosproject.net.PortNumber number,
                                                                            boolean isEnabled,
                                                                            org.onlab.util.Frequency minFrequency,
                                                                            org.onlab.util.Frequency maxFrequency,
                                                                            org.onlab.util.Frequency grid,
                                                                            org.onosproject.net.SparseAnnotations annotations)
        Creates OMS port description based on the supplied information.
        Parameters:
        number - port number
        isEnabled - port enabled state
        minFrequency - minimum frequency
        maxFrequency - maximum frequency
        grid - grid spacing frequency
        annotations - key/value annotations map
        Returns:
        port description

      • omsPortDescription

        public static org.onosproject.net.device.PortDescription omsPortDescription​(org.onosproject.net.PortNumber number,
                                                                            boolean isEnabled,
                                                                            org.onlab.util.Frequency minFrequency,
                                                                            org.onlab.util.Frequency maxFrequency,
                                                                            org.onlab.util.Frequency grid)
        Creates OMS port description based on the supplied information.
        Parameters:
        number - port number
        isEnabled - port enabled state
        minFrequency - minimum frequency
        maxFrequency - maximum frequency
        grid - grid spacing frequency
        Returns:
        port description

      • omsPortDescription

        public static org.onosproject.net.device.PortDescription omsPortDescription​(org.onosproject.net.device.PortDescription base,
                                                                            org.onlab.util.Frequency minFrequency,
                                                                            org.onlab.util.Frequency maxFrequency,
                                                                            org.onlab.util.Frequency grid,
                                                                            org.onosproject.net.SparseAnnotations annotations)
        Creates OMS port description based on the supplied information.
        Parameters:
        base - PortDescription to get basic information from
        minFrequency - minimum frequency
        maxFrequency - maximum frequency
        grid - grid spacing frequency
        annotations - key/value annotations map
        Returns:
        port description

      • asOmsPort

        public static java.util.Optional<OmsPort> asOmsPort​(org.onosproject.net.Port port)

      • stripHandledAnnotations

        public static org.onosproject.net.Annotations stripHandledAnnotations​(org.onosproject.net.Annotations input)
        Returns Annotations not used by the port type projection.
        Parameters:
        input - Annotations
        Returns:
        filtered view of given Annotations