Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.bmp.message.rev200120.peer.down.data

Interface FsmEventCode

All Superinterfaces:
org.opendaylight.yangtools.binding.Augmentable<FsmEventCode>, org.opendaylight.yangtools.binding.BindingContract<org.opendaylight.yangtools.binding.DataContainer>, org.opendaylight.yangtools.binding.BindingObject, org.opendaylight.yangtools.binding.ChoiceIn<PeerDown>, Data, org.opendaylight.yangtools.binding.DataContainer, org.opendaylight.yangtools.binding.DataObject
@Generated("mdsal-binding-generator") public interface FsmEventCode extends Data, org.opendaylight.yangtools.binding.DataObject, org.opendaylight.yangtools.binding.Augmentable<FsmEventCode>

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

    Methods inherited from interface org.opendaylight.yangtools.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<FsmEventCode> implementedInterface()
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.binding.BindingContract<org.opendaylight.yangtools.binding.DataContainer>
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.binding.DataObject

    • bindingHashCode

      static int bindingHashCode(@NonNull FsmEventCode 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 FsmEventCode 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 FsmEventCode 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

    • getFsmEventCode

      org.opendaylight.yangtools.yang.common.Uint16 getFsmEventCode()
      Return fsmEventCode, or null if it is not present. 
           
         Containing the code corresponding to the FSM Event which caused the system to
         close the session. Two bytes both set to zero are used to indicate that no
         relevant Event code is defined.
      Returns:
      Uint16 fsmEventCode, or null if it is not present.

    • requireFsmEventCode

      default @NonNull org.opendaylight.yangtools.yang.common.Uint16 requireFsmEventCode()
      Return fsmEventCode, guaranteed to be non-null. 
           
         Containing the code corresponding to the FSM Event which caused the system to
         close the session. Two bytes both set to zero are used to indicate that no
         relevant Event code is defined.
      Returns:
      Uint16 fsmEventCode, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if fsmEventCode is not present