Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.common.instruction.rev130731.instruction.grouping.instruction.choice.write.metadata._case

Interface WriteMetadata

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

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

     container write-metadata {
   leaf metadata {
     type binary;
   }
   leaf metadata-mask {
     type binary;
   }
 }
    The schema path to identify an instance is openflow-instructioninstruction-groupinginstruction-choicewrite-metadata-casewrite-metadata

    To create instances of this class use WriteMetadataBuilder.

    See Also:
    WriteMetadataBuilder

    • Field Detail

      • QNAME

        static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME

    • Method Detail

      • implementedInterface

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

      • getMetadataMask

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

      • requireMetadataMask

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