Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflow.protocol.rev130731

Interface OfHeader

All Superinterfaces:
org.opendaylight.yangtools.yang.binding.BindingContract<org.opendaylight.yangtools.yang.binding.DataContainer>, org.opendaylight.yangtools.yang.binding.BindingObject, org.opendaylight.yangtools.yang.binding.DataContainer, org.opendaylight.yangtools.yang.binding.DataObject
All Known Subinterfaces:
AsyncConfigMessage, BarrierInput, BarrierOutput, BarrierReply, BarrierRequest, EchoInput, EchoOutput, EchoReply$G, EchoReplyInput, EchoRequest, EchoRequestMessage, Error, ErrorMessage, ExperimenterInput, ExperimenterMessage, ExperimenterOfMessage, FeaturesReply, FeaturesRequest, FlowMessage, FlowMod$G, FlowModCaseData, FlowModInput, FlowRemoved, FlowRemovedMessage, GetAsyncInput, GetAsyncOutput, GetAsyncReply, GetAsyncRequest, GetConfigInput, GetConfigOutput, GetConfigReply, GetConfigRequest, GetFeaturesInput, GetFeaturesOutput, GetQueueConfigInput, GetQueueConfigOutput, GroupMessage, GroupMod$G, GroupModCaseData, GroupModInput, Hello$G, HelloInput, HelloMessage, MeterMessage, MeterMod$G, MeterModInput, MultipartHeader, MultipartReply, MultipartReply, MultipartReplyMessage, MultipartRequest, MultipartRequest$G, MultipartRequestInput, PacketIn, PacketInMessage, PacketInMessage, PacketOut$G, PacketOutInput, PortMessage, PortMod$G, PortModCaseData, PortModInput, PortStatus, PortStatusMessage, QueueGetConfigReply, QueueGetConfigRequest, RoleReply, RoleRequest$G, RoleRequestInput, RoleRequestOutput, SetAsync$G, SetAsyncInput, SetConfig$G, SetConfigInput, TableMod$G, TableModInput
@Generated("mdsal-binding-generator") public interface OfHeader extends org.opendaylight.yangtools.yang.binding.DataObject

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

 grouping ofHeader {
   leaf version {
     type uint8;
   }
   leaf xid {
     type uint32;
   }
 }

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final @NonNull org.opendaylight.yangtools.yang.common.QName
    QNAME
    YANG identifier of the statement represented by this class.

  • Method Summary

    Modifier and Type
    Method
    Description
    org.opendaylight.yangtools.yang.common.Uint8
    getVersion()
    Return version, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint32
    getXid()
    Return xid, or null if it is not present.
    Class<? extends OfHeader>
    implementedInterface()
     
    default @NonNull org.opendaylight.yangtools.yang.common.Uint8
    requireVersion()
    Return version, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint32
    requireXid()
    Return xid, guaranteed to be non-null.

  • 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

      Class<? extends OfHeader> 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

    • getVersion

      org.opendaylight.yangtools.yang.common.Uint8 getVersion()
      Return version, or null if it is not present. 
           
         OpenFlow version
      Returns:
      Uint8 version, or null if it is not present.

    • requireVersion

      default @NonNull org.opendaylight.yangtools.yang.common.Uint8 requireVersion()
      Return version, guaranteed to be non-null. 
           
         OpenFlow version
      Returns:
      Uint8 version, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if version is not present

    • getXid

      org.opendaylight.yangtools.yang.common.Uint32 getXid()
      Return xid, or null if it is not present. 
           
         Transaction ID
      Returns:
      Uint32 xid, or null if it is not present.

    • requireXid

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