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

Interface Instruction

All Superinterfaces:
org.opendaylight.yangtools.binding.Augmentable<Instruction>, org.opendaylight.yangtools.binding.BindingContract<org.opendaylight.yangtools.binding.DataContainer>, org.opendaylight.yangtools.binding.BindingObject, org.opendaylight.yangtools.binding.ChildOf<InstructionQueue>, org.opendaylight.yangtools.binding.DataContainer, org.opendaylight.yangtools.binding.DataObject, org.opendaylight.yangtools.binding.EntryObject<Instruction,InstructionKey>, org.opendaylight.yangtools.binding.KeyAware<InstructionKey>
@Generated("mdsal-binding-generator") public interface Instruction extends org.opendaylight.yangtools.binding.ChildOf<InstructionQueue>, org.opendaylight.yangtools.binding.EntryObject<Instruction,InstructionKey>
List of all instructions known to the scheduler.

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

 list instruction {
   config false;
   leaf id {
     type instruction-id;
   }
   key id;
   leaf status {
     type instruction-status;
   }
   leaf deadline {
     type nanotime;
   }
 }

To create instances of this class use InstructionBuilder.

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

    • implementedInterface

      default Class<Instruction> 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 Instruction 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 Instruction 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 Instruction 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

    • key

      InstructionKey key()
      Specified by:
      key in interface org.opendaylight.yangtools.binding.KeyAware<InstructionKey>

    • getId

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

    • requireId

      default @NonNull InstructionId requireId()
      Return id, guaranteed to be non-null.
      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.
      Returns:
      InstructionStatus status, or null if it is not present.

    • requireStatus

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

    • getDeadline

      Nanotime getDeadline()
      Return deadline, or null if it is not present.
      Returns:
      Nanotime deadline, or null if it is not present.

    • requireDeadline

      default @NonNull Nanotime requireDeadline()
      Return deadline, guaranteed to be non-null.
      Returns:
      Nanotime deadline, guaranteed to be non-null.
      Throws:
      NoSuchElementException - if deadline is not present