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

Interface Metadata

  • All Superinterfaces:
    org.opendaylight.yangtools.yang.binding.Augmentable<Metadata>, 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 Metadata
extends org.opendaylight.yangtools.yang.binding.ChildOf<MatchEntryValueGrouping>, org.opendaylight.yangtools.yang.binding.Augmentable<Metadata>

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

     container metadata {
   leaf metadata {
     type binary;
   }
   leaf mask {
     type binary;
   }
 }

    To create instances of this class use MetadataBuilder.

    See Also:
    MetadataBuilder

    • 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<Metadata> 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 Metadata 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 Metadata 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 Metadata 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

      • getMetadata

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

      • requireMetadata

        default byte @NonNull [] requireMetadata()
        Return metadata, guaranteed to be non-null.
        Returns:
        byte[] metadata, guaranteed to be non-null.
        Throws:
        NoSuchElementException - if metadata 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