InstructionStatus (programming-api 0.7.1-Carbon API)

java.lang.Object
- java.lang.Enum<InstructionStatus>
- - org.opendaylight.yang.gen.v1.urn.opendaylight.params.xml.ns.yang.programming.rev150720.InstructionStatus

All Implemented Interfaces:

Serializable, Comparable<InstructionStatus>
```
public enum InstructionStatus
extends Enum<InstructionStatus>
```

Enum Constant Summary

Enum Constants
Enum Constant and Description
`Cancelled` The instruction has never executed, or has been executing but all its effects have been rolled back.
`Executing` The instruction is being executed.
`Failed` The instruciton has failed to execute completely, but some of its effects may have been recorded in the state.
`Queued` Its immediate prerequisite intructions have not been resolved.
`Scheduled` All of instruction's prerequisites have been successful and this instruction is ready to be executed, but the resources needed for its execution are not ready.
`Successful` The instruction has executed competely and its effects have been recorded in state.
`Unknown` The instruction has failed to execute within the deadline allocated to it.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static InstructionStatus`	`forValue(int valueArg)`
`int`	`getIntValue()`
`String`	`getName()` Returns the name of the enumeration item as it is specified in the input yang.
`static InstructionStatus`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static InstructionStatus[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - Queued
```
public static final InstructionStatus Queued
```
    Its immediate prerequisite intructions have not been resolved. The instruction can be cancelled. If any of its prerequisites moves to Unknown, Failed or Cancelled state, the instruction itself moves into Cancelled state. Once all of the dependencies move into Successful state, this instruction moves into Scheduled state. If this instruction's deadline passes, it transitions into Cancelled state.
  - Scheduled
```
public static final InstructionStatus Scheduled
```
    All of instruction's prerequisites have been successful and this instruction is ready to be executed, but the resources needed for its execution are not ready. The instruction can be Cancelled. If this instruction's deadline passes, it transitions into Failed state.
  - Executing
```
public static final InstructionStatus Executing
```
    The instruction is being executed. It cannot be Cancelled on request. If the execution does not complete within the specified deadline, this instruction moves into Unknown state. If the instruction's execution completes within the deadline, it moves into Successful, Failed or Cancelled state, based on the effects it has had on state.
  - Cancelled
```
public static final InstructionStatus Cancelled
```
    The instruction has never executed, or has been executing but all its effects have been rolled back. System state is such as if the instruction never executed.
  - Failed
```
public static final InstructionStatus Failed
```
    The instruciton has failed to execute completely, but some of its effects may have been recorded in the state. A full state resynchronization is required to recover from this failure, and even then an operator intervention may be required (if, for example the effect is not representable in exposed abstractions).
  - Successful
```
public static final InstructionStatus Successful
```
    The instruction has executed competely and its effects have been recorded in state.
  - Unknown
```
public static final InstructionStatus Unknown
```
    The instruction has failed to execute within the deadline allocated to it. It's effects on the state are unknown at this point, but can be assumed to either atomically happen or not-happen. This state is transient and the instruction will eventually (at some indeterminate point in the future) enter either Successful, Failed or Cancelled state.
- Method Detail
  - values
```
public static InstructionStatus[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (InstructionStatus c : InstructionStatus.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static InstructionStatus valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - getName
```
public String getName()
```
    Returns the name of the enumeration item as it is specified in the input yang.
    
    Returns:
    
    the name of the enumeration item as it is specified in the input yang
  - getIntValue
```
public int getIntValue()
```
    Returns:
    
    integer value
  - forValue
```
public static InstructionStatus forValue(int valueArg)
```
    Parameters:
    
    valueArg -
    
    Returns:
    
    corresponding InstructionStatus item

Enum InstructionStatus

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

Queued

Scheduled

Executing

Cancelled

Failed

Successful

Unknown

Method Detail

values

valueOf

getName

getIntValue

forValue