ABLE, Version 1.1b

com.ibm.able.platform
Interface PlatformTracer

All Known Implementing Classes:
PlatformTracerSupport

public abstract interface PlatformTracer
extends java.rmi.Remote

This class defines a 'Tracer' object.

Tracer objects may be found in some ABLE objects; in particular, those that support the 'getTracer()' method. Tracer objects can be used to control (even remotely) when and how a containing object will produce trace messages (as opposed to debug messages, which are either compiled in or completely compiled out of a program at build time).

Trace messages are runtime messages. Trace messages can be turned on and off programmatically, and they can be directed to the Java console or batched up in internal queues that can be retrieved and examined by other programs.

Version:
$Revision: 1.1 $, $Date: 2000/02/08 15:13:55 $

Method Summary
 void clearBatchLog()
          Clear the batch trace log.
 void dumpBatchLog()
          Dump the batch trace log to the Java console.
 java.util.Vector getBatchLog()
          Retrieve the batch trace log.
 boolean isActive()
          Determine whether tracing is active.
 void setActive(boolean theTraceFlag)
          Enable or disable tracing.
 void setBatch(boolean theBatchFlag)
          Enable or disable batch tracing.
 

Method Detail

isActive

public boolean isActive()
                 throws java.rmi.RemoteException
Determine whether tracing is active.
Returns:
true if tracing is active; false otherwise.

setActive

public void setActive(boolean theTraceFlag)
               throws java.rmi.RemoteException
Enable or disable tracing.
Parameters:
theTraceFlag - Use true to enable tracing. Use false to disable tracing.


setBatch

public void setBatch(boolean theBatchFlag)
              throws java.rmi.RemoteException
Enable or disable batch tracing. When batch tracing is enabled, trace messages are not immediately displayed, but are saved in a Vector for later retrieval. When disabled, all messages are written out using System.out.println().
Parameters:
theBatchFlag - Use true to enable tracing. Use false to disable tracing.

See Also:
getBatchLog(), dumpBatchLog()

clearBatchLog

public void clearBatchLog()
                   throws java.rmi.RemoteException
Clear the batch trace log.

getBatchLog

public java.util.Vector getBatchLog()
                             throws java.rmi.RemoteException
Retrieve the batch trace log.
Returns:
A Vector containing String objects. Note that the vector may be empty.


dumpBatchLog

public void dumpBatchLog()
                  throws java.rmi.RemoteException
Dump the batch trace log to the Java console.

ABLE, Version 1.1b

ABLE: Produced by Joe, Don, and Jeff who say, 'Thanks for your support.'