com.rubecula.util
Interface Auditable

All Superinterfaces:

Identifiable

All Known Subinterfaces:

Integral, Millable, MillInterface

All Known Implementing Classes:

BaseNumber, Complex, Compound, Item, Manifest, Mill, Presentation, Units, UnitsFoundation, WholeNumber

public interface Auditable

extends Identifiable

Interface to define certain methods for auditing objects (for debugging purposes).

Since:

V_0_1

Version:

$Revision: 1.3 $

Author:

Robin Hillyard

Method Summary

java.lang.String	audit() Method to return a detailed (unlabeled) string from an object for debugging purposes.
void	audit(java.io.PrintStream out, java.lang.String label) Method to output detailed string from an object for debugging purposes.
java.lang.String	audit(java.lang.String label) Method to return a detailed string from an object for debugging purposes.

Methods inherited from interface com.rubecula.util.Identifiable

getIdentifier

Method Detail

audit

public java.lang.String audit(java.lang.String label)

Method to return a detailed string from an object for debugging purposes.

Parameters:

label - the label to associate with the data. If label is non-null, a more detailed audit will be returned (this normally occurs only at the top level).

Returns:

the detailed string.

audit

public java.lang.String audit()

Method to return a detailed (unlabeled) string from an object for debugging purposes.

Returns:

the detailed string.

audit

public void audit(java.io.PrintStream out,
                  java.lang.String label)

Method to output detailed string from an object for debugging purposes.

Parameters:

out - the output stream.

label - the label to attach to the output (may be null).