Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.oxm.rev150225.match.entry.value.grouping.match.entry.value.vlan.vid._case

Interface VlanVid

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

    This class represents the following YANG schema fragment defined in module openflow-extensible-match 

     container vlan-vid {
   leaf vlan-vid {
     type uint16;
   }
   leaf cfi-bit {
     type boolean;
   }
   leaf mask {
     type binary;
   }
 }

    To create instances of this class use VlanVidBuilder.

    See Also:
    VlanVidBuilder

    • 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<VlanVid> implementedInterface()
        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 VlanVid 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 VlanVid 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 VlanVid 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

      • getVlanVid

        org.opendaylight.yangtools.yang.common.Uint16 getVlanVid()
        Return vlanVid, or null if it is not present.
        Returns:
        Uint16 vlanVid, or null if it is not present.

      • requireVlanVid

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

      • getCfiBit

        Boolean getCfiBit()
        Return cfiBit, or null if it is not present.
        Returns:
        Boolean cfiBit, or null if it is not present.

      • requireCfiBit

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

      • getMask

        byte[] getMask()
        Return mask, or null if it is not present.
        Returns:
        byte[] mask, or null if it is not present.

      • requireMask

        default byte @NonNull [] requireMask()
        Return mask, guaranteed to be non-null.
        Returns:
        byte[] mask, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if mask is not present