intradoc.common
Class DefaultTraceImplementor

java.lang.Object
  |
  +--intradoc.common.DefaultTraceImplementor

All Implemented Interfaces:

TraceImplementor

public class DefaultTraceImplementor

extends java.lang.Object

implements TraceImplementor

Constructor Summary

DefaultTraceImplementor()

Method Summary

void	appendTraceMessage(java.lang.StringBuffer buf, TraceSection section, java.lang.String message, java.util.Date d, boolean fullTraceInfo) Used to build the actual output message created by the trace(...) function.
void	dumpException(TraceSection section, java.lang.Throwable t) Dumps all information relevant about an exception including stack trace.
void	init() does nothing
TraceSection	makeSectionData(java.lang.String section)
void	out(java.lang.String message) Sends message to console.
void	outln(java.lang.String message) Sends message to console with line feed.
void	trace(TraceSection section, java.lang.String message) Standard trace.
void	traceBytes(TraceSection section, byte[] b, int start, int len) Sends bytes to console.
void	traceDirectToOutput(TraceSection section, java.lang.String message) Like trace(...) but does not prefix message with section, date and thread info.
void	traceDumpException(TraceSection section, java.lang.String message, java.lang.Throwable t) Like dumpException(...) except that caller can add an additional message to the dump.
void	traceWithDate(TraceSection section, java.lang.String message, java.util.Date d) Trace that allows the date value to be supplied by caller.

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultTraceImplementor

public DefaultTraceImplementor()

Method Detail

init

public void init()

does nothing

Specified by:

init in interface TraceImplementor

makeSectionData

public TraceSection makeSectionData(java.lang.String section)

Specified by:

makeSectionData in interface TraceImplementor

trace

public void trace(TraceSection section,
                  java.lang.String message)

Standard trace. Adds section, thread-id and date to message before sending it to output. The 'section' parameter MUST be in lower case.

Specified by:

trace in interface TraceImplementor

traceWithDate

public void traceWithDate(TraceSection section,
                          java.lang.String message,
                          java.util.Date d)

Trace that allows the date value to be supplied by caller. Useful if the date is being used by caller to time performance. The 'section' parameter MUST be in lower case.

Specified by:

traceWithDate in interface TraceImplementor

traceDirectToOutput

public void traceDirectToOutput(TraceSection section,
                                java.lang.String message)

Like trace(...) but does not prefix message with section, date and thread info. It also does not terminate the output with a line feed. The 'section' parameter MUST be in lower case.

Specified by:

traceDirectToOutput in interface TraceImplementor

traceBytes

public void traceBytes(TraceSection section,
                       byte[] b,
                       int start,
                       int len)

Sends bytes to console. How console handles them is up to Java and console.

Specified by:

traceBytes in interface TraceImplementor

dumpException

public void dumpException(TraceSection section,
                          java.lang.Throwable t)

Dumps all information relevant about an exception including stack trace.

Specified by:

dumpException in interface TraceImplementor

traceDumpException

public void traceDumpException(TraceSection section,
                               java.lang.String message,
                               java.lang.Throwable t)

Like dumpException(...) except that caller can add an additional message to the dump.

Specified by:

traceDumpException in interface TraceImplementor

appendTraceMessage

public void appendTraceMessage(java.lang.StringBuffer buf,
                               TraceSection section,
                               java.lang.String message,
                               java.util.Date d,
                               boolean fullTraceInfo)

Used to build the actual output message created by the trace(...) function. Useful if trace messages need to be saved or send elsewhere.

Specified by:

appendTraceMessage in interface TraceImplementor

outln

public void outln(java.lang.String message)

Sends message to console with line feed. Use in preference to System.out.println.

Specified by:

outln in interface TraceImplementor

out

public void out(java.lang.String message)

Sends message to console. Use in preference to System.out.print.

Specified by:

out in interface TraceImplementor