ABLE, Version 1.1b

com.ibm.able.beans.fuzzy
Class FsTrace

java.lang.Object
  |
  +--com.ibm.able.beans.fuzzy.FsTrace

public class FsTrace
extends java.lang.Object
implements java.io.Serializable

This class defines the Fuzzy System 'Trace' object.

Version:
1.0.0; change log:
 Version   Description
 --------  -----------
 1.0.0     Initial release.

 
See Also:
Serialized Form

Constructor Summary
FsTrace()
          Create a new fuzzy trace object.
 
Method Summary
 void clearLog()
          Clear the batch trace log.
static java.lang.String Copyright()
          Determine the copyright of this class.
 void dumpLog()
          Dump the batch trace log to the Java console.
 java.util.Vector getLog()
          Retrieve the batch trace log.
 boolean isActive()
          Determine whether tracing is active.
 void logTrace(java.lang.String theTraceMsg)
          Log a trace message.
 void setActive(boolean theTraceFlag)
          Enable or disable tracing.
 void setBatch(boolean theBatchFlag)
          Enable or disable batch tracing.
 java.lang.String toString()
          Retrieve a string describing (the contents of) the object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

FsTrace

public FsTrace()
Create a new fuzzy trace object.
Method Detail

setActive

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


isActive

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

setBatch

public void setBatch(boolean theBatchFlag)
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:
getLog(), dumpLog()

logTrace

public void logTrace(java.lang.String theTraceMsg)
Log a trace message.

If batch tracing is active, the trace message is stored internally in a Vector, which may be retrieved later, or dumped to the Java console.

If batch tracing is not active, the trace message is written out to the Java console using System.out.println().

Parameters:
theTraceMsg - Any Java String object.

See Also:
getLog(), dumpLog()

clearLog

public void clearLog()
Clear the batch trace log.

getLog

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

dumpLog

public void dumpLog()
Dump the batch trace log to the Java console.

toString

public java.lang.String toString()
Retrieve a string describing (the contents of) the object.
Returns:
A String containing the current contents of the object.

Overrides:
toString in class java.lang.Object

Copyright

public static java.lang.String Copyright()
Determine the copyright of this class.
Returns:
A String containing this class's copyright statement.


ABLE, Version 1.1b

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