org.pfsw.logging.stdout

Class PrintStreamLogger

java.lang.Object

org.pfsw.logging.internal.AbstractLogger

org.pfsw.logging.stdout.PrintStreamLogger

All Implemented Interfaces:

Logger

public class PrintStreamLogger
extends AbstractLogger

This logger supports simple output to a print stream. By default that print stream is stdout. But it can changed by setting the property 'logging.printstream.file' to a filename. Then it will open that file at first access and appends all output to it.

The initial log level is ERROR. It can be changed via the property 'logging.level' (e.g. logging.level=WARNING).

Field Summary

Fields

Modifier and Type	Field and Description
static int	LEVEL_DEBUG This log level specifies that all messages will be logged
static int	LEVEL_ERROR This log level specifies that only error messages will be logged
static int	LEVEL_INFO This log level specifies that only error, warning and info messages will be logged
static int	LEVEL_NONE This log level specifies that no message at all will be logged
static int	LEVEL_WARN This log level specifies that only error and warning messages will be logged
static java.lang.String	PROP_LOG_LEVEL The property to set the log level.
static java.lang.String	PROP_LOGGER_NAME The property to set the the name of the logger.
static java.lang.String	PROP_OUTPUT_FILE The property that specifies a filename to redirect the log output

Fields inherited from interface org.pfsw.logging.Logger

ANONYMOUS_LOGGER_NAME, LL_DEBUG, LL_ERROR, LL_INFO, LL_NONE, LL_WARNING

Constructor Summary

Constructors

Constructor and Description
PrintStreamLogger() Initialize the new instance with default values.
PrintStreamLogger(java.lang.String loggerName) Initialize the new instance with a logger name.

Method Summary

Modifier and Type	Method and Description
static PrintStreamLogger	create(java.lang.String loggerName) Create a new instance with a logger name.
protected java.lang.String	getLevelIndicator(int level)
int	getLogLevel() Returns the current log level
protected LogMessageOutputTarget	getOutputTarget()
void	initialize(java.util.Properties properties) Initialize the logger from the given properties settings.
protected boolean	initLogLevel(java.lang.String level)
protected void	initPrintStream(java.lang.String filename)
boolean	isLoggingDebugs() Returns true, if debug messages will be written to the output device(s).
boolean	isLoggingErrors() Returns true, if errors will be written to the output device(s).
boolean	isLoggingInfos() Returns true, if info messages will be written to the output device(s).
boolean	isLoggingWarnings() Returns true, if warnings will be written to the output device(s).
void	logDebug(java.lang.String message, java.lang.Object... params) If the logging level is DEBUG the given message will be written to the log output device(s).
void	logError(java.lang.String message, java.lang.Object... params) If the logging level is DEBUG, INFO, WARNING or ERROR the given message will be written to the log output device(s).
void	logError(java.lang.String message, java.lang.Throwable exception) If the logging level is DEBUG, INFO, WARNING or ERROR the given message and the exception will be written to the log output device(s).
void	logException(java.lang.Throwable ex) Writes the given exception to the log output device(s).
void	logInfo(java.lang.String message, java.lang.Object... params) If the logging level is INFO or DEBUG the given message will be written to the log output device(s).
void	logWarning(java.lang.String message, java.lang.Object... params) If the logging level is DEBUG, INFO or WARNING the given message will be written to the log output device(s).
void	logWarning(java.lang.String message, java.lang.Throwable exception) If the logging level is DEBUG, INFO or WARNING the given message and the exception will be written to the log output device(s).
protected void	print(int level, java.lang.String message, java.lang.Object... params)
protected void	print(java.lang.String text)
protected void	printException(java.lang.Throwable ex)
protected void	println()
protected void	println(int level, java.lang.String text, java.lang.Object... params)
protected void	printLoggerNameIfSet()
void	setLogLevel(int newLevel) Set the current log level of this logger.
boolean	setLogLevel(java.lang.String logLevel) Changes the log level to the specified level.
protected void	setOutputTarget(LogMessageOutputTarget outputTarget)
protected boolean	useLevelIndicators()

Methods inherited from class org.pfsw.logging.internal.AbstractLogger

getLoggerName, getName, isNullOrBlank, isNullOrEmpty, replacePlaceholders, setLoggerName

Methods inherited from class java.lang.Object

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

Field Detail

LEVEL_NONE

public static final int LEVEL_NONE

This log level specifies that no message at all will be logged

See Also:

Constant Field Values

LEVEL_ERROR

public static final int LEVEL_ERROR

This log level specifies that only error messages will be logged

See Also:

Constant Field Values

LEVEL_WARN

public static final int LEVEL_WARN

This log level specifies that only error and warning messages will be logged

See Also:

Constant Field Values

LEVEL_INFO

public static final int LEVEL_INFO

This log level specifies that only error, warning and info messages will be logged

See Also:

Constant Field Values

LEVEL_DEBUG

public static final int LEVEL_DEBUG

This log level specifies that all messages will be logged

See Also:

Constant Field Values

PROP_OUTPUT_FILE

public static final java.lang.String PROP_OUTPUT_FILE

The property that specifies a filename to redirect the log output

"logging.printstream.file"

See Also:

Constant Field Values

PROP_LOG_LEVEL

public static final java.lang.String PROP_LOG_LEVEL

The property to set the log level. The value must be one of the following strings: "NONE", "ERROR", "WARNING", "INFO", "DEBUG"

"logging.level"

See Also:

Constant Field Values

PROP_LOGGER_NAME

public static final java.lang.String PROP_LOGGER_NAME

The property to set the the name of the logger.

"logging.logger.name"

See Also:

Constant Field Values

Constructor Detail

PrintStreamLogger

public PrintStreamLogger()

Initialize the new instance with default values.

PrintStreamLogger

public PrintStreamLogger(java.lang.String loggerName)

Initialize the new instance with a logger name.

Method Detail

create

public static PrintStreamLogger create(java.lang.String loggerName)

Create a new instance with a logger name.

getLogLevel

public int getLogLevel()

Returns the current log level

setLogLevel

public void setLogLevel(int newLevel)

Set the current log level of this logger.
The default is LEVEL_ERROR.

Parameters:

newLevel - The new log level (i.e. one of the LEVEL_ constants of this class)

initialize

public void initialize(java.util.Properties properties)

Initialize the logger from the given properties settings. Currently the following properties are supported:

logging.printstream.file

The name of a file to which all logging should be redirected

logging.level

The log level. Must be one of "NONE", "ERROR", "WARNING", "INFO", "DEBUG"

logException

public void logException(java.lang.Throwable ex)

Writes the given exception to the log output device(s). The log level will be ignored.

logDebug

public void logDebug(java.lang.String message,
                     java.lang.Object... params)

If the logging level is DEBUG the given message will be written to the log output device(s).

Parameters:

message - The message to log. It may contain placeholders like {0}, {1} etc.

params - Optional parameters to be used for replacing placeholders in the message text.

logInfo

public void logInfo(java.lang.String message,
                    java.lang.Object... params)

If the logging level is INFO or DEBUG the given message will be written to the log output device(s).

Parameters:

message - The message to log. It may contain placeholders like {0}, {1} etc.

params - Optional parameters to be used for replacing placeholders in the message text.

logWarning

public void logWarning(java.lang.String message,
                       java.lang.Object... params)

If the logging level is DEBUG, INFO or WARNING the given message will be written to the log output device(s).

Parameters:

message - The message to log. It may contain placeholders like {0}, {1} etc.

params - Optional parameters to be used for replacing placeholders in the message text.

logError

public void logError(java.lang.String message,
                     java.lang.Object... params)

If the logging level is DEBUG, INFO, WARNING or ERROR the given message will be written to the log output device(s).

Parameters:

message - The message to log. It may contain placeholders like {0}, {1} etc.

params - Optional parameters to be used for replacing placeholders in the message text.

logWarning

public void logWarning(java.lang.String message,
                       java.lang.Throwable exception)

If the logging level is DEBUG, INFO or WARNING the given message and the exception will be written to the log output device(s).

logError

public void logError(java.lang.String message,
                     java.lang.Throwable exception)

If the logging level is DEBUG, INFO, WARNING or ERROR the given message and the exception will be written to the log output device(s).

isLoggingDebugs

public boolean isLoggingDebugs()

Returns true, if debug messages will be written to the output device(s).

isLoggingInfos

public boolean isLoggingInfos()

Returns true, if info messages will be written to the output device(s).

isLoggingWarnings

public boolean isLoggingWarnings()

Returns true, if warnings will be written to the output device(s).

isLoggingErrors

public boolean isLoggingErrors()

Returns true, if errors will be written to the output device(s).

setLogLevel

public boolean setLogLevel(java.lang.String logLevel)

Changes the log level to the specified level. Returns true if the level is supported and was set, otherwise false.

Parameters:

logLevel - One of the LL_ constants defined in this interface (e.g. Logger.LL_ERROR).

Returns:

Always false for this logger

print

protected void print(java.lang.String text)

print

protected void print(int level,
                     java.lang.String message,
                     java.lang.Object... params)

println

protected void println(int level,
                       java.lang.String text,
                       java.lang.Object... params)

println

protected void println()

printLoggerNameIfSet

protected void printLoggerNameIfSet()

printException

protected void printException(java.lang.Throwable ex)

getLevelIndicator

protected java.lang.String getLevelIndicator(int level)

useLevelIndicators

protected boolean useLevelIndicators()

initPrintStream

protected void initPrintStream(java.lang.String filename)

initLogLevel

protected boolean initLogLevel(java.lang.String level)

getOutputTarget

protected LogMessageOutputTarget getOutputTarget()

setOutputTarget

protected void setOutputTarget(LogMessageOutputTarget outputTarget)