Enum InstructionStatus
- 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>
,org.opendaylight.yangtools.yang.binding.BindingObject
,org.opendaylight.yangtools.yang.binding.Enumeration
,org.opendaylight.yangtools.yang.binding.TypeObject
@Generated("mdsal-binding-generator") public enum InstructionStatus extends Enum<InstructionStatus> implements org.opendaylight.yangtools.yang.binding.Enumeration
-
-
Enum Constant Summary
Enum Constants Enum Constant 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 Description static Optional<InstructionStatus>
forName(String name)
Return the enumeration member whosegetName()
matches specified value.static InstructionStatus
forValue(int intValue)
Return the enumeration member whosegetIntValue()
matches specified value.int
getIntValue()
String
getName()
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.
-
-
-
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 nameNullPointerException
- if the argument is null
-
getName
public String getName()
- Specified by:
getName
in interfaceorg.opendaylight.yangtools.yang.binding.Enumeration
-
getIntValue
public int getIntValue()
- Specified by:
getIntValue
in interfaceorg.opendaylight.yangtools.yang.binding.Enumeration
-
forName
public static Optional<InstructionStatus> forName(String name)
Return the enumeration member whosegetName()
matches specified value.- Parameters:
name
- YANG assigned name- Returns:
- corresponding InstructionStatus item, if present
- Throws:
NullPointerException
- ifname
is null
-
forValue
public static InstructionStatus forValue(int intValue)
Return the enumeration member whosegetIntValue()
matches specified value.- Parameters:
intValue
- integer value- Returns:
- corresponding InstructionStatus item, or null if no such item exists
-
-