de.uni_hildesheim.sse.monitoring.runtime.annotations

Annotation Type Timer

@Retention(value=RUNTIME)
 @Target(value={METHOD,CONSTRUCTOR})
public @interface Timer

Defines the basis for generating application-specific monitoring timer events. Program elements may be flagged with this annotation in order to cause the monitoring mechanism to store the current system time (TimerState.START), to suspend the timer temporarily (TimerState.SUSPEND) in order to resume it later (TimerState.RESUME) or to terminate the timer cycle in order to notify observers about a completed timing event.

Since:

1.00

Version:

1.00

Author:

Holger Eichelberger

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	id An arbitrary id representing the associated timer.
TimerState	state Defines the next state of the timer.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
TimerPosition	affectAt Defines where to affect the instrumented method/constructor.
boolean	considerThreads Should be false (default) if id is thread save and threads must not be considered explicitly, false else.

Element Detail

id

public abstract java.lang.String id

An arbitrary id representing the associated timer. In case of "*" the id is determined by the innermost ValueContext.

Returns:

the id

Since:

1.00

state

public abstract TimerState state

Defines the next state of the timer.

Returns:

the timer state

Since:

1.00

affectAt

public abstract TimerPosition affectAt

Defines where to affect the instrumented method/constructor. Defaults to TimerPosition.DEFAULT, i.e. TimerState.getDefaultPosition().

Returns:

the timer position

Since:

1.00

Default:

de.uni_hildesheim.sse.monitoring.runtime.annotations.TimerPosition.DEFAULT

considerThreads

public abstract boolean considerThreads

Should be false (default) if id is thread save and threads must not be considered explicitly, false else.

Returns:

true for considering threads, false else

Default:

false