com.bankframe.services.trace
Class BankFrameTrace

java.lang.Object
  com.bankframe.services.trace.BankFrameTrace

public class BankFrameTrace

extends java.lang.Object

This class provides a facility for determining the length of time required for BankFrame components to carry out their actions. This is accomplished by creating a Trace object, calling Trace.start() to start recording the elapsed time, and finally calling Trace.stop() to finish recording. When Trace.stopAndReport() is called an informational message will be displayed in the BankFrame log indicating the elapsed time. For example:

import com.bankframe.trace.Trace; Trace trace = new Trace(); trace.start("A sample description here"); ... some code here ... trace.stopAndReport();

Author:

etu

Constructor Summary

BankFrameTrace()
Default Constructor

BankFrameTrace(java.lang.String description)
Constructor

Method Summary

java.lang.String	getDescription() This method returns this Trace object's description
java.lang.String	getSubsystem() This method returns the logging subsystem to which this Trace object will log its output
long	report() This method generates a timing report in the log
void	reset() This method resets the timer.
void	setDescription(java.lang.String description) This method sets the description
void	setSubsystem(java.lang.String subsystem) This method sets the logging subsystem to which Trace will direct its output
void	start() This method starts the timer.
long	stop() This method stops the timer.
long	stopAndReport() This method stops the timer and produces a report

Methods inherited from class java.lang.Object

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

Constructor Detail

BankFrameTrace

public BankFrameTrace()

Default Constructor

BankFrameTrace

public BankFrameTrace(java.lang.String description)

Constructor

Parameters:

description - A description of this trace to aid in locating this trace in the log

Method Detail

getDescription

public java.lang.String getDescription()

This method returns this Trace object's description

Returns:

The description

getSubsystem

public java.lang.String getSubsystem()

This method returns the logging subsystem to which this Trace object will log its output

report

public long report()

This method generates a timing report in the log

Returns:

The total time elapsed in milliseconds

reset

public void reset()

This method resets the timer.

setDescription

public void setDescription(java.lang.String description)

This method sets the description

setSubsystem

public void setSubsystem(java.lang.String subsystem)

This method sets the logging subsystem to which Trace will direct its output

Parameters:

subsystem - The logging subsystem to use

start

public void start()

This method starts the timer.

stop

public long stop()

This method stops the timer.

stopAndReport

public long stopAndReport()

This method stops the timer and produces a report