Package com.scaleoutsoftware.digitaltwin.core

Enum Class TimerActionResult

java.lang.Object

java.lang.Enum<TimerActionResult>

com.scaleoutsoftware.digitaltwin.core.TimerActionResult

All Implemented Interfaces:

Serializable, Comparable<TimerActionResult>, Constable

public enum TimerActionResult
extends Enum<TimerActionResult>

The result of a timer action.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FailedInternalError	Failed to start/stop timer due to an internal error.
FailedNoSuchTimer	Failed to stop the existing timer, the timer is no longer active.
FailedTimerAlreadyExists	Failed to start the timer, the timer with the specified name already exists.
FailedTooManyTimers	Failed to start a new timer due to reaching the limit for a number of active timers.
Success	The operation completed successfully.

Method Summary

Modifier and Type	Method	Description
static TimerActionResult	fromOrdinal(int val)	Convert an ordinal into a TimerActionResult.
static TimerActionResult	valueOf(String name)	Returns the enum constant of this class with the specified name.
static TimerActionResult[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

Success

public static final TimerActionResult Success

The operation completed successfully.

FailedTooManyTimers

public static final TimerActionResult FailedTooManyTimers

Failed to start a new timer due to reaching the limit for a number of active timers.

FailedNoSuchTimer

public static final TimerActionResult FailedNoSuchTimer

Failed to stop the existing timer, the timer is no longer active.

FailedTimerAlreadyExists

public static final TimerActionResult FailedTimerAlreadyExists

Failed to start the timer, the timer with the specified name already exists.

FailedInternalError

public static final TimerActionResult FailedInternalError

Failed to start/stop timer due to an internal error.

Method Details

values

public static TimerActionResult[] 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

public static TimerActionResult valueOf(String name)

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 name

NullPointerException - if the argument is null

fromOrdinal

public static TimerActionResult fromOrdinal(int val)

Convert an ordinal into a TimerActionResult. 0 = Success, 1 = FailedTooManyTimers, 2 = FailedNoSuchTimer, 3 = FailedTimerAlreadyExists, 4 = FailedInternalError

Parameters:

val - the ordinal value.

Returns:

the associated TimerActionResult or throws an IllegalArgumentException for an unexpected ordinal value.