Enum Class 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>
,Constable
,org.opendaylight.yangtools.binding.BindingObject
,org.opendaylight.yangtools.binding.EnumTypeObject
,org.opendaylight.yangtools.binding.TypeObject
@Generated("mdsal-binding-generator")
public enum InstructionStatus
extends Enum<InstructionStatus>
implements org.opendaylight.yangtools.binding.EnumTypeObject
This class represents the following YANG schema fragment defined in module programming
typedef instruction-status { type enumeration { enum queued { } enum scheduled { } enum executing { } enum cancelled { } enum failed { } enum successful { } enum unknown { } } }
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>>
-
Enum Constant Summary
Enum ConstantDescriptionThe instruction has never executed, or has been executing but all its effects have been rolled back.The instruction is being executed.The instruciton has failed to execute completely, but some of its effects may have been recorded in the state.Its immediate prerequisite intructions have not been resolved.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 has executed competely and its effects have been recorded in state.The instruction has failed to execute within the deadline allocated to it. -
Method Summary
Modifier and TypeMethodDescriptionstatic @Nullable InstructionStatus
Return the enumeration member whosegetName()
matches specified assigned name.static @Nullable InstructionStatus
forValue
(int intValue) Return the enumeration member whosegetIntValue()
matches specified value.int
@NonNull String
getName()
static @NonNull InstructionStatus
Return the enumeration member whosegetName()
matches specified assigned name.static @NonNull InstructionStatus
ofValue
(int intValue) Return the enumeration member whosegetIntValue()
matches specified value.static InstructionStatus
Returns the enum constant of this class with the specified name.static InstructionStatus[]
values()
Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
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
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
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
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
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
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. 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 Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified nameNullPointerException
- if the argument is null
-
getName
- Specified by:
getName
in interfaceorg.opendaylight.yangtools.binding.EnumTypeObject
-
getIntValue
public int getIntValue()- Specified by:
getIntValue
in interfaceorg.opendaylight.yangtools.binding.EnumTypeObject
-
forName
Return the enumeration member whosegetName()
matches specified assigned name.- Parameters:
name
- YANG assigned name- Returns:
- corresponding InstructionStatus item, or
null
if no such item exists - Throws:
NullPointerException
- ifname
is null
-
forValue
Return the enumeration member whosegetIntValue()
matches specified value.- Parameters:
intValue
- integer value- Returns:
- corresponding InstructionStatus item, or
null
if no such item exists
-
ofName
Return the enumeration member whosegetName()
matches specified assigned name.- Parameters:
name
- YANG assigned name- Returns:
- corresponding InstructionStatus item
- Throws:
NullPointerException
- ifname
is nullIllegalArgumentException
- ifname
does not match any item
-
ofValue
Return the enumeration member whosegetIntValue()
matches specified value.- Parameters:
intValue
- integer value- Returns:
- corresponding InstructionStatus item
- Throws:
IllegalArgumentException
- ifintValue
does not match any item
-