net.pwall.log

Class ConsoleLogger

java.lang.Object

net.pwall.log.ConsoleLogger

All Implemented Interfaces:

Logger

public class ConsoleLogger
extends Object
implements Logger

A Logger that outputs to a PrintStream, usually stdout or stderr.

Author:

Peter Wall

Field Summary

Fields

Modifier and Type	Field and Description
static Level	defaultLevel Default logging level for ConsoleLogger
static PrintStream	defaultOutput Default output stream for ConsoleLogger

Constructor Summary

Constructors

Constructor and Description
ConsoleLogger(String name) Create a ConsoleLogger with the supplied name and the default level and output stream.
ConsoleLogger(String name, Level level) Create a ConsoleLogger with the supplied name and level and the default output stream.
ConsoleLogger(String name, Level level, PrintStream output) Create a ConsoleLogger with the supplied name, level and output stream.
ConsoleLogger(String name, PrintStream output) Create a ConsoleLogger with the supplied name and output stream and the default level.

Method Summary

Modifier and Type	Method and Description
void	debug(Object message) Output a debug message.
void	error(Object message) Output an error message.
void	error(Object message, Throwable throwable) Output an error message along with a Throwable.
Level	getLevel() Get the minimum level to be output by this ConsoleLogger.
String	getName() Get the name associated with this ConsoleLogger.
PrintStream	getOutput() Get the output stream associated with this ConsoleLogger.
char	getSeparator() Get the character separator used to format output messages.
void	info(Object message) Output an info message.
boolean	isDebugEnabled() Test whether debug output is enabled for this ConsoleLogger.
boolean	isErrorEnabled() Test whether error output is enabled for this ConsoleLogger.
boolean	isInfoEnabled() Test whether info output is enabled for this ConsoleLogger.
boolean	isTraceEnabled() Test whether trace output is enabled for this ConsoleLogger.
boolean	isWarnEnabled() Test whether warning output is enabled for this ConsoleLogger.
void	setLevel(Level level) Set the minimum level to be output by this ConsoleLogger.
void	setSeparator(char separator) Set the character separator used to format output messages.
void	trace(Object message) Output a trace message.
void	warn(Object message) Output a warning message.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.pwall.log.Logger

debug, error, error, getDefault, getDefault, info, log, log, trace, warn

Field Detail

defaultLevel

public static final Level defaultLevel

Default logging level for ConsoleLogger

defaultOutput

public static final PrintStream defaultOutput

Default output stream for ConsoleLogger

Constructor Detail

ConsoleLogger

public ConsoleLogger(String name,
                     Level level,
                     PrintStream output)

Create a ConsoleLogger with the supplied name, level and output stream.

Parameters:

name - the name to be associated with logging messages

level - the minimum level to be output

output - the output stream

ConsoleLogger

public ConsoleLogger(String name,
                     Level level)

Create a ConsoleLogger with the supplied name and level and the default output stream.

Parameters:

name - the name to be associated with logging messages

level - the minimum level to be output

ConsoleLogger

public ConsoleLogger(String name,
                     PrintStream output)

Create a ConsoleLogger with the supplied name and output stream and the default level.

Parameters:

name - the name to be associated with logging messages

output - the output stream

ConsoleLogger

public ConsoleLogger(String name)

Create a ConsoleLogger with the supplied name and the default level and output stream.

Parameters:

name - the name to be associated with logging messages

Method Detail

getName

public String getName()

Get the name associated with this ConsoleLogger.

Specified by:

getName in interface Logger

Returns:

the name

getLevel

public Level getLevel()

Get the minimum level to be output by this ConsoleLogger.

Returns:

the level

setLevel

public void setLevel(Level level)

Set the minimum level to be output by this ConsoleLogger.

Parameters:

level - the new level

getOutput

public PrintStream getOutput()

Get the output stream associated with this ConsoleLogger.

Returns:

the output stream

getSeparator

public char getSeparator()

Get the character separator used to format output messages.

Returns:

the separator

setSeparator

public void setSeparator(char separator)

Set the character separator used to format output messages.

Parameters:

separator - the new separator

isTraceEnabled

public boolean isTraceEnabled()

Test whether trace output is enabled for this ConsoleLogger.

Specified by:

isTraceEnabled in interface Logger

Returns:

true if trace output is enabled

isDebugEnabled

public boolean isDebugEnabled()

Test whether debug output is enabled for this ConsoleLogger.

Specified by:

isDebugEnabled in interface Logger

Returns:

true if debug output is enabled

isInfoEnabled

public boolean isInfoEnabled()

Test whether info output is enabled for this ConsoleLogger.

Specified by:

isInfoEnabled in interface Logger

Returns:

true if info output is enabled

isWarnEnabled

public boolean isWarnEnabled()

Test whether warning output is enabled for this ConsoleLogger.

Specified by:

isWarnEnabled in interface Logger

Returns:

true if warning output is enabled

isErrorEnabled

public boolean isErrorEnabled()

Test whether error output is enabled for this ConsoleLogger.

Specified by:

isErrorEnabled in interface Logger

Returns:

true if error output is enabled

trace

public void trace(Object message)

Output a trace message.

Specified by:

trace in interface Logger

Parameters:

message - the message (will be output using Object.toString()

debug

public void debug(Object message)

Output a debug message.

Specified by:

debug in interface Logger

Parameters:

message - the message (will be output using Object.toString()

info

public void info(Object message)

Output an info message.

Specified by:

info in interface Logger

Parameters:

message - the message (will be output using Object.toString()

warn

public void warn(Object message)

Output a warning message.

Specified by:

warn in interface Logger

Parameters:

message - the message (will be output using Object.toString()

error

public void error(Object message)

Output an error message.

Specified by:

error in interface Logger

Parameters:

message - the message (will be output using Object.toString()

error

public void error(Object message,
                  Throwable throwable)

Output an error message along with a Throwable.

Specified by:

error in interface Logger

Parameters:

message - the message (will be output using Object.toString()

throwable - the Throwable