io.spokestack.spokestack.util

Class EventTracer

java.lang.Object

io.spokestack.spokestack.util.EventTracer

Direct Known Subclasses:

DialogueDispatcher

public class EventTracer
extends Object

A utility class for components capable of dispatching trace/logging events, encapsulating the logic of checking an event's specified level against a preconfigured threshold to determine whether the event message should be formatted and dispatched, similar to the Java logger.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EventTracer.Level trace levels, for simple filtering.

Constructor Summary

Constructors

Constructor and Description
EventTracer(int level) Creates a new tracer with no listeners to be used only for trace level checks.
EventTracer(int level, List<? extends TraceListener> traceListeners) Creates a new tracer at the specified level.

Method Summary

Modifier and Type	Method and Description
boolean	canTrace(EventTracer.Level level) indicates whether a message will be traced at a level.
void	trace(EventTracer.Level level, String format, Object... params) Raises a trace event.

Methods inherited from class java.lang.Object

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

Constructor Detail

EventTracer

public EventTracer(int level)

Creates a new tracer with no listeners to be used only for trace level checks.

Parameters:

level - The threshold that events must surpass to be delivered.

EventTracer

public EventTracer(int level,
                   List<? extends TraceListener> traceListeners)

Creates a new tracer at the specified level.

Parameters:

level - The threshold that events must surpass to be delivered.

traceListeners - Listeners that should receive valid trace events.

Method Detail

trace

public void trace(EventTracer.Level level,
                  String format,
                  Object... params)

Raises a trace event.

Parameters:

level - tracing level

format - trace message format string

params - trace message format parameters

canTrace

public boolean canTrace(EventTracer.Level level)

indicates whether a message will be traced at a level.

Parameters:

level - tracing level

Returns:

true if tracing will occur, false otherwise