io.ghostwriter

Interface Tracer

All Known Implementing Classes:

NoopTracer

public interface Tracer

Method Summary

Methods

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	exiting(java.lang.Object source, java.lang.String method, java.lang.Object returnValue) 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.
void	valueChange(java.lang.Object source, java.lang.String method, java.lang.String variable, java.lang.Object value) Creates a value change trace message immediately after a successful update.

Method Detail

entering

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

Creates an entering trace message.

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

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

Creates an exiting trace message.

Parameters:

source - The object triggering the tracing event.

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

returnValue - The return value of the method, in case it was not Void.

exiting

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

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

Parameters:

source - The object triggering the tracing event.

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

valueChange

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

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

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

value - The value that was assigned to the variable

onError

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

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.

Parameters:

source - The object triggering the event.

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

error - The capture exception object.