edu.rice.cs.plt.debug
Interface Log

All Known Implementing Classes:

StandardLog, VoidLog

public interface Log

A log allows messages and other information to be recorded during program execution. Implementations should be thread-safe.

Method Summary

void	log() Record the current execution point (may include the current time, thread, code location, etc.)
void	log(String message) Record the given message
void	log(String message, Throwable t) Record the given exception (or other throwable) with a descriptive message; t may be null
void	log(Throwable t) Record the given exception (or other throwable); may be null
void	logEnd() Record the end of an execution phase.
void	logEnd(String message) Record the end of an execution phase with a descriptive message.
void	logEnd(String[] names, Object... values) Record the end of an execution phase.
void	logEnd(String name, Object value) Record the end of an execution phase.
void	logEnd(String message, String[] names, Object... values) Record the end of an execution phase with a descriptive message.
void	logEnd(String message, String name, Object value) Record the end of an execution phase with a descriptive message.
void	logStack() Record the current thread's stack trace
void	logStack(String message) Record the current thread's stack trace with a descriptive message
void	logStart() Record the beginning of an execution phase.
void	logStart(String message) Record the beginning of an execution phase with a descriptive message.
void	logStart(String[] names, Object... values) Record the beginning of an execution phase.
void	logStart(String name, Object value) Record the beginning of an execution phase.
void	logStart(String message, String[] names, Object... values) Record the beginning of an execution phase with a descriptive message.
void	logStart(String message, String name, Object value) Record the beginning of an execution phase with a descriptive message.
void	logValue(String name, Object value) Record the name and value of some variable or expression; value may be null
void	logValue(String message, String name, Object value) Record the name and value of some variable or expression with a descriptive message; value may be null
void	logValues(String[] names, Object... values) Record the names and values of a list of variables or expressions.
void	logValues(String message, String[] names, Object... values) Record the names and values of a list of variables or expressions with a descriptive message.

Method Detail

log

void log()

Record the current execution point (may include the current time, thread, code location, etc.)

log

void log(String message)

Record the given message

log

void log(Throwable t)

Record the given exception (or other throwable); may be null

log

void log(String message,
         Throwable t)

Record the given exception (or other throwable) with a descriptive message; t may be null

logStart

void logStart()

Record the beginning of an execution phase. This is useful, for example, when a method's execution begins. This call should always be followed by a corresponding invocation of logEnd() or logEnd(String).

logStart

void logStart(String message)

Record the beginning of an execution phase with a descriptive message. This is useful, for example, when a method's execution begins. This call should always be followed by a corresponding invocation of logEnd() or logEnd(String).

logStart

void logStart(String name,
              Object value)

Record the beginning of an execution phase. This is useful, for example, when a method's execution begins. This call should always be followed by a corresponding invocation of logEnd() or logEnd(String).

This version also records the name and value of a variable. value may be null.

logStart

void logStart(String message,
              String name,
              Object value)

Record the beginning of an execution phase with a descriptive message. This is useful, for example, when a method's execution begins. This call should always be followed by a corresponding invocation of logEnd() or logEnd(String).

This version also records the name and value of a variable. value may be null.

logStart

void logStart(String[] names,
              Object... values)

Record the beginning of an execution phase. This is useful, for example, when a method's execution begins. This call should always be followed by a corresponding invocation of logEnd() or logEnd(String).

This version also records the name and value of a set of variables. Any of values may be null.

logStart

void logStart(String message,
              String[] names,
              Object... values)

Record the beginning of an execution phase with a descriptive message. This is useful, for example, when a method's execution begins. This call should always be followed by a corresponding invocation of logEnd() or logEnd(String).

This version also records the name and value of a set of variables. Any of values may be null.

logEnd

void logEnd()

Record the end of an execution phase. This is useful, for example, when a method's execution ends. This call should always be preceded by a corresponding invocation of logStart() or logStart(String).

logEnd

void logEnd(String message)

Record the end of an execution phase with a descriptive message. This is useful, for example, when a method's execution ends. This call should always be preceded by a corresponding invocation of logStart() or logStart(String).

logEnd

void logEnd(String name,
            Object value)

Record the end of an execution phase. This is useful, for example, when a method's execution ends. This call should always be preceded by a corresponding invocation of logStart() or logStart(String).

This version also records the name and value of a variable. value may be null.

logEnd

void logEnd(String message,
            String name,
            Object value)

Record the end of an execution phase with a descriptive message. This is useful, for example, when a method's execution ends. This call should always be preceded by a corresponding invocation of logStart() or logStart(String).

This version also records the name and value of a variable. value may be null.

logEnd

void logEnd(String[] names,
            Object... values)

Record the end of an execution phase. This is useful, for example, when a method's execution ends. This call should always be preceded by a corresponding invocation of logStart() or logStart(String).

This version also records the name and value of a set of variables. Any of values may be null.

logEnd

void logEnd(String message,
            String[] names,
            Object... values)

Record the end of an execution phase with a descriptive message. This is useful, for example, when a method's execution ends. This call should always be preceded by a corresponding invocation of logStart() or logStart(String).

This version also records the name and value of a set of variables. Any of values may be null.

logStack

void logStack()

Record the current thread's stack trace

logStack

void logStack(String message)

Record the current thread's stack trace with a descriptive message

logValue

void logValue(String name,
              Object value)

Record the name and value of some variable or expression; value may be null

logValue

void logValue(String message,
              String name,
              Object value)

Record the name and value of some variable or expression with a descriptive message; value may be null

logValues

void logValues(String[] names,
               Object... values)

Record the names and values of a list of variables or expressions. The two arrays are assumed to have the same length, although implementations are encouraged to handle violations of this assumption cleanly by, for example, logging an error message. Any member of values may be null.

logValues

void logValues(String message,
               String[] names,
               Object... values)

Record the names and values of a list of variables or expressions with a descriptive message. The two arrays are assumed to have the same length, although implementations are encouraged to handle violations of this assumption cleanly by, for example, logging an error message. Any member of values may be null.