diva.util
Class LoggableOp

java.lang.Object
  diva.util.LoggableOp

Direct Known Subclasses:

XmlReader, XmlWriter

public class LoggableOp
extends java.lang.Object

This is an abstract base class for objects that need to log error or warning messages. It is useful for things like parsers and printers -- anything that need to perform a complex operation but might encounter errors that need to be displayed to the user.

Version:

$Id: LoggableOp.java 38798 2005-07-08 20:00:01Z cxh $

Author:

John Reekie

Field Summary

private java.io.PrintStream	_err The output stream for error messages.
private int	_errCount The number of errors generated in the most recent parse.
private int	_indent The indenting level
private java.lang.String	_tab The indent tab string
protected boolean	_verbose
private int	_warnCount The number of warnings generated in the most recent parse.

Constructor Summary

LoggableOp()

Method Summary

int	getErrorCount() Get the number of errors generated during the most recent operation.
java.io.PrintStream	getErrorStream() Get the stream to which errors are printed.
int	getLineNumber()
int	getWarningCount() Get the number of warnings generated during the most recent parse.
void	indent() Increment the indentation counter.
boolean	isVerbose() Test if we are in verbose mode
void	logError(java.lang.String msg) Print an error message to the error stream.
void	logError(java.lang.String id, java.lang.String msg) Print an error message to the error stream.
void	logError(java.lang.String id, java.lang.String msg, java.lang.String detail) Print an error message to the error stream.
void	logInfo(java.lang.String msg) If in verbose mode, print an info message to the error stream, otherwise do nothing.
void	logInfo(java.lang.String id, java.lang.String msg) If in verbose mode, print an info message to the error stream, otherwise do nothing.
void	logWarning(java.lang.String msg) Print an warning message to the error stream.
void	logWarning(java.lang.String id, java.lang.String msg) Print an warning message to the error stream.
void	logWarning(java.lang.String id, java.lang.String msg, java.lang.String detail) Print an warning message to the error stream.
void	reset() Reset the error counters.
void	setErrorStream(java.io.PrintStream err) Set the stream to which errors are printed.
void	setVerbose(boolean v) Set the verbose mode flag.
void	unindent() Decrement the indentation counter.

Methods inherited from class java.lang.Object

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

Field Detail

_err

private java.io.PrintStream _err

The output stream for error messages. By default, this is System.err.

_verbose

protected boolean _verbose

_warnCount

private int _warnCount

The number of warnings generated in the most recent parse.

_errCount

private int _errCount

The number of errors generated in the most recent parse.

_indent

private int _indent

The indenting level

_tab

private java.lang.String _tab

The indent tab string

Constructor Detail

LoggableOp

public LoggableOp()

Method Detail

getErrorCount

public int getErrorCount()

Get the number of errors generated during the most recent operation.

getErrorStream

public java.io.PrintStream getErrorStream()

Get the stream to which errors are printed.

getWarningCount

public int getWarningCount()

Get the number of warnings generated during the most recent parse.

getLineNumber

public int getLineNumber()

logError

public void logError(java.lang.String msg)

Print an error message to the error stream. This message includes the line number, and info message.

logError

public void logError(java.lang.String id,
                     java.lang.String msg)

Print an error message to the error stream. This prints the error id, line number, and info message.

logError

public void logError(java.lang.String id,
                     java.lang.String msg,
                     java.lang.String detail)

Print an error message to the error stream. This prints the error id, line number, info message. On a second line, it prints the detail information.

logInfo

public void logInfo(java.lang.String msg)

If in verbose mode, print an info message to the error stream, otherwise do nothing. This message includes the line number, and info message. The output is indented by the current indentation amount, allowing recursive operations to be printed more clearly.

logInfo

public void logInfo(java.lang.String id,
                    java.lang.String msg)

If in verbose mode, print an info message to the error stream, otherwise do nothing. This prints the info id, line number, and info message. The output is indented by the current indentation amount, allowing recursive operations to be printed more clearly.

indent

public void indent()

Increment the indentation counter.

isVerbose

public final boolean isVerbose()

Test if we are in verbose mode

reset

public void reset()

Reset the error counters.

setErrorStream

public void setErrorStream(java.io.PrintStream err)

Set the stream to which errors are printed. The default error stream is System.err.

setVerbose

public void setVerbose(boolean v)

Set the verbose mode flag. In verbose mode, calls to the logInfo() method write to the error output.

unindent

public void unindent()

Decrement the indentation counter.

logWarning

public void logWarning(java.lang.String msg)

Print an warning message to the error stream. This message includes the line number, and info message.

logWarning

public void logWarning(java.lang.String id,
                       java.lang.String msg)

Print an warning message to the error stream. This prints the warning id, line number, and info message.

logWarning

public void logWarning(java.lang.String id,
                       java.lang.String msg,
                       java.lang.String detail)

Print an warning message to the error stream. This prints the warning id, line number, info message. On a second line, it prints the detail information.