de.uni_hildesheim.sse.monitoring.runtime.annotations

Enum TimerState

java.lang.Object

java.lang.Enum<TimerState>

de.uni_hildesheim.sse.monitoring.runtime.annotations.TimerState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TimerState>

public enum TimerState
extends java.lang.Enum<TimerState>

Defines some timer states to be used with Timer. The timer mechanism follows a simple state machine of start-finish or start-suspend-resume-finish notifications (further unmatching events are ignored).

Since:

1.00

Version:

1.00

Author:

Holger Eichelberger

Enum Constant Summary

Enum Constants

Enum Constant and Description
FINISH Finish the timer, notify observers and clear the timer storage (TimerPosition.END).
RESUME Resume time recording after a previous SUSPEND (TimerPosition.BEGINNING).
RESUME_SUSPEND Resume and stop in one method / constructor (TimerPosition.BOTH).
START Start the time recording at the given point of execution (TimerPosition.BEGINNING).
START_FINISH Start and finish the timer in one method / constructor (TimerPosition.BOTH).
SUSPEND Suspend the time recording temporarily in order to resume it later (TimerPosition.END).
SUSPEND_RESUME Suspend and resume in one method / constructor (TimerPosition.BOTH).

Field Summary

Fields

Modifier and Type	Field and Description
private TimerPosition	defaultPosition Stores the default position for affecting the instrumented system.

Method Summary

Modifier and Type	Method and Description
TimerPosition	getDefaultPosition() Returns the default position for affecting instrumented code.
static TimerState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static TimerState[]	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

START

public static final TimerState START

Start the time recording at the given point of execution (TimerPosition.BEGINNING).

SUSPEND

public static final TimerState SUSPEND

Suspend the time recording temporarily in order to resume it later (TimerPosition.END).

RESUME

public static final TimerState RESUME

Resume time recording after a previous SUSPEND (TimerPosition.BEGINNING).

FINISH

public static final TimerState FINISH

Finish the timer, notify observers and clear the timer storage (TimerPosition.END).

START_FINISH

public static final TimerState START_FINISH

Start and finish the timer in one method / constructor (TimerPosition.BOTH).

RESUME_SUSPEND

public static final TimerState RESUME_SUSPEND

Resume and stop in one method / constructor (TimerPosition.BOTH).

SUSPEND_RESUME

public static final TimerState SUSPEND_RESUME

Suspend and resume in one method / constructor (TimerPosition.BOTH).

Field Detail

defaultPosition

private TimerPosition defaultPosition

Stores the default position for affecting the instrumented system.

Method Detail

values

public static TimerState[] 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 (TimerState c : TimerState.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static TimerState valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getDefaultPosition

public TimerPosition getDefaultPosition()

Returns the default position for affecting instrumented code.

Returns:

the default position (must not be null)

Since:

1.00