All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class rebelsky.util.Reporter

java.lang.Object
   |
   +----rebelsky.util.Reporter

public class Reporter
extends Object
A simple mechanism for helping debug programs. Within your objects, you create a Reporter object and use it for one or many methods. Here's a typical use
 Reporter reporter;
 ...
 public void foo(String arg)
 {
   reporter.enter("foo");
   reporter.report("Argument is '" + arg + "'");
   ...
   reporter.exit("foo");
 } // foo
 

This class is still under development. Copyright (c) 1998 Samuel A. Rebelsky. All rights reserved.

Version:
1.0 of March 1998
Author:
Samuel A. Rebelsky

Constructor Index

o Reporter()
Build a new reporter that is off and reports to standard output.
o Reporter(SimpleOutput)
Build a new reporter that is off and that reports to the given output.

Method Index

o enter(String)
Enter a method.
o exit(String)
Exit/leave a method.
o off()
Turn me off.
o on()
Turn me on.
o report(String)
Report something about the status of the program.

Constructors

o Reporter
 public Reporter()
Build a new reporter that is off and reports to standard output.

o Reporter
 public Reporter(SimpleOutput out)
Build a new reporter that is off and that reports to the given output.

Methods

o on
 public void on()
Turn me on. I will print output until turned off.

o off
 public void off()
Turn me off. I will not print output until I am turned back on.

o report
 public void report(String status)
Report something about the status of the program.

o enter
 public void enter(String method_name)
Enter a method. Currently does nothing. Eventually will provide some reporting and indentation.

o exit
 public void exit(String method_name)
Exit/leave a method. Currently does nothing. Eventually will provide some reporting and indentation.


All Packages  Class Hierarchy  This Package  Previous  Next  Index