bjc.everge

Class LogStream

java.lang.Object

bjc.everge.LogStream

public class LogStream
extends Object

Simple class used for logging with various levels.

Author:

Ben Culkin

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEBUG Log level for printing debug messages.
static int	ERROR Log level for printing all errors.
static int	FATAL Log level for printing only fatal errors.
static int	INFO Log level for printing info messages.
static int	NOTHING Log level for printing nothing.
static int	TRACE Log level for printing trace messages.
static int	WARN Log level for printing warnings.

Constructor Summary

Constructors

Constructor and Description
LogStream(PrintStream out) Create a new log stream.
LogStream(PrintStream out, int level) Create a new log stream.

Method Summary

Modifier and Type	Method and Description
void	debug(String msg) Emit a debug message.
void	debugf(String msg, Object... args) Emit a formatted debug message.
void	error(String msg) Emit a normal error message.
void	errorf(String msg, Object... args) Emit a formatted normal error message.
void	fatal(String msg) Emit a fatal error message.
void	fatalf(String msg, Object... args) Emit a formatted fatal error message.
void	info(String msg) Emit an info message.
void	infof(String msg, Object... args) Emit a formatted info message.
void	louder() Increment the verbosity of the stream.
void	louder(int amt) Increase the verbosity of the stream by an amount.
void	message(int lvl, String msg) Print a message at a given verbosity level.
void	messagef(int lvl, String msg, Object... args) Print a formatted message at a given verbosity level.
void	print(String msg) Print a message that will always be visible.
void	printf(String msg, Object... args) Print a formatted message that will always be visible.
void	quieter() Decrement the verbosity of the stream.
void	quieter(int amt) Decrease the verbosity of the stream by an amount.
void	trace(String msg) Emit a tracing message.
void	tracef(String msg, Object... args) Emit a formatted tracing message.
int	verbosity() Get the verbosity of the stream.
void	verbosity(int verb) Set the verbosity of the stream.
void	warn(String msg) Emit a warning message.
void	warnf(String msg, Object... args) Emit a formatted warning message.

Methods inherited from class java.lang.Object

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

Field Detail

NOTHING

public static final int NOTHING

Log level for printing nothing.

See Also:

Constant Field Values

FATAL

public static final int FATAL

Log level for printing only fatal errors.

See Also:

Constant Field Values

ERROR

public static final int ERROR

Log level for printing all errors.

See Also:

Constant Field Values

WARN

public static final int WARN

Log level for printing warnings.

See Also:

Constant Field Values

INFO

public static final int INFO

Log level for printing info messages.

See Also:

Constant Field Values

DEBUG

public static final int DEBUG

Log level for printing debug messages.

See Also:

Constant Field Values

TRACE

public static final int TRACE

Log level for printing trace messages.

See Also:

Constant Field Values

Constructor Detail

LogStream

public LogStream(PrintStream out)

Create a new log stream. Defaults to printing only fatal errors.

Parameters:

out - The output stream to place things into.

LogStream

public LogStream(PrintStream out,
                 int level)

Create a new log stream.

Parameters:

out - The output stream to place things into.

level - The verbosity level. Use the constants in this class for the values.

Method Detail

verbosity

public int verbosity()

Get the verbosity of the stream.

Returns:

The verbosity of the stream.

verbosity

public void verbosity(int verb)

Set the verbosity of the stream.

Parameters:

verb - The verbosity of the stream.

louder

public void louder()

Increment the verbosity of the stream.

louder

public void louder(int amt)

Increase the verbosity of the stream by an amount.

Parameters:

amt - The amount to increase the verbosity by.

quieter

public void quieter()

Decrement the verbosity of the stream.

quieter

public void quieter(int amt)

Decrease the verbosity of the stream by an amount.

Parameters:

amt - The amount to decrease the verbosity by.

print

public void print(String msg)

Print a message that will always be visible.

Parameters:

msg - The message to print.

printf

public void printf(String msg,
                   Object... args)

Print a formatted message that will always be visible.

Parameters:

msg - The format string for the message to print.

args - The arguments to the format string.

message

public void message(int lvl,
                    String msg)

Print a message at a given verbosity level.

Parameters:

lvl - The verbosity level.

msg - The message to print.

messagef

public void messagef(int lvl,
                     String msg,
                     Object... args)

Print a formatted message at a given verbosity level.

Parameters:

lvl - The verbosity level.

msg - The message to print.

args - The arguments to the message.

fatal

public void fatal(String msg)

Emit a fatal error message.

Parameters:

msg - The message to emit.

fatalf

public void fatalf(String msg,
                   Object... args)

Emit a formatted fatal error message.

Parameters:

msg - The message to emit.

args - The arguments to the message.

error

public void error(String msg)

Emit a normal error message.

Parameters:

msg - The message to emit.

errorf

public void errorf(String msg,
                   Object... args)

Emit a formatted normal error message.

Parameters:

msg - The message to emit.

args - The arguments to the message.

warn

public void warn(String msg)

Emit a warning message.

Parameters:

msg - The message to emit.

warnf

public void warnf(String msg,
                  Object... args)

Emit a formatted warning message.

Parameters:

msg - The message to emit.

args - The arguments to the message.

info

public void info(String msg)

Emit an info message.

Parameters:

msg - The message to emit.

infof

public void infof(String msg,
                  Object... args)

Emit a formatted info message.

Parameters:

msg - The message to emit.

args - The arguments to the message.

debug

public void debug(String msg)

Emit a debug message.

Parameters:

msg - The message to emit.

debugf

public void debugf(String msg,
                   Object... args)

Emit a formatted debug message.

Parameters:

msg - The message to emit.

args - The arguments to the message.

trace

public void trace(String msg)

Emit a tracing message.

Parameters:

msg - The message to emit.

tracef

public void tracef(String msg,
                   Object... args)

Emit a formatted tracing message.

Parameters:

msg - The message to emit.

args - The arguments to the message.