Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowplugin.extension.nicira.action.rev140714.nx.action.output.reg.grouping

Interface NxOutputReg

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

This class represents the following YANG schema fragment defined in module openflowplugin-extension-nicira-action 

 container nx-output-reg {
   container src {
     uses src-choice-grouping;
     leaf ofs_nbits {
       type uint16;
     }
   }
   leaf max_len {
     type uint16;
   }
 }

To create instances of this class use NxOutputRegBuilder.

See Also:

  • 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
    static boolean
    bindingEquals(@NonNull NxOutputReg thisObj, Object obj)
    Default implementation of Object.equals(Object) contract for this interface.
    static int
    bindingHashCode(@NonNull NxOutputReg obj)
    Default implementation of Object.hashCode() contract for this interface.
    static String
    bindingToString(@NonNull NxOutputReg obj)
    Default implementation of Object.toString() contract for this interface.
    org.opendaylight.yangtools.yang.common.Uint16
    getMaxLen()
    Return maxLen, or null if it is not present.
    Src
    getSrc()
    Return src, or null if it is not present.
    default Class<NxOutputReg>
    implementedInterface()
     
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    requireMaxLen()
    Return maxLen, guaranteed to be non-null.

    Methods inherited from interface org.opendaylight.yangtools.yang.binding.Augmentable

    augmentation, augmentationOrElseThrow, augmentationOrElseThrow, augmentations

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

    • getSrc

      Src getSrc()
      Return src, or null if it is not present. 
           
         Choose the register with the OpenFlow output port, using the number of bits
         specified from the register.
      Returns:
      Src src, or null if it is not present.

    • getMaxLen

      org.opendaylight.yangtools.yang.common.Uint16 getMaxLen()
      Return maxLen, or null if it is not present. 
           
         The number of bytes to send when the chosen port is OFPP_CONTROLLER
      Returns:
      Uint16 maxLen, or null if it is not present.

    • requireMaxLen

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireMaxLen()
      Return maxLen, guaranteed to be non-null. 
           
         The number of bytes to send when the chosen port is OFPP_CONTROLLER
      Returns:
      Uint16 maxLen, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if maxLen is not present