public abstract class AbstractLogger extends Object implements Logger, Serializable
Modifier and Type | Field and Description |
---|---|
static Marker |
CATCHING_MARKER
Marker for catching exceptions.
|
static Class<? extends MessageFactory> |
DEFAULT_MESSAGE_FACTORY_CLASS
The default MessageFactory class.
|
static Marker |
ENTRY_MARKER
Marker for method entry tracing.
|
static Marker |
EXCEPTION_MARKER
Marker for exception tracing.
|
static Marker |
EXIT_MARKER
Marker for method exit tracing.
|
static Marker |
FLOW_MARKER
Marker for flow tracing.
|
static Marker |
THROWING_MARKER
Marker for throwing exceptions.
|
Constructor and Description |
---|
AbstractLogger()
Creates a new logger named after the class (or subclass).
|
AbstractLogger(String name)
Creates a new named logger.
|
AbstractLogger(String name,
MessageFactory messageFactory)
Creates a new named logger.
|
Modifier and Type | Method and Description |
---|---|
void |
catching(Level level,
Throwable t)
Logs a Throwable that has been caught.
|
protected void |
catching(String fqcn,
Level level,
Throwable t)
Logs a Throwable that has been caught with location information.
|
void |
catching(Throwable t)
Logs a Throwable at the
ERROR level.. |
static void |
checkMessageFactory(Logger logger,
MessageFactory messageFactory)
Checks that the message factory a logger was created with is the same as the given messageFactory.
|
void |
debug(Marker marker,
Message msg)
Logs a message with the specific Marker at the DEBUG level.
|
void |
debug(Marker marker,
Message msg,
Throwable t)
Logs a message with the specific Marker at the DEBUG level.
|
void |
debug(Marker marker,
Object message)
Logs a message object with the
DEBUG level. |
void |
debug(Marker marker,
Object message,
Throwable t)
|
void |
debug(Marker marker,
String message)
Logs a message object with the
DEBUG level. |
void |
debug(Marker marker,
String message,
Object... params)
Logs a message with parameters at the
DEBUG level. |
void |
debug(Marker marker,
String message,
Throwable t)
|
void |
debug(Message msg)
Logs a message with the specific Marker at the DEBUG level.
|
void |
debug(Message msg,
Throwable t)
Logs a message with the specific Marker at the DEBUG level.
|
void |
debug(Object message)
Logs a message object with the
DEBUG level. |
void |
debug(Object message,
Throwable t)
|
void |
debug(String message)
Logs a message object with the
DEBUG level. |
void |
debug(String message,
Object... params)
Logs a message with parameters at the
DEBUG level. |
void |
debug(String message,
Throwable t)
|
void |
entry()
Logs entry to a method.
|
void |
entry(Object... params)
Logs entry to a method.
|
protected void |
entry(String fqcn,
Object... params)
Logs entry to a method with location information.
|
void |
error(Marker marker,
Message msg)
Logs a message with the specific Marker at the
ERROR level. |
void |
error(Marker marker,
Message msg,
Throwable t)
Logs a message with the specific Marker at the
ERROR level. |
void |
error(Marker marker,
Object message)
Logs a message object with the
ERROR level. |
void |
error(Marker marker,
Object message,
Throwable t)
|
void |
error(Marker marker,
String message)
Logs a message object with the
ERROR level. |
void |
error(Marker marker,
String message,
Object... params)
Logs a message with parameters at the
ERROR level. |
void |
error(Marker marker,
String message,
Throwable t)
|
void |
error(Message msg)
Logs a message with the specific Marker at the
ERROR level. |
void |
error(Message msg,
Throwable t)
Logs a message with the specific Marker at the
ERROR level. |
void |
error(Object message)
Logs a message object with the
ERROR level. |
void |
error(Object message,
Throwable t)
|
void |
error(String message)
Logs a message object with the
ERROR level. |
void |
error(String message,
Object... params)
Logs a message with parameters at the
ERROR level. |
void |
error(String message,
Throwable t)
|
void |
exit()
Logs exit from a method.
|
<R> R |
exit(R result)
Logs exiting from a method with the result.
|
protected <R> R |
exit(String fqcn,
R result)
Logs exiting from a method with the result and location information.
|
void |
fatal(Marker marker,
Message msg)
Logs a message with the specific Marker at the FATAL level.
|
void |
fatal(Marker marker,
Message msg,
Throwable t)
Logs a message with the specific Marker at the FATAL level.
|
void |
fatal(Marker marker,
Object message)
Logs a message object with the
FATAL level. |
void |
fatal(Marker marker,
Object message,
Throwable t)
|
void |
fatal(Marker marker,
String message)
Logs a message object with the
FATAL level. |
void |
fatal(Marker marker,
String message,
Object... params)
Logs a message with parameters at the
FATAL level. |
void |
fatal(Marker marker,
String message,
Throwable t)
|
void |
fatal(Message msg)
Logs a message with the specific Marker at the FATAL level.
|
void |
fatal(Message msg,
Throwable t)
Logs a message with the specific Marker at the FATAL level.
|
void |
fatal(Object message)
Logs a message object with the
FATAL level. |
void |
fatal(Object message,
Throwable t)
|
void |
fatal(String message)
Logs a message object with the
FATAL level. |
void |
fatal(String message,
Object... params)
Logs a message with parameters at the
FATAL level. |
void |
fatal(String message,
Throwable t)
|
MessageFactory |
getMessageFactory()
Gets the message factory.
|
String |
getName()
Gets the logger name.
|
LoggerStream |
getStream(Level level)
Gets a print stream that logs lines to this logger.
|
LoggerStream |
getStream(Marker marker,
Level level)
Gets a marked print stream that logs lines to this logger.
|
void |
info(Marker marker,
Message msg)
Logs a message with the specific Marker at the INFO level.
|
void |
info(Marker marker,
Message msg,
Throwable t)
Logs a message with the specific Marker at the INFO level.
|
void |
info(Marker marker,
Object message)
Logs a message object with the
INFO level. |
void |
info(Marker marker,
Object message,
Throwable t)
|
void |
info(Marker marker,
String message)
Logs a message object with the
INFO level. |
void |
info(Marker marker,
String message,
Object... params)
Logs a message with parameters at the
INFO level. |
void |
info(Marker marker,
String message,
Throwable t)
|
void |
info(Message msg)
Logs a message with the specific Marker at the TRACE level.
|
void |
info(Message msg,
Throwable t)
Logs a message with the specific Marker at the INFO level.
|
void |
info(Object message)
Logs a message object with the
INFO level. |
void |
info(Object message,
Throwable t)
|
void |
info(String message)
Logs a message object with the
INFO level. |
void |
info(String message,
Object... params)
Logs a message with parameters at the
INFO level. |
void |
info(String message,
Throwable t)
|
boolean |
isDebugEnabled()
Checks whether this Logger is enabled for the DEBUG Level.
|
boolean |
isDebugEnabled(Marker marker)
Checks whether this Logger is enabled for the DEBUG Level.
|
boolean |
isEnabled(Level level)
Checks whether this Logger is enabled for the the given Level.
|
boolean |
isEnabled(Level level,
Marker marker)
Checks whether this logger is enabled at the specified level and an optional Marker.
|
protected abstract boolean |
isEnabled(Level level,
Marker marker,
Message data,
Throwable t)
Determine if logging is enabled.
|
protected abstract boolean |
isEnabled(Level level,
Marker marker,
Object data,
Throwable t)
Determine if logging is enabled.
|
protected abstract boolean |
isEnabled(Level level,
Marker marker,
String data)
Determine if logging is enabled.
|
protected abstract boolean |
isEnabled(Level level,
Marker marker,
String data,
Object... p1)
Determine if logging is enabled.
|
protected abstract boolean |
isEnabled(Level level,
Marker marker,
String data,
Throwable t)
Determine if logging is enabled.
|
boolean |
isErrorEnabled()
Checks whether this Logger is enabled for the
ERROR Level. |
boolean |
isErrorEnabled(Marker marker)
Checks whether this Logger is enabled for the
ERROR Level. |
boolean |
isFatalEnabled()
Checks whether this Logger is enabled for the FATAL Level.
|
boolean |
isFatalEnabled(Marker marker)
Checks whether this Logger is enabled for the FATAL Level.
|
boolean |
isInfoEnabled()
Checks whether this Logger is enabled for the INFO Level.
|
boolean |
isInfoEnabled(Marker marker)
Checks whether this Logger is enabled for the INFO Level.
|
boolean |
isTraceEnabled()
Checks whether this Logger is enabled for the TRACE Level.
|
boolean |
isTraceEnabled(Marker marker)
Checks whether this Logger is enabled for the TRACE Level.
|
boolean |
isWarnEnabled()
Checks whether this Logger is enabled for the WARN Level.
|
boolean |
isWarnEnabled(Marker marker)
Checks whether this Logger is enabled for the WARN Level.
|
void |
log(Level level,
Marker marker,
Message msg)
Logs a message with the specific Marker at the given level.
|
void |
log(Level level,
Marker marker,
Message msg,
Throwable t)
Logs a message with the specific Marker at the given level.
|
void |
log(Level level,
Marker marker,
Object message)
Logs a message object with the given level.
|
void |
log(Level level,
Marker marker,
Object message,
Throwable t)
Logs a message at the given level including the stack trace of the
Throwable t passed as
parameter. |
void |
log(Level level,
Marker marker,
String message)
Logs a message object with the given level.
|
void |
log(Level level,
Marker marker,
String message,
Object... params)
Logs a message with parameters at the given level.
|
void |
log(Level level,
Marker marker,
String message,
Throwable t)
Logs a message at the given level including the stack trace of the
Throwable t passed as
parameter. |
void |
log(Level level,
Message msg)
Logs a message with the specific Marker at the given level.
|
void |
log(Level level,
Message msg,
Throwable t)
Logs a message with the specific Marker at the given level.
|
void |
log(Level level,
Object message)
Logs a message object with the given level.
|
void |
log(Level level,
Object message,
Throwable t)
Logs a message at the given level including the stack trace of the
Throwable t passed as
parameter. |
void |
log(Level level,
String message)
Logs a message object with the given level.
|
void |
log(Level level,
String message,
Object... params)
Logs a message with parameters at the given level.
|
void |
log(Level level,
String message,
Throwable t)
Logs a message at the given level including the stack trace of the
Throwable t passed as
parameter. |
abstract void |
log(Marker marker,
String fqcn,
Level level,
Message data,
Throwable t)
Logs a message with location information.
|
void |
printf(Level level,
Marker marker,
String format,
Object... params)
Logs a formatted message using the specified format string and arguments.
|
void |
printf(Level level,
String format,
Object... params)
Logs a formatted message using the specified format string and arguments.
|
<T extends Throwable> |
throwing(Level level,
T t)
Logs a Throwable to be thrown.
|
protected <T extends Throwable> |
throwing(String fqcn,
Level level,
T t)
Logs a Throwable to be thrown with location information.
|
<T extends Throwable> |
throwing(T t)
Logs a Throwable to be thrown.
|
String |
toString()
Returns a String representation of this instance in the form
"name" . |
void |
trace(Marker marker,
Message msg)
Logs a message with the specific Marker at the TRACE level.
|
void |
trace(Marker marker,
Message msg,
Throwable t)
Logs a message with the specific Marker at the TRACE level.
|
void |
trace(Marker marker,
Object message)
Logs a message object with the
TRACE level. |
void |
trace(Marker marker,
Object message,
Throwable t)
|
void |
trace(Marker marker,
String message)
Logs a message object with the
TRACE level. |
void |
trace(Marker marker,
String message,
Object... params)
Logs a message with parameters at the
TRACE level. |
void |
trace(Marker marker,
String message,
Throwable t)
|
void |
trace(Message msg)
Logs a message with the specific Marker at the TRACE level.
|
void |
trace(Message msg,
Throwable t)
Logs a message with the specific Marker at the TRACE level.
|
void |
trace(Object message)
Logs a message object with the
TRACE level. |
void |
trace(Object message,
Throwable t)
|
void |
trace(String message)
Logs a message object with the
TRACE level. |
void |
trace(String message,
Object... params)
Logs a message with parameters at the
TRACE level. |
void |
trace(String message,
Throwable t)
|
void |
warn(Marker marker,
Message msg)
Logs a message with the specific Marker at the WARN level.
|
void |
warn(Marker marker,
Message msg,
Throwable t)
Logs a message with the specific Marker at the WARN level.
|
void |
warn(Marker marker,
Object message)
Logs a message object with the
WARN level. |
void |
warn(Marker marker,
Object message,
Throwable t)
|
void |
warn(Marker marker,
String message)
Logs a message object with the
WARN level. |
void |
warn(Marker marker,
String message,
Object... params)
Logs a message with parameters at the
WARN level. |
void |
warn(Marker marker,
String message,
Throwable t)
|
void |
warn(Message msg)
Logs a message with the specific Marker at the WARN level.
|
void |
warn(Message msg,
Throwable t)
Logs a message with the specific Marker at the WARN level.
|
void |
warn(Object message)
Logs a message object with the
WARN level. |
void |
warn(Object message,
Throwable t)
|
void |
warn(String message)
Logs a message object with the
WARN level. |
void |
warn(String message,
Object... params)
Logs a message with parameters at the
WARN level. |
void |
warn(String message,
Throwable t)
|
public static final Marker FLOW_MARKER
public static final Marker ENTRY_MARKER
public static final Marker EXIT_MARKER
public static final Marker EXCEPTION_MARKER
public static final Marker THROWING_MARKER
public static final Marker CATCHING_MARKER
public static final Class<? extends MessageFactory> DEFAULT_MESSAGE_FACTORY_CLASS
public AbstractLogger()
public AbstractLogger(String name)
name
- the logger namepublic AbstractLogger(String name, MessageFactory messageFactory)
name
- the logger namemessageFactory
- the message factory, if null then use the default message factory.public static void checkMessageFactory(Logger logger, MessageFactory messageFactory)
DEFAULT_MESSAGE_FACTORY_CLASS
.logger
- The logger to checkmessageFactory
- The message factory to check.protected void catching(String fqcn, Level level, Throwable t)
fqcn
- The fully qualified class name of the caller.level
- The logging level.t
- The Throwable.public void debug(Marker marker, Message msg)
public void debug(Marker marker, Message msg, Throwable t)
public void debug(Marker marker, String message, Object... params)
DEBUG
level.debug
in interface Logger
marker
- the marker data specific to this log statement.message
- the message to log.params
- parameters to the message.Logger.getMessageFactory()
public void debug(Message msg)
public void debug(Message msg, Throwable t)
public void debug(String message, Object... params)
DEBUG
level.debug
in interface Logger
message
- the message to log.params
- parameters to the message.Logger.getMessageFactory()
public void entry(Object... params)
protected void entry(String fqcn, Object... params)
fqcn
- The fully qualified class name of the caller.params
- The parameters to the method.public void error(Marker marker, Message msg)
ERROR
level.public void error(Marker marker, Message msg, Throwable t)
ERROR
level.public void error(Marker marker, String message, Object... params)
ERROR
level.error
in interface Logger
marker
- the marker data specific to this log statement.message
- the message to log.params
- parameters to the message.Logger.getMessageFactory()
public void error(Message msg, Throwable t)
ERROR
level.public void error(String message, Object... params)
ERROR
level.error
in interface Logger
message
- the message to log.params
- parameters to the message.Logger.getMessageFactory()
public <R> R exit(R result)
protected <R> R exit(String fqcn, R result)
R
- The type of the parameter and object being returned.fqcn
- The fully qualified class name of the caller.result
- The result being returned from the method call.public void fatal(Marker marker, Message msg)
public void fatal(Marker marker, Message msg, Throwable t)
public void fatal(Marker marker, String message, Object... params)
FATAL
level.fatal
in interface Logger
marker
- the marker data specific to this log statement.message
- the message to log.params
- parameters to the message.Logger.getMessageFactory()
public void fatal(Message msg)
public void fatal(Message msg, Throwable t)
public void fatal(String message, Object... params)
FATAL
level.fatal
in interface Logger
message
- the message to log.params
- parameters to the message.Logger.getMessageFactory()
public MessageFactory getMessageFactory()
getMessageFactory
in interface Logger
public LoggerStream getStream(Level level)
public LoggerStream getStream(Marker marker, Level level)
public void info(Marker marker, Message msg)
public void info(Marker marker, Message msg, Throwable t)
public void info(Marker marker, String message, Object... params)
INFO
level.info
in interface Logger
marker
- the marker data specific to this log statement.message
- the message to log.params
- parameters to the message.Logger.getMessageFactory()
public void info(Message msg)
public void info(Message msg, Throwable t)
public void info(String message, Object... params)
INFO
level.info
in interface Logger
message
- the message to log.params
- parameters to the message.Logger.getMessageFactory()
public boolean isDebugEnabled()
isDebugEnabled
in interface Logger
true
if this Logger is enabled for level DEBUG, false
otherwise.public boolean isDebugEnabled(Marker marker)
isDebugEnabled
in interface Logger
marker
- The marker data.true
if this Logger is enabled for level DEBUG, false
otherwise.public boolean isEnabled(Level level)
Note that passing in OFF
always returns true
.
public boolean isEnabled(Level level, Marker marker)
Logger
protected abstract boolean isEnabled(Level level, Marker marker, Message data, Throwable t)
level
- The logging Level to check.marker
- A Marker or null.data
- The Message.t
- A Throwable.protected abstract boolean isEnabled(Level level, Marker marker, Object data, Throwable t)
level
- The logging Level to check.marker
- A Marker or null.data
- The message.t
- A Throwable.protected abstract boolean isEnabled(Level level, Marker marker, String data)
level
- The logging Level to check.marker
- A Marker or null.data
- The message.protected abstract boolean isEnabled(Level level, Marker marker, String data, Object... p1)
level
- The logging Level to check.marker
- A Marker or null.data
- The message.p1
- The parameters.protected abstract boolean isEnabled(Level level, Marker marker, String data, Throwable t)
level
- The logging Level to check.marker
- A Marker or null.data
- The message.t
- A Throwable.public boolean isErrorEnabled()
ERROR
Level.isErrorEnabled
in interface Logger
true
if this Logger is enabled for level ERROR
, false
otherwise.public boolean isErrorEnabled(Marker marker)
ERROR
Level.isErrorEnabled
in interface Logger
marker
- The marker data.true
if this Logger is enabled for level ERROR
, false
otherwise.public boolean isFatalEnabled()
isFatalEnabled
in interface Logger
true
if this Logger is enabled for level FATAL, false
otherwise.public boolean isFatalEnabled(Marker marker)
isFatalEnabled
in interface Logger
marker
- The marker data.true
if this Logger is enabled for level FATAL, false
otherwise.public boolean isInfoEnabled()
isInfoEnabled
in interface Logger
true
if this Logger is enabled for level INFO, false
otherwise.public boolean isInfoEnabled(Marker marker)
isInfoEnabled
in interface Logger
marker
- The marker data.true
if this Logger is enabled for level INFO, false
otherwise.public boolean isTraceEnabled()
isTraceEnabled
in interface Logger
true
if this Logger is enabled for level TRACE, false
otherwise.public boolean isTraceEnabled(Marker marker)
isTraceEnabled
in interface Logger
marker
- The marker data.true
if this Logger is enabled for level TRACE, false
otherwise.public boolean isWarnEnabled()
isWarnEnabled
in interface Logger
true
if this Logger is enabled for level WARN, false
otherwise.public boolean isWarnEnabled(Marker marker)
isWarnEnabled
in interface Logger
marker
- The marker data.true
if this Logger is enabled for level WARN, false
otherwise.public void log(Level level, Marker marker, Message msg)
public void log(Level level, Marker marker, Message msg, Throwable t)
public void log(Level level, Marker marker, Object message)
public void log(Level level, Marker marker, Object message, Throwable t)
Throwable
t
passed as
parameter.public void log(Level level, Marker marker, String message)
public void log(Level level, Marker marker, String message, Object... params)
log
in interface Logger
level
- the logging levelmarker
- the marker data specific to this log statement.message
- the message to log.params
- parameters to the message.Logger.getMessageFactory()
public void log(Level level, Marker marker, String message, Throwable t)
Throwable
t
passed as
parameter.public void log(Level level, Message msg)
public void log(Level level, Message msg, Throwable t)
public void log(Level level, Object message, Throwable t)
Throwable
t
passed as
parameter.public void log(Level level, String message, Object... params)
log
in interface Logger
level
- the logging levelmessage
- the message to log.params
- parameters to the message.Logger.getMessageFactory()
public void log(Level level, String message, Throwable t)
Throwable
t
passed as
parameter.public abstract void log(Marker marker, String fqcn, Level level, Message data, Throwable t)
marker
- The Markerfqcn
- The fully qualified class name of the callerlevel
- The logging leveldata
- The Message.t
- A Throwable or null.public void printf(Level level, Marker marker, String format, Object... params)
public void printf(Level level, String format, Object... params)
protected <T extends Throwable> T throwing(String fqcn, Level level, T t)
T
- the type of the Throwable.fqcn
- The fully qualified class name of the caller.level
- The logging Level.t
- The Throwable.public <T extends Throwable> T throwing(T t)
public String toString()
"name"
.public void trace(Marker marker, Message msg)
public void trace(Marker marker, Message msg, Throwable t)
public void trace(Marker marker, Object message, Throwable t)
TRACE
level including the stack trace of the Throwable
t
passed as parameter.
See debug(String)
form for more detailed information.
public void trace(Marker marker, String message, Object... params)
TRACE
level.trace
in interface Logger
marker
- the marker data specific to this log statement.message
- the message to log.params
- parameters to the message.Logger.getMessageFactory()
public void trace(Marker marker, String message, Throwable t)
TRACE
level including the stack trace of the Throwable
t
passed as parameter.
See debug(String)
form for more detailed information.
public void trace(Message msg)
public void trace(Message msg, Throwable t)
public void trace(Object message, Throwable t)
TRACE
level including the stack trace of the Throwable
t
passed as parameter.
See debug(String)
form for more detailed information.
public void trace(String message, Object... params)
TRACE
level.trace
in interface Logger
message
- the message to log.params
- parameters to the message.Logger.getMessageFactory()
public void trace(String message, Throwable t)
TRACE
level including the stack trace of the Throwable
t
passed as parameter.
See debug(String)
form for more detailed information.
public void warn(Marker marker, Message msg)
public void warn(Marker marker, Message msg, Throwable t)
public void warn(Marker marker, String message, Object... params)
WARN
level.warn
in interface Logger
marker
- the marker data specific to this log statement.message
- the message to log.params
- parameters to the message.Logger.getMessageFactory()
public void warn(Message msg)
public void warn(Message msg, Throwable t)
public void warn(String message, Object... params)
WARN
level.warn
in interface Logger
message
- the message to log.params
- parameters to the message.Logger.getMessageFactory()
Copyright © 1999-2014 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.