plume

Class SimpleLog

java.lang.Object

plume.SimpleLog

public final class SimpleLog
extends java.lang.Object

A logging class with the following features:

• Can be enabled and disabled (when disabled, all operations are no-ops),
• Write to a file or to standard output,
• Can start and stop a timer, and nest timers,
• Can enter and exit subtasks (their output is indented, and they are timed),
• Can provide a backtrace (optionally provide a backtrace at every output), and
• Can add newlines where appropriate, if variable line_oriented is set.

Field Summary

Fields

Modifier and Type	Field and Description
boolean	always_traceback Always provide a backtrace (traceback) when calling log().
boolean	enabled If false, do no output.
java.lang.String	INDENT_STR_ONE_LEVEL Indentation string for one level of indentation.
boolean	line_oriented True if every log call is made with a complete line of text.
java.util.ArrayDeque<java.lang.Long>	start_times

Constructor Summary

Constructors

Constructor and Description
SimpleLog()
SimpleLog(boolean enabled)
SimpleLog(boolean enabled, boolean always_traceback) Create a new SimpleLog object.
SimpleLog(java.lang.String filename)
SimpleLog(java.lang.String filename, boolean enabled) Create a new SimpleLog object.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears indent and start times and then pushes one start time.
void	clear(java.lang.String format, java.lang.Object... args) Calls clear() and then logs the specified message
boolean	enabled()
void	exdent_time(java.lang.String format, java.lang.Object... args) Prints the time (showing the time for the nested timer) and then calls exdent().
void	exdent() Exdents: reduces indentation and pops a start time.
void	indent() Indents by one level and pushes a corresponding start time.
void	indent(java.lang.String format, java.lang.Object... args) Prints to the log, then indents.
void	log_tb(java.lang.String format, java.lang.Object... args) Log a message, and provide a backtrace (traceback, or tb).
void	log_time(java.lang.String format, java.lang.Object... args) Writes the specified message and the elapsed time since the last call to start_time().
void	log(java.lang.String format, java.lang.Object... args) Log a message.
void	pop_start_time() Pops a start time from the stack.
void	push_start_time() Push a new start time onto the stack.
void	reset_start_time() This overwrites the current start time; it does not push a new one!!
void	tb() Print a backtrace (traceback, or tb) to the log.

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.

always_traceback

public boolean always_traceback

Always provide a backtrace (traceback) when calling log().

INDENT_STR_ONE_LEVEL

public final java.lang.String INDENT_STR_ONE_LEVEL

Indentation string for one level of indentation.

See Also:

Constant Field Values

line_oriented

public boolean line_oriented

True if every log call is made with a complete line of text. False if a log call may contain multiple lines, or if multiple log calls may be made, each with parts of a line; in this case, you must manage line delimiters yourself.

start_times

public java.util.ArrayDeque<java.lang.Long> start_times

Constructor Detail

SimpleLog

public SimpleLog(boolean enabled,
                 boolean always_traceback)

Create a new SimpleLog object.

Parameters:

enabled - whether the logger starts out enabled

always_traceback - whether to always provide a backtrace (traceback) when calling log()

SimpleLog

public SimpleLog(boolean enabled)

SimpleLog

public SimpleLog()

SimpleLog

public SimpleLog(java.lang.String filename,
                 boolean enabled)

Create a new SimpleLog object.

Parameters:

filename - file name, or use "-" or null for standard output

enabled - whether the logger starts out enabled

SimpleLog

public SimpleLog(java.lang.String filename)

Parameters:

filename - file name, or use "-" or null for standard output

Method Detail

enabled

public boolean enabled()

log

public void log(java.lang.String format,
                java.lang.Object... args)

Log a message. Provide a backtrace (traceback) if variable always_traceback is set.

Parameters:

format - format string for message

args - values to be substituted into format

log_tb

public void log_tb(java.lang.String format,
                   java.lang.Object... args)

Log a message, and provide a backtrace (traceback, or tb).

Parameters:

format - format string for message

args - values to be substituted into format

tb

public void tb()

Print a backtrace (traceback, or tb) to the log.

indent

public void indent()

Indents by one level and pushes a corresponding start time.

indent

public void indent(java.lang.String format,
                   java.lang.Object... args)

Prints to the log, then indents.

Parameters:

format - format string for message

args - values to be substituted into format

See Also:

indent()

clear

public void clear()

Clears indent and start times and then pushes one start time.

clear

public void clear(java.lang.String format,
                  java.lang.Object... args)

Calls clear() and then logs the specified message

Parameters:

format - format string for message

args - values to be substituted into format

exdent

public void exdent()

Exdents: reduces indentation and pops a start time.

exdent_time

public void exdent_time(java.lang.String format,
                        java.lang.Object... args)

Prints the time (showing the time for the nested timer) and then calls exdent().

Parameters:

format - format string for message

args - values to be substituted into format

reset_start_time

public void reset_start_time()

This overwrites the current start time; it does not push a new one!!

push_start_time

public void push_start_time()

Push a new start time onto the stack.

pop_start_time

public void pop_start_time()

Pops a start time from the stack.

log_time

public void log_time(java.lang.String format,
                     java.lang.Object... args)

Writes the specified message and the elapsed time since the last call to start_time(). Does not pop nor reset the current start time.

Parameters:

format - format string for message

args - values to be substituted into format