kieker.monitoring.core.registry
Enum TraceRegistry

java.lang.Object
  java.lang.Enum<TraceRegistry>
      kieker.monitoring.core.registry.TraceRegistry

All Implemented Interfaces:

Serializable, Comparable<TraceRegistry>

public enum TraceRegistry
extends Enum<TraceRegistry>

Author:

Jan Waller

Enum Constant Summary

INSTANCE

Method Summary

Trace	getTrace() Gets a Trace for the current thread.
Trace	registerTrace() This creates a new unique Trace object and registers it.
void	setParentTraceId(Thread t, long traceId, int orderId)
void	unregisterTrace() Unregisters the current Trace object.
static TraceRegistry	valueOf(String name) Returns the enum constant of this type with the specified name.
static TraceRegistry[]	values() Returns an array containing the constants of this enum type, in the order they're declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INSTANCE

public static final TraceRegistry INSTANCE

Method Detail

values

public static final TraceRegistry[] values()

Returns an array containing the constants of this enum type, in the order they're declared. This method may be used to iterate over the constants as follows:

for(TraceRegistry c : TraceRegistry.values())
        System.out.println(c);

Returns:

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

valueOf

public static TraceRegistry 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 name

getTrace

public final Trace getTrace()

Gets a Trace for the current thread. If no trace is active, null is returned.

Returns:

Trace object or null

registerTrace

public final Trace registerTrace()

This creates a new unique Trace object and registers it. Should only be called if no trace was registered before (getTrace() returns null).

Returns:

Trace object

unregisterTrace

public final void unregisterTrace()

Unregisters the current Trace object. Future calls of getTrace() will return null.

setParentTraceId

public final void setParentTraceId(Thread t,
                                   long traceId,
                                   int orderId)