io.ghostwriter

Class NoopTracer

java.lang.Object

io.ghostwriter.NoopTracer

All Implemented Interfaces:

Tracer

public class NoopTracer
extends java.lang.Object
implements Tracer

Constructor Summary

Constructors

Constructor and Description
NoopTracer()

Method Summary

Modifier and Type	Method and Description
void	entering(java.lang.Object source, java.lang.String method, java.lang.Object... params) Creates an entering trace message.
void	exiting(java.lang.Object source, java.lang.String method) Creates an exiting trace message.
void	onError(java.lang.Object source, java.lang.String method, java.lang.Throwable error) Triggered when an unhandled exception occurs.
<T> void	returning(java.lang.Object source, java.lang.String method, T returnValue)
void	timeout(java.lang.Object source, java.lang.String method, long timeoutThreshold, long timeout) Triggered when the time between the entering and exiting events exceeds a certain amount of time in milliseconds.
void	valueChange(java.lang.Object source, java.lang.String method, java.lang.String variable, java.lang.Object newValue) Creates a value change trace message immediately after a successful update.

Methods inherited from class java.lang.Object

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

Constructor Detail

NoopTracer

public NoopTracer()

Method Detail

entering

public void entering(java.lang.Object source,
                     java.lang.String method,
                     java.lang.Object... params)

Description copied from interface: Tracer

Creates an entering trace message.

Specified by:

entering in interface Tracer

Parameters:

source - The object triggering the tracing event.

method - The method name, where the tracing event happened.

params - Parameters of the method in question. They are passed as {name, value} pairs in sequence.

exiting

public void exiting(java.lang.Object source,
                    java.lang.String method)

Description copied from interface: Tracer

Creates an exiting trace message. Used in case of methods with Void return value.

Specified by:

exiting in interface Tracer

Parameters:

source - The object triggering the tracing event.

method - The method name, where the tracing event happened.

valueChange

public void valueChange(java.lang.Object source,
                        java.lang.String method,
                        java.lang.String variable,
                        java.lang.Object newValue)

Description copied from interface: Tracer

Creates a value change trace message immediately after a successful update.

Specified by:

valueChange in interface Tracer

Parameters:

source - The object triggering the event.

method - The method name, where the tracing event happened.

variable - The name of the variable that had a new value assigned

newValue - The value that was assigned to the variable

returning

public <T> void returning(java.lang.Object source,
                          java.lang.String method,
                          T returnValue)

Specified by:

returning in interface Tracer

Type Parameters:

T - Type of the return value

Parameters:

source - The object triggering the event

method - The method name, where the tracing event happened

returnValue - The value that the current method returns

onError

public void onError(java.lang.Object source,
                    java.lang.String method,
                    java.lang.Throwable error)

Description copied from interface: Tracer

Triggered when an unhandled exception occurs. The primary use case is for runtime implementations, by triggering state saving only in cases where the context details are valuable.

Specified by:

onError in interface Tracer

Parameters:

source - The object triggering the event.

method - The method name, where the tracing event happened.

error - The capture exception object.

timeout

public void timeout(java.lang.Object source,
                    java.lang.String method,
                    long timeoutThreshold,
                    long timeout)

Description copied from interface: Tracer

Triggered when the time between the entering and exiting events exceeds a certain amount of time in milliseconds. This is an opt-in feature, that is enabled by annotating the methods that need to be watched.

Specified by:

timeout in interface Tracer

Parameters:

source - The object triggering the event

method - The method name, where the timeout event happened

timeoutThreshold - Threshold value for the current method

timeout - The timeout value in milliseconds that triggered the event. This is always larger than the threshold value.