Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731.async.body.grouping

Interface PacketInMask

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

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

 list packet-in-mask {
   leaf-list mask {
     type oft:packet-in-reason;
   }
 }

To create instances of this class use PacketInMaskBuilder.

See Also:

  • 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

      default Class<PacketInMask> 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

    • bindingHashCode

      static int bindingHashCode(@NonNull PacketInMask 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 PacketInMask 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 PacketInMask 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

    • getMask

      @Nullable Set<PacketInReason> getMask()
      Return mask, or null if it is not present.
      Returns:
      Set<PacketInReason> mask, or null if it is not present.

    • requireMask

      default @NonNull Set<PacketInReason> requireMask()
      Return mask, guaranteed to be non-null.
      Returns:
      Set<PacketInReason> mask, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if mask is not present