Package org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720

Interface InstructionStatusChanged

All Superinterfaces:
org.opendaylight.yangtools.binding.Augmentable<InstructionStatusChanged>, org.opendaylight.yangtools.binding.BaseNotification, org.opendaylight.yangtools.binding.BindingContract<org.opendaylight.yangtools.binding.DataContainer>, org.opendaylight.yangtools.binding.BindingObject, org.opendaylight.yangtools.binding.DataContainer, org.opendaylight.yangtools.binding.DataObject, org.opendaylight.yangtools.binding.Notification<InstructionStatusChanged>
@Generated("mdsal-binding-generator") public interface InstructionStatusChanged extends org.opendaylight.yangtools.binding.DataObject, org.opendaylight.yangtools.binding.Notification<InstructionStatusChanged>, org.opendaylight.yangtools.binding.Augmentable<InstructionStatusChanged>

This class represents the following YANG schema fragment defined in module programming 

 notification instruction-status-changed {
   leaf id {
     type instruction-id;
   }
   leaf status {
     type instruction-status;
   }
   container details {
     leaf-list unmet-dependencies {
       when "../../status = cancelled";
       type instruction-id;
     }
   }
 }

To create instances of this class use InstructionStatusChangedBuilder.

See Also:

  • Field Details

    • QNAME

      static final @NonNull org.opendaylight.yangtools.yang.common.QName QNAME
      YANG identifier of the statement represented by this class.

  • Method Details

    • getId

      InstructionId getId()
      Return id, or null if it is not present. 
           
         Instruction identifier.
      Returns:
      InstructionId id, or null if it is not present.

    • requireId

      default @NonNull InstructionId requireId()
      Return id, guaranteed to be non-null. 
           
         Instruction identifier.
      Returns:
      InstructionId id, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if id is not present

    • getStatus

      InstructionStatus getStatus()
      Return status, or null if it is not present. 
           
         New status of the instruction.
      Returns:
      InstructionStatus status, or null if it is not present.

    • requireStatus

      default @NonNull InstructionStatus requireStatus()
      Return status, guaranteed to be non-null. 
           
         New status of the instruction.
      Returns:
      InstructionStatus status, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if status is not present

    • getDetails

      Details getDetails()
      Return details, or null if it is not present. 
           
         More details about the instruction state.
      Returns:
      Details details, or null if it is not present.

    • nonnullDetails

      @NonNull Details nonnullDetails()
      Return details, or an empty instance if it is not present.
      Returns:
      Details details, or an empty instance if it is not present.

    • implementedInterface

      default Class<InstructionStatusChanged> 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
      Specified by:
      implementedInterface in interface org.opendaylight.yangtools.binding.Notification<InstructionStatusChanged>

    • bindingHashCode

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