org.usefultoys.slf4j

Class LoggerFactory

java.lang.Object

org.usefultoys.slf4j.LoggerFactory

public class LoggerFactory
extends java.lang.Object

An alternative to LoggerFactory, with additional useful methods.

Constructor Summary

Constructors

Constructor and Description
LoggerFactory()

Method Summary

Modifier and Type	Method and Description
static java.io.OutputStream	getDebugOutputStream(org.slf4j.Logger logger) Returns a OutputStream whose close and flush methods write its unformatted data as a debug message to logger.
static java.io.OutputStream	getDebugOutputStream(org.slf4j.Logger logger, java.lang.String name) Returns a OutputStream whose close and flush methods write its unformatted data as a debug message to logger.
static java.io.PrintStream	getDebugPrintStream(org.slf4j.Logger logger) Returns a PrintStream whose close and flush methods write its formatted text as a debug message to logger.
static java.io.PrintStream	getDebugPrintStream(org.slf4j.Logger logger, java.lang.String name) Returns a PrintStream whose close and flush methods write its structured text as a debug message to logger.
static java.io.OutputStream	getErrorOutputStream(org.slf4j.Logger logger) Returns a OutputStream whose close and flush methods write its unformatted data as an error message to logger.
static java.io.OutputStream	getErrorOutputStream(org.slf4j.Logger logger, java.lang.String name) Returns a OutputStream whose close and flush methods write its unformatted data as an error message to logger.
static java.io.PrintStream	getErrorPrintStream(org.slf4j.Logger logger) Returns a PrintStream whose close and flush methods write its formatted text as an error message to logger.
static java.io.PrintStream	getErrorPrintStream(org.slf4j.Logger logger, java.lang.String name) Returns a PrintStream whose close and flush methods write its structured text as an error message to logger.
static java.io.OutputStream	getInfoOutputStream(org.slf4j.Logger logger) Returns a OutputStream whose close and flush methods write its unformatted data as an information message to logger.
static java.io.OutputStream	getInfoOutputStream(org.slf4j.Logger logger, java.lang.String name) Returns a OutputStream whose close and flush methods write its unformatted data as an information message to logger.
static java.io.PrintStream	getInfoPrintStream(org.slf4j.Logger logger) Returns a PrintStream whose close and flush methods write its formatted text as an information message to logger.
static java.io.PrintStream	getInfoPrintStream(org.slf4j.Logger logger, java.lang.String name) Returns a PrintStream whose close and flush methods write its structured text as an information message to logger.
static org.slf4j.Logger	getLogger(java.lang.Class<?> clazz) Returns a logger named according to the class passed as parameter, using the statically bound ILoggerFactory instance.
static org.slf4j.Logger	getLogger(java.lang.Class<?> clazz, java.lang.String name) Returns a separate logger named according to a parent logger and the operation or feature, using the statically bound ILoggerFactory instance.
static org.slf4j.Logger	getLogger(org.slf4j.Logger logger, java.lang.String name) Returns a separate logger named according to a parent logger and the operation or feature, using the statically bound ILoggerFactory instance.
static org.slf4j.Logger	getLogger(java.lang.String name) Returns a logger named according to the name parameter using the statically bound ILoggerFactory instance.
static java.io.OutputStream	getTraceOutputStream(org.slf4j.Logger logger) Returns a OutputStream whose close and flush methods write its unformatted data as a trace message to logger.
static java.io.OutputStream	getTraceOutputStream(org.slf4j.Logger logger, java.lang.String name) Returns a OutputStream whose close and flush methods write its unformatted data as a trace message to logger.
static java.io.PrintStream	getTracePrintStream(org.slf4j.Logger logger) Returns a PrintStream whose close and flush methods write its formatted text as a trace message to logger.
static java.io.PrintStream	getTracePrintStream(org.slf4j.Logger logger, java.lang.String name) Returns a PrintStream whose close and flush methods write its structured text as a trace message to logger.
static java.io.OutputStream	getWarnOutputStream(org.slf4j.Logger logger) Returns a OutputStream whose close and flush methods write its unformatted data as a warning message to logger.
static java.io.OutputStream	getWarnOutputStream(org.slf4j.Logger logger, java.lang.String name) Returns a OutputStream whose close and flush methods write its unformatted data as a warning message to logger.
static java.io.PrintStream	getWarnPrintStream(org.slf4j.Logger logger) Returns a PrintStream whose close and flush methods write its formatted text as a warning message to logger.
static java.io.PrintStream	getWarnPrintStream(org.slf4j.Logger logger, java.lang.String name) Returns a PrintStream whose close and flush methods write its structured text as a warning message to logger.

Methods inherited from class java.lang.Object

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

Constructor Detail

LoggerFactory

public LoggerFactory()

Method Detail

getLogger

public static org.slf4j.Logger getLogger(java.lang.String name)

Returns a logger named according to the name parameter using the statically bound ILoggerFactory instance. Equivalent to LoggerFactory.getLogger(String).

Recommended to get a special purpose logger defined by the application, whose name does not follow the fully qualified name convention and that tracks some globally available feature.

Parameters:

name - The name of the logger.

Returns:

the logger

getLogger

public static org.slf4j.Logger getLogger(java.lang.Class<?> clazz)

Returns a logger named according to the class passed as parameter, using the statically bound ILoggerFactory instance.

Recommended to get a logger that tracks features provided by the class.

Parameters:

clazz - the returned logger will be named after clazz

Returns:

the logger

getLogger

public static org.slf4j.Logger getLogger(java.lang.Class<?> clazz,
                                         java.lang.String name)

Returns a separate logger named according to a parent logger and the operation or feature, using the statically bound ILoggerFactory instance.

Recommended to get a logger subordinated to an existing logger.

Parameters:

clazz - the returned logger will be named after clazz

name - the name of operation or feature appended to the parent logger name.

Returns:

the logger

getLogger

public static org.slf4j.Logger getLogger(org.slf4j.Logger logger,
                                         java.lang.String name)

Returns a separate logger named according to a parent logger and the operation or feature, using the statically bound ILoggerFactory instance.

Recommended to get a logger subordinated to an existing logger.

Parameters:

logger - the returned logger will be named after this parent logger

name - the name of operation or feature appended to the parent logger name.

Returns:

the logger

getTracePrintStream

public static java.io.PrintStream getTracePrintStream(org.slf4j.Logger logger)

Returns a PrintStream whose close and flush methods write its formatted text as a trace message to logger.

Parameters:

logger - the logger text is reported to.

Returns:

the PrintStream that writes its text to the logger.

getDebugPrintStream

public static java.io.PrintStream getDebugPrintStream(org.slf4j.Logger logger)

Returns a PrintStream whose close and flush methods write its formatted text as a debug message to logger.

Parameters:

logger - the logger text is reported to.

Returns:

the PrintStream that writes its text to the logger.

getInfoPrintStream

public static java.io.PrintStream getInfoPrintStream(org.slf4j.Logger logger)

Returns a PrintStream whose close and flush methods write its formatted text as an information message to logger.

Parameters:

logger - the logger text is reported to.

Returns:

the PrintStream that writes its text to the logger.

getWarnPrintStream

public static java.io.PrintStream getWarnPrintStream(org.slf4j.Logger logger)

Returns a PrintStream whose close and flush methods write its formatted text as a warning message to logger.

Parameters:

logger - the logger text is reported to.

Returns:

the PrintStream that writes its text to the logger.

getErrorPrintStream

public static java.io.PrintStream getErrorPrintStream(org.slf4j.Logger logger)

Returns a PrintStream whose close and flush methods write its formatted text as an error message to logger.

Parameters:

logger - the logger text is reported to.

Returns:

the PrintStream that writes its text to the logger.

getTraceOutputStream

public static java.io.OutputStream getTraceOutputStream(org.slf4j.Logger logger)

Returns a OutputStream whose close and flush methods write its unformatted data as a trace message to logger.

Parameters:

logger - the logger data is reported to.

Returns:

the OutputStream that writes its data to the logger.

getDebugOutputStream

public static java.io.OutputStream getDebugOutputStream(org.slf4j.Logger logger)

Returns a OutputStream whose close and flush methods write its unformatted data as a debug message to logger.

Parameters:

logger - the logger data is reported to.

Returns:

the OutputStream that writes its data to the logger.

getInfoOutputStream

public static java.io.OutputStream getInfoOutputStream(org.slf4j.Logger logger)

Returns a OutputStream whose close and flush methods write its unformatted data as an information message to logger.

Parameters:

logger - the logger data is reported to.

Returns:

the OutputStream that writes its data to the logger.

getWarnOutputStream

public static java.io.OutputStream getWarnOutputStream(org.slf4j.Logger logger)

Returns a OutputStream whose close and flush methods write its unformatted data as a warning message to logger.

Parameters:

logger - the logger data is reported to.

Returns:

the OutputStream that writes its data to the logger.

getErrorOutputStream

public static java.io.OutputStream getErrorOutputStream(org.slf4j.Logger logger)

Returns a OutputStream whose close and flush methods write its unformatted data as an error message to logger.

Parameters:

logger - the logger data is reported to.

Returns:

the OutputStream that writes its data to the logger.

getTracePrintStream

public static java.io.PrintStream getTracePrintStream(org.slf4j.Logger logger,
                                                      java.lang.String name)

Returns a PrintStream whose close and flush methods write its structured text as a trace message to logger. Shortcut to getTracePrintStream(LoggerFactory.getLogger(logger, name)).

Parameters:

logger - the logger text is reported to.

name - the name of operation or feature appended to the logger name.

Returns:

the PrintStream that writes its text to the logger.

getDebugPrintStream

public static java.io.PrintStream getDebugPrintStream(org.slf4j.Logger logger,
                                                      java.lang.String name)

Returns a PrintStream whose close and flush methods write its structured text as a debug message to logger. Shortcut to getDebugPrintStream(LoggerFactory.getLogger(logger, name)).

Parameters:

logger - the logger text is reported to.

name - the name of operation or feature appended to the logger name.

Returns:

the PrintStream that writes its text to the logger.

getInfoPrintStream

public static java.io.PrintStream getInfoPrintStream(org.slf4j.Logger logger,
                                                     java.lang.String name)

Returns a PrintStream whose close and flush methods write its structured text as an information message to logger. Shortcut to getInfoPrintStream(LoggerFactory.getLogger(logger, name)).

Parameters:

logger - the logger text is reported to.

name - the name of operation or feature appended to the logger name.

Returns:

the PrintStream that writes its text to the logger.

getWarnPrintStream

public static java.io.PrintStream getWarnPrintStream(org.slf4j.Logger logger,
                                                     java.lang.String name)

Returns a PrintStream whose close and flush methods write its structured text as a warning message to logger. Shortcut to getWarnPrintStream(LoggerFactory.getLogger(logger, name)).

Parameters:

logger - the logger text is reported to.

name - the name of operation or feature appended to the logger name.

Returns:

the PrintStream that writes its text to the logger.

getErrorPrintStream

public static java.io.PrintStream getErrorPrintStream(org.slf4j.Logger logger,
                                                      java.lang.String name)

Returns a PrintStream whose close and flush methods write its structured text as an error message to logger. Shortcut to getErrorPrintStream(LoggerFactory.getLogger(logger, name)).

Parameters:

logger - the logger text is reported to.

name - the name of operation or feature appended to the logger name.

Returns:

the PrintStream that writes its text to the logger.

getTraceOutputStream

public static java.io.OutputStream getTraceOutputStream(org.slf4j.Logger logger,
                                                        java.lang.String name)

Returns a OutputStream whose close and flush methods write its unformatted data as a trace message to logger. Shortcut to getTraceOutputStream(LoggerFactory.getLogger(logger, name)).

Parameters:

logger - the logger data is reported to.

name - the name of operation or feature appended to the logger name.

Returns:

the OutputStream that writes its data to the logger.

getDebugOutputStream

public static java.io.OutputStream getDebugOutputStream(org.slf4j.Logger logger,
                                                        java.lang.String name)

Returns a OutputStream whose close and flush methods write its unformatted data as a debug message to logger. Shortcut to getDebugOutputStream(LoggerFactory.getLogger(logger, name)).

Parameters:

logger - the logger data is reported to.

name - the name of operation or feature appended to the logger name.

Returns:

the OutputStream that writes its data to the logger.

getInfoOutputStream

public static java.io.OutputStream getInfoOutputStream(org.slf4j.Logger logger,
                                                       java.lang.String name)

Returns a OutputStream whose close and flush methods write its unformatted data as an information message to logger. Shortcut to getInfoOutputStream(LoggerFactory.getLogger(logger, name)).

Parameters:

logger - the logger data is reported to.

name - the name of operation or feature appended to the logger name.

Returns:

the OutputStream that writes its data to the logger.

getWarnOutputStream

public static java.io.OutputStream getWarnOutputStream(org.slf4j.Logger logger,
                                                       java.lang.String name)

Returns a OutputStream whose close and flush methods write its unformatted data as a warning message to logger. Shortcut to getWarnOutputStream(LoggerFactory.getLogger(logger, name)).

Parameters:

logger - the logger data is reported to.

name - the name of operation or feature appended to the logger name.

Returns:

the OutputStream that writes its data to the logger.

getErrorOutputStream

public static java.io.OutputStream getErrorOutputStream(org.slf4j.Logger logger,
                                                        java.lang.String name)

Returns a OutputStream whose close and flush methods write its unformatted data as an error message to logger. unformatted data as a error level message to to the logger. Shortcut to getErrorOutputStream(LoggerFactory.getLogger(logger, name)).

Parameters:

logger - the logger data is reported to.

name - the name of operation or feature appended to the logger name.

Returns:

the OutputStream that writes its data to the logger.