com.rubecula.util
Interface Auditable

All Known Subinterfaces:

Integral, Millable

All Known Implementing Classes:

BaseNumber, Manifest, Mill, Presentation, QuantityCell, SpreadsheetModel, Units, UnitsFoundation, WholeNumber

public interface Auditable

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

Version:

$Revision: 1.1 $

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.
java.lang.String	getIdentifier() Method to get the specific identifier for an object.

Method Detail

getIdentifier

public java.lang.String getIdentifier()

Method to get the specific identifier for an object.

Returns:

the identifier.

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).