Package org.opendaylight.yang.gen.v1.urn.opendaylight.flow.types.port.rev130925

Interface CommonPort

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
All Known Subinterfaces:
CommonPortWithMask, FlowCapableNodeConnector, FlowCapableNodeConnectorUpdated, FlowCapableNodeConnectorUpdateFields, FlowCapablePort, FlowNodeConnector, FlowPortStatus, Port, PortMessage, Ports
@Generated("mdsal-binding-generator") public interface CommonPort extends org.opendaylight.yangtools.yang.binding.DataObject

This class represents the following YANG schema fragment defined in module opendaylight-port-types 

 grouping common-port {
   leaf port-number {
     type port-number-uni;
   }
   leaf hardware-address {
     type yang:mac-address;
   }
   leaf configuration {
     type port-config;
   }
   leaf advertised-features {
     type port-features;
   }
 }

  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • implementedInterface

      Class<? extends CommonPort> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

    • getPortNumber

      PortNumberUni getPortNumber()
      Return portNumber, or null if it is not present.
      Returns:
      PortNumberUni portNumber, or null if it is not present.

    • requirePortNumber

      default @NonNull PortNumberUni requirePortNumber()
      Return portNumber, guaranteed to be non-null.
      Returns:
      PortNumberUni portNumber, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if portNumber is not present

    • getHardwareAddress

      org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress getHardwareAddress()
      Return hardwareAddress, or null if it is not present. 
           
         MAC Address of the port
      Returns:
      MacAddress hardwareAddress, or null if it is not present.

    • requireHardwareAddress

      default @NonNull org.opendaylight.yang.gen.v1.urn.ietf.params.xml.ns.yang.ietf.yang.types.rev130715.MacAddress requireHardwareAddress()
      Return hardwareAddress, guaranteed to be non-null. 
           
         MAC Address of the port
      Returns:
      MacAddress hardwareAddress, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if hardwareAddress is not present

    • getConfiguration

      PortConfig getConfiguration()
      Return configuration, or null if it is not present. 
           
         Bit map of OFPPC-* flags
      Returns:
      PortConfig configuration, or null if it is not present.

    • requireConfiguration

      default @NonNull PortConfig requireConfiguration()
      Return configuration, guaranteed to be non-null. 
           
         Bit map of OFPPC-* flags
      Returns:
      PortConfig configuration, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if configuration is not present

    • getAdvertisedFeatures

      PortFeatures getAdvertisedFeatures()
      Return advertisedFeatures, or null if it is not present. 
           
         Features being advertised by the port
      Returns:
      PortFeatures advertisedFeatures, or null if it is not present.

    • requireAdvertisedFeatures

      default @NonNull PortFeatures requireAdvertisedFeatures()
      Return advertisedFeatures, guaranteed to be non-null. 
           
         Features being advertised by the port
      Returns:
      PortFeatures advertisedFeatures, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if advertisedFeatures is not present