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

Interface Port

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Port>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.ChildOf<Port>, CommonPort, CommonPortWithMask, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject, org.opendaylight.yangtools.yang.binding.Identifiable<PortKey>
    @Generated("mdsal-binding-generator")
public interface Port
extends org.opendaylight.yangtools.yang.binding.ChildOf<Port>, org.opendaylight.yangtools.yang.binding.Augmentable<Port>, CommonPortWithMask, org.opendaylight.yangtools.yang.binding.Identifiable<PortKey>

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

     list port {
   key port-mod-order;
   leaf port-mod-order {
     type uint32;
   }
   uses common-port-with-mask;
   leaf container-name {
     type string;
   }
   leaf port-name {
     type string;
   }
   leaf barrier {
     type boolean;
   }
 }

    To create instances of this class use PortBuilder.

    See Also:
    PortBuilder, PortKey

    • Field Detail

      • QNAME

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

    • Method Detail

      • implementedInterface

        default Class<Port> implementedInterface()
        Specified by:
        implementedInterface in interface CommonPort
        Specified by:
        implementedInterface in interface CommonPortWithMask
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataContainer
        Specified by:
        implementedInterface in interface org.opendaylight.yangtools.yang.binding.DataObject

      • bindingHashCode

        static int bindingHashCode​(@NonNull Port obj)
        Default implementation of Object.hashCode() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent hashing results across all implementations.
        Parameters:
        obj - Object for which to generate hashCode() result.
        Returns:
        Hash code value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null

      • bindingEquals

        static boolean bindingEquals​(@NonNull Port thisObj,
                             Object obj)
        Default implementation of Object.equals(Object) contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent equality results across all implementations.
        Parameters:
        thisObj - Object acting as the receiver of equals invocation
        obj - Object acting as argument to equals invocation
        Returns:
        True if thisObj and obj are considered equal
        Throws:
        NullPointerException - if thisObj is null

      • bindingToString

        static String bindingToString​(@NonNull Port obj)
        Default implementation of Object.toString() contract for this interface. Implementations of this interface are encouraged to defer to this method to get consistent string representations across all implementations.
        Parameters:
        obj - Object for which to generate toString() result.
        Returns:
        String value of data modeled by this interface.
        Throws:
        NullPointerException - if obj is null

      • key

        PortKey key()
        Specified by:
        key in interface org.opendaylight.yangtools.yang.binding.Identifiable<PortKey>

      • getPortModOrder

        org.opendaylight.yangtools.yang.common.Uint32 getPortModOrder()
        Return portModOrder, or null if it is not present.
        Returns:
        Uint32 portModOrder, or null if it is not present.

      • requirePortModOrder

        default @NonNull org.opendaylight.yangtools.yang.common.Uint32 requirePortModOrder()
        Return portModOrder, guaranteed to be non-null.
        Returns:
        Uint32 portModOrder, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if portModOrder is not present

      • getContainerName

        String getContainerName()
        Return containerName, or null if it is not present.
        Returns:
        String containerName, or null if it is not present.

      • requireContainerName

        default @NonNull String requireContainerName()
        Return containerName, guaranteed to be non-null.
        Returns:
        String containerName, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if containerName is not present

      • getPortName

        String getPortName()
        Return portName, or null if it is not present.
        Returns:
        String portName, or null if it is not present.

      • requirePortName

        default @NonNull String requirePortName()
        Return portName, guaranteed to be non-null.
        Returns:
        String portName, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if portName is not present

      • getBarrier

        Boolean getBarrier()
        Return barrier, or null if it is not present.
        Returns:
        Boolean barrier, or null if it is not present.

      • requireBarrier

        default @NonNull Boolean requireBarrier()
        Return barrier, guaranteed to be non-null.
        Returns:
        Boolean barrier, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if barrier is not present