Module de.codecamp.tracer.core

Package de.codecamp.tracer.impl

Class NoOpTraceContext

java.lang.Object

de.codecamp.tracer.impl.NoOpTraceContext

All Implemented Interfaces:

TraceContext, AutoCloseable

public class NoOpTraceContext
extends Object
implements TraceContext

Field Summary

Fields

Modifier and Type	Field	Description
static TraceContext	INSTANCE

Method Summary

Modifier and Type	Method	Description
void	close()	Closes this trace context.
ActiveTrace	getActiveTrace()	Returns the deepest currently active trace of the current context or a no-op dummy if none is available.
UUID	getId()
boolean	isRootContext()	Trace contexts can be nested.
void	setExitThrowable(Throwable exitThrowable)	Setting a throwable indicates that the trace context hasn't exited regularly.
ActiveTrace	startTrace(String label, Object... labelFormatArgs)	Starts a new sub-trace within this trace context.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface de.codecamp.tracer.TraceContext

startTrace

Field Detail

INSTANCE

public static final TraceContext INSTANCE

Method Detail

getId

public UUID getId()

Specified by:

getId in interface TraceContext

isRootContext

public boolean isRootContext()

Description copied from interface: TraceContext

Trace contexts can be nested. This method returns whether this is the root context.

Specified by:

isRootContext in interface TraceContext

Returns:

whether this is the root context

setExitThrowable

public void setExitThrowable(Throwable exitThrowable)

Description copied from interface: TraceContext

Setting a throwable indicates that the trace context hasn't exited regularly. As a consequence, durations can't necessarily be compared to other traces.

Specified by:

setExitThrowable in interface TraceContext

Parameters:

exitThrowable - the throwable that exited the trace

startTrace

public ActiveTrace startTrace(String label,
                              Object... labelFormatArgs)

Description copied from interface: TraceContext

Starts a new sub-trace within this trace context. Ends the currently active trace of this trace context, if there is one.

v *

Specified by:

startTrace in interface TraceContext

Parameters:

label - the label to use for this trace; may contain placeholders

labelFormatArgs - the format arguments for the placeholders in the label

Returns:

an ActiveTrace that can be used in a try-with-resource

getActiveTrace

public ActiveTrace getActiveTrace()

Description copied from interface: TraceContext

Returns the deepest currently active trace of the current context or a no-op dummy if none is available.

Specified by:

getActiveTrace in interface TraceContext

Returns:

the deepest currently active trace of the current context or a no-op dummy if none is available.

close

public void close()

Description copied from interface: TraceContext

Closes this trace context. Closing a trace context is the responsibility of the one opening it.

Overridden from AutoCloseable.close() to remove thrown Exception.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface TraceContext