Package org.opendaylight.yang.gen.v1.urn.opendaylight.openflowjava.nx.action.rev140421.ofj.nx.action.learn.grouping

Interface NxActionLearn

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

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

 container nx-action-learn {
   leaf idle-timeout {
     type uint16;
   }
   leaf hard-timeout {
     type uint16;
   }
   leaf priority {
     type uint16;
   }
   leaf cookie {
     type uint64;
   }
   leaf flags {
     type uint16;
   }
   leaf table-id {
     type uint8;
   }
   leaf fin-idle-timeout {
     type uint16;
   }
   leaf fin-hard-timeout {
     type uint16;
   }
   list flow-mods {
     uses flow-mod-spec;
   }
 }

To create instances of this class use NxActionLearnBuilder.

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 NxActionLearn thisObj, Object obj)
    Default implementation of Object.equals(Object) contract for this interface.
    static int
    bindingHashCode(@NonNull NxActionLearn obj)
    Default implementation of Object.hashCode() contract for this interface.
    static String
    bindingToString(@NonNull NxActionLearn obj)
    Default implementation of Object.toString() contract for this interface.
    org.opendaylight.yangtools.yang.common.Uint64
    getCookie()
    Return cookie, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint16
    getFinHardTimeout()
    Return finHardTimeout, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint16
    getFinIdleTimeout()
    Return finIdleTimeout, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint16
    getFlags()
    Return flags, or null if it is not present.
    @Nullable List<FlowMods>
    getFlowMods()
    Return flowMods, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint16
    getHardTimeout()
    Return hardTimeout, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint16
    getIdleTimeout()
    Return idleTimeout, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint16
    getPriority()
    Return priority, or null if it is not present.
    org.opendaylight.yangtools.yang.common.Uint8
    getTableId()
    Return tableId, or null if it is not present.
    default Class<NxActionLearn>
    implementedInterface()
     
    default @NonNull List<FlowMods>
    nonnullFlowMods()
    Return flowMods, or an empty list if it is not present.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint64
    requireCookie()
    Return cookie, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    requireFinHardTimeout()
    Return finHardTimeout, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    requireFinIdleTimeout()
    Return finIdleTimeout, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    requireFlags()
    Return flags, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    requireHardTimeout()
    Return hardTimeout, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    requireIdleTimeout()
    Return idleTimeout, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint16
    requirePriority()
    Return priority, guaranteed to be non-null.
    default @NonNull org.opendaylight.yangtools.yang.common.Uint8
    requireTableId()
    Return tableId, 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<NxActionLearn> 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 NxActionLearn 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 NxActionLearn 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 NxActionLearn 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

    • getIdleTimeout

      org.opendaylight.yangtools.yang.common.Uint16 getIdleTimeout()
      Return idleTimeout, or null if it is not present.
      Returns:
      Uint16 idleTimeout, or null if it is not present.

    • requireIdleTimeout

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireIdleTimeout()
      Return idleTimeout, guaranteed to be non-null.
      Returns:
      Uint16 idleTimeout, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if idleTimeout is not present

    • getHardTimeout

      org.opendaylight.yangtools.yang.common.Uint16 getHardTimeout()
      Return hardTimeout, or null if it is not present.
      Returns:
      Uint16 hardTimeout, or null if it is not present.

    • requireHardTimeout

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireHardTimeout()
      Return hardTimeout, guaranteed to be non-null.
      Returns:
      Uint16 hardTimeout, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if hardTimeout is not present

    • getPriority

      org.opendaylight.yangtools.yang.common.Uint16 getPriority()
      Return priority, or null if it is not present.
      Returns:
      Uint16 priority, or null if it is not present.

    • requirePriority

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requirePriority()
      Return priority, guaranteed to be non-null.
      Returns:
      Uint16 priority, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if priority is not present

    • getCookie

      org.opendaylight.yangtools.yang.common.Uint64 getCookie()
      Return cookie, or null if it is not present.
      Returns:
      Uint64 cookie, or null if it is not present.

    • requireCookie

      default @NonNull org.opendaylight.yangtools.yang.common.Uint64 requireCookie()
      Return cookie, guaranteed to be non-null.
      Returns:
      Uint64 cookie, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if cookie is not present

    • getFlags

      org.opendaylight.yangtools.yang.common.Uint16 getFlags()
      Return flags, or null if it is not present.
      Returns:
      Uint16 flags, or null if it is not present.

    • requireFlags

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireFlags()
      Return flags, guaranteed to be non-null.
      Returns:
      Uint16 flags, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if flags is not present

    • getTableId

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

    • requireTableId

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

    • getFinIdleTimeout

      org.opendaylight.yangtools.yang.common.Uint16 getFinIdleTimeout()
      Return finIdleTimeout, or null if it is not present.
      Returns:
      Uint16 finIdleTimeout, or null if it is not present.

    • requireFinIdleTimeout

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireFinIdleTimeout()
      Return finIdleTimeout, guaranteed to be non-null.
      Returns:
      Uint16 finIdleTimeout, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if finIdleTimeout is not present

    • getFinHardTimeout

      org.opendaylight.yangtools.yang.common.Uint16 getFinHardTimeout()
      Return finHardTimeout, or null if it is not present.
      Returns:
      Uint16 finHardTimeout, or null if it is not present.

    • requireFinHardTimeout

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireFinHardTimeout()
      Return finHardTimeout, guaranteed to be non-null.
      Returns:
      Uint16 finHardTimeout, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if finHardTimeout is not present

    • getFlowMods

      @Nullable List<FlowMods> getFlowMods()
      Return flowMods, or null if it is not present.
      Returns:
      List<FlowMods> flowMods, or null if it is not present.

    • nonnullFlowMods

      default @NonNull List<FlowMods> nonnullFlowMods()
      Return flowMods, or an empty list if it is not present.
      Returns:
      List<FlowMods> flowMods, or an empty list if it is not present.