cli

Class Traces

java.lang.Object

cli.Traces

public final class Traces
extends java.lang.Object

Traces management class.

Method Summary

Modifier and Type	Method and Description
static OutputDevice.Interface	getStream() Traces output stream accessor.
static boolean	safeTrace(TraceClass CLI_TraceClass, long I64_AvoidTracesDeviceRef, java.lang.String STR_Text) Safe trace routine.
static boolean	safeTrace(TraceClass CLI_TraceClass, NativeObject CLI_AvoidTraces, java.lang.String STR_Text) Safe trace routine.
static void	setAllFilter(boolean B_ShowTraces) Modifies the traces filter for all trace classes.
static void	setFilter(TraceClass CLI_Class, boolean B_ShowTraces) Modifies the traces filter.
static boolean	setStream(OutputDevice.Interface CLI_Stream) Stream positionning (if not already set).
static void	trace(TraceClass CLI_TraceClass, java.lang.String STR_Text) Sends a trace to the trace system.
static boolean	unsetStream(OutputDevice.Interface CLI_Stream) Restores the initial traces output stream.

Methods inherited from class java.lang.Object

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

Method Detail

getStream

public static final OutputDevice.Interface getStream()

Traces output stream accessor.

Returns:

Traces output device, or null-device if an error occurred.

setStream

public static final boolean setStream(OutputDevice.Interface CLI_Stream)

Stream positionning (if not already set).

Parameters:

CLI_Stream - Stream reference.

Returns:

true: success, false: failure. When SetStream() has not been called previously, then it takes CLI_Stream in account immediately for tracing. Otherwise it stacks the stream (for consistency concerns) and waits for the previous ones to be released possibly.

unsetStream

public static final boolean unsetStream(OutputDevice.Interface CLI_Stream)

Restores the initial traces output stream.

Parameters:

CLI_Stream - Output device to be used.

Returns:

true: success, false: failure.

setFilter

public static final void setFilter(TraceClass CLI_Class,
                                   boolean B_ShowTraces)

Modifies the traces filter.

Parameters:

CLI_Class - Trace class object of the filter modification.

B_ShowTraces - true if the traces should be displayed, false otherwise.

setAllFilter

public static final void setAllFilter(boolean B_ShowTraces)

Modifies the traces filter for all trace classes.

Parameters:

B_ShowTraces - true if the traces should be displayed, false otherwise.

trace

public static final void trace(TraceClass CLI_TraceClass,
                               java.lang.String STR_Text)

Sends a trace to the trace system.

Parameters:

CLI_TraceClass - Corresponding trace class.

STR_Text - Text of the trace.

safeTrace

public static final boolean safeTrace(TraceClass CLI_TraceClass,
                                      NativeObject CLI_AvoidTraces,
                                      java.lang.String STR_Text)

Safe trace routine.

Parameters:

CLI_TraceClass - Corresponding trace class.

CLI_AvoidTraces - Avoid stream from being sent traces.

STR_Text - Text of the trace.

Returns:

true if traces are safe, false otherwise. Prevents output from infinite loops.

safeTrace

public static final boolean safeTrace(TraceClass CLI_TraceClass,
                                      long I64_AvoidTracesDeviceRef,
                                      java.lang.String STR_Text)

Safe trace routine.

Parameters:

CLI_TraceClass - Corresponding trace class.

I64_AvoidTracesDeviceRef - Reference of device to avoid from being sent traces.

STR_Text - Text of the trace.

Returns:

true if traces are safe, false otherwise. Prevents output from infinite loops.