org.plumelib.bcelutil

Class SimpleLog

java.lang.Object

org.plumelib.bcelutil.SimpleLog

public final class SimpleLog
extends Object

A logging class with the following features:

• Can be enabled and disabled (when disabled, all operations are no-ops),
• Can indent/exdent log output,
• Writes to standard output, and
• Can provide a stack trace.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	enabled If false, do no output.

Constructor Summary

Constructors

Constructor and Description
SimpleLog() Create a new SimpleLog object with logging enabled.
SimpleLog(boolean enabled) Create a new SimpleLog object.

Method Summary

Modifier and Type	Method and Description
boolean	enabled() Return whether logging is enabled.
void	exdent() Decreases indentation by one level.
void	indent() Increases indentation by one level.
void	log(String format, Object... args) Log a message to System.out.
void	logStackTrace() Print a stack trace to System.out.
void	resetIndent() Resets indentation to none.

Methods inherited from class java.lang.Object

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

Field Detail

enabled

public boolean enabled

If false, do no output.

Constructor Detail

SimpleLog

public SimpleLog()

Create a new SimpleLog object with logging enabled.

SimpleLog

public SimpleLog(boolean enabled)

Create a new SimpleLog object.

Parameters:

enabled - whether the logger starts out enabled

Method Detail

enabled

public boolean enabled()

Return whether logging is enabled.

Returns:

whether logging is enabled

log

@FormatMethod
public void log(String format,
                              Object... args)

Log a message to System.out. The message is prepended with the current indentation string. The indentation is only applied at the start of the message, not for every line break within the message.

Parameters:

format - format string for message

args - values to be substituted into format

logStackTrace

public void logStackTrace()

Print a stack trace to System.out.

indent

public void indent()

Increases indentation by one level.

exdent

public void exdent()

Decreases indentation by one level.

resetIndent

public void resetIndent()

Resets indentation to none. Has no effect if logging is disabled.