LogDecorator
, LoggerAccessor<LogPriority>
, LoggerAccessor.LoggerMutator<LogPriority>
, LoggerAccessor.LoggerProperty<Logger<Object>>
, LogPriorityAccessor
, LogPriorityAccessor.LogPriorityMutator
, LogPriorityAccessor.LogPriorityProperty
, MessageLogger<LogPriority>
, RuntimeLogger
, org.refcodes.mixin.NameAccessor
, org.refcodes.mixin.NameAccessor.NameMutator
, org.refcodes.mixin.NameAccessor.NameProperty
public class RuntimeLoggerImpl extends Object implements RuntimeLogger, LoggerAccessor.LoggerProperty<Logger<Object>>, org.refcodes.mixin.NameAccessor.NameProperty, LogPriorityAccessor.LogPriorityProperty
RuntimeLogger
interface to be
configured with a (back-end) Logger
. In case no (back-end)
Logger
has been set via setLogger(Logger)
then the plain
SystemLogger
will be used as fallback.LoggerAccessor.LoggerMutator<L extends Logger<?>>, LoggerAccessor.LoggerProperty<L extends Logger<?>>
LogPriorityAccessor.LogPriorityMutator, LogPriorityAccessor.LogPriorityProperty
Modifier and Type | Field | Description |
---|---|---|
static LogPriority |
DEFAULT_LOG_PRIORITY |
|
static String |
ROOT_LOGGER_NAME |
ROOT_LOGGER_ELEMENT_PATH, RUNTIME_LOGGER_CONFIG
Constructor | Description |
---|---|
RuntimeLoggerImpl() |
Constructs a
RuntimeLogger logging with the given Logger
and the desired LogPriority for the messages being logged and
upwards (from the given LogPriority.getPriority() and higher). |
RuntimeLoggerImpl(String aName,
Logger<Object> aLogger) |
Constructs a
RuntimeLogger logging with the given Logger
and the desired LogPriority for the messages being logged and
upwards (from the given LogPriority.getPriority() and higher). |
RuntimeLoggerImpl(String aName,
Logger<Object> aLogger,
LogPriority aPriority) |
Constructs a
RuntimeLogger logging with the given Logger
and the desired LogPriority for the messages being logged and
upwards (from the given LogPriority.getPriority() and higher). |
RuntimeLoggerImpl(Logger<Object> aLogger) |
Constructs a
RuntimeLogger logging with the given Logger
and the desired LogPriority for the messages being logged and
upwards (from the given LogPriority.getPriority() and higher). |
RuntimeLoggerImpl(Logger<Object> aLogger,
LogPriority aPriority) |
Constructs a
RuntimeLogger logging with the given Logger
and the desired LogPriority for the messages being logged and
upwards (from the given LogPriority.getPriority() and higher). |
Modifier and Type | Method | Description |
---|---|---|
void |
alert(String aMessage) |
Logs a log message with log priority
LogPriority.ALERT . |
void |
alert(String aMessage,
Object... aArguments) |
Logs a log message with log priority
LogPriority.ALERT . |
void |
alert(String aMessage,
Throwable aThrowable) |
Logs a log message with log priority
LogPriority.ALERT . |
void |
alert(String aMessage,
Throwable aThrowable,
Object... aArguments) |
Logs a log message with log priority
LogPriority.ALERT . |
void |
critical(String aMessage) |
Logs a log message with log priority
LogPriority.CRITICAL . |
void |
critical(String aMessage,
Object... aArguments) |
Logs a log message with log priority
LogPriority.CRITICAL . |
void |
critical(String aMessage,
Throwable aThrowable) |
Logs a log message with log priority
LogPriority.CRITICAL . |
void |
critical(String aMessage,
Throwable aThrowable,
Object... aArguments) |
Logs a log message with log priority
LogPriority.CRITICAL . |
void |
debug(String aMessage) |
Logs a log message with log priority
LogPriority.DEBUG . |
void |
debug(String aMessage,
Object... aArguments) |
Logs a log message with log priority
LogPriority.DEBUG . |
protected void |
doLog(LogPriority aPriority,
String aMessage,
StackTraceElement aStackTraceElement,
Throwable aThrowable) |
Helper method to log the required information.
|
void |
error(String aMessage) |
Logs a log message with log priority
LogPriority.ERROR . |
void |
error(String aMessage,
Object... aArguments) |
Logs a log message with log priority
LogPriority.ERROR . |
void |
error(String aMessage,
Throwable aThrowable) |
Logs a log message with log priority
LogPriority.ERROR . |
void |
error(String aMessage,
Throwable aThrowable,
Object... aArguments) |
Logs a log message with log priority
LogPriority.ERROR . |
static StackTraceElement |
getCallerStackTraceElement() |
Returns the stack trace element belonging to the caller of the caller of
this method.
|
Logger<Object> |
getLogger() |
Retrieves the logger from the logger property.
|
LogPriority |
getLogPriority() |
Retrieves the
LogPriority from the LogPriorityAccessor . |
String |
getName() |
|
void |
info(String aMessage) |
Logs a log message with log priority
LogPriority.INFO . |
void |
info(String aMessage,
Object... aArguments) |
Logs a log message with log priority
LogPriority.INFO . |
boolean |
isLog(LogPriority aPriority) |
Determines whether the
RuntimeLogger is being configured to log
messages of the according LogPriority . |
boolean |
isLogAlert() |
Determines whether the
RuntimeLogger is being configured to log
fatal messages (LogPriority.ALERT ). |
boolean |
isLogCritical() |
Determines whether the
RuntimeLogger is being configured to log
fatal messages (LogPriority.CRITICAL ). |
boolean |
isLogDebug() |
Determines whether the
RuntimeLogger is being configured to log
debug messages (LogPriority.DEBUG ). |
boolean |
isLogError() |
Determines whether the
RuntimeLogger is being configured to log
errors (LogPriority.ERROR ). |
boolean |
isLogInfo() |
Determines whether the
RuntimeLogger is being configured to log
infos (LogPriority.INFO ). |
boolean |
isLogNotice() |
Determines whether the
RuntimeLogger is being configured to log
notices (LogPriority.NOTICE ). |
boolean |
isLogPanic() |
Determines whether the
RuntimeLogger is being configured to log
fatal messages (LogPriority.PANIC ). |
boolean |
isLogTrace() |
Determines whether the
RuntimeLogger is being configured to log
comments (LogPriority.TRACE ). |
boolean |
isLogWarn() |
Determines whether the
RuntimeLogger is being configured to log
warnings (LogPriority.WARN ). |
void |
log(LogPriority aPriority,
String aMessage) |
Creates a new log message.
|
void |
log(LogPriority aPriority,
String aMessage,
Object... aArguments) |
Creates a new log message.
|
void |
log(LogPriority aPriority,
String aMessage,
Throwable aThrowable) |
Creates a new log message.
|
void |
log(LogPriority aPriority,
String aMessage,
Throwable aThrowable,
Object... aArguments) |
Creates a new log message.
|
void |
notice(String aMessage) |
Logs a log message with log priority
LogPriority.NOTICE . |
void |
notice(String aMessage,
Object... aArguments) |
Logs a log message with log priority
LogPriority.NOTICE . |
void |
panic(String aMessage) |
Logs a log message with log priority
LogPriority.PANIC . |
void |
panic(String aMessage,
Object... aArguments) |
Logs a log message with log priority
LogPriority.PANIC . |
void |
panic(String aMessage,
Throwable aThrowable) |
Logs a log message with log priority
LogPriority.PANIC . |
void |
panic(String aMessage,
Throwable aThrowable,
Object... aArguments) |
Logs a log message with log priority
LogPriority.PANIC . |
void |
printHead() |
Prints the logger's head in case it hasn't been printed before or
LogDecorator.printTail() has been called. |
void |
printSeparator() |
Prints a separator line in case the underlying
Logger supports
the such. |
void |
printTail() |
Prints the logger's tail in case it hasn't been printed before or
LogDecorator.printHead() has been called. |
void |
setLogger(Logger<Object> aLogger) |
Sets the logger for the logger property.
|
void |
setLogLevel(String aLogLevel) |
Similar to
setLogPriority(LogPriority) with the difference, that
a String is passed instead of a LogPriority element. |
void |
setLogPriority(LogPriority aLogPriority) |
Sets the
LogPriority for the LogPriorityAccessor . |
void |
setName(String aName) |
Propagate the name where possible to the underlying logger.
|
void |
trace(String aMessage) |
Logs a log message with log priority
LogPriority.TRACE . |
void |
trace(String aMessage,
Object... aArguments) |
Logs a log message with log priority
LogPriority.TRACE . |
void |
warn(String aMessage) |
Logs a log message with log priority
LogPriority.WARN . |
void |
warn(String aMessage,
Object... aArguments) |
Logs a log message with log priority
LogPriority.WARN . |
void |
warn(String aMessage,
Throwable aThrowable) |
Logs a log message with log priority
LogPriority.WARN . |
void |
warn(String aMessage,
Throwable aThrowable,
Object... aArguments) |
Logs a log message with log priority
LogPriority.WARN . |
letLogger
letLogPriority
public static final String ROOT_LOGGER_NAME
public static final LogPriority DEFAULT_LOG_PRIORITY
public RuntimeLoggerImpl(String aName, Logger<Object> aLogger, LogPriority aPriority)
RuntimeLogger
logging with the given Logger
and the desired LogPriority
for the messages being logged and
upwards (from the given LogPriority.getPriority()
and higher).aName
- the nameaLogger
- The logger used for logging the runtime logs.aPriority
- The LogPriority
specifying which log messages
are to be logged. Any log message with a LogPriority
as
the given one or higher (regarding the
LogPriority.getPriority()
value) is being logged.public RuntimeLoggerImpl(String aName, Logger<Object> aLogger)
RuntimeLogger
logging with the given Logger
and the desired LogPriority
for the messages being logged and
upwards (from the given LogPriority.getPriority()
and higher).aName
- the nameaLogger
- The logger used for logging the runtime logs.public RuntimeLoggerImpl(Logger<Object> aLogger, LogPriority aPriority)
RuntimeLogger
logging with the given Logger
and the desired LogPriority
for the messages being logged and
upwards (from the given LogPriority.getPriority()
and higher).aLogger
- The logger used for logging the runtime logs.aPriority
- The LogPriority
specifying which log messages
are to be logged. Any log message with a LogPriority
as
the given one or higher (regarding the
LogPriority.getPriority()
value) is being logged.public RuntimeLoggerImpl(Logger<Object> aLogger)
RuntimeLogger
logging with the given Logger
and the desired LogPriority
for the messages being logged and
upwards (from the given LogPriority.getPriority()
and higher).aLogger
- The logger used for logging the runtime logs.public RuntimeLoggerImpl()
RuntimeLogger
logging with the given Logger
and the desired LogPriority
for the messages being logged and
upwards (from the given LogPriority.getPriority()
and higher).public void log(LogPriority aPriority, String aMessage)
log
in interface MessageLogger<LogPriority>
aPriority
- The marker for the message.aMessage
- The message to be logged.public void log(LogPriority aPriority, String aMessage, Throwable aThrowable)
log
in interface RuntimeLogger
aPriority
- The level of the message.aMessage
- The message to be logged.aThrowable
- An exception that the message should contain.public boolean isLog(LogPriority aPriority)
RuntimeLogger
is being configured to log
messages of the according LogPriority
. This method is useful to
prevent the generation of vast amounts of log message String
objects (and according processing) for the according LogPriority
in case them messages of that LogPriority
are not logged at all.isLog
in interface RuntimeLogger
aPriority
- The LogPriority
to test whether the
RuntimeLogger
does log messages of that
LogPriority
.RuntimeLogger
does log messages of that
LogPriority
.public LogPriority getLogPriority()
LogPriority
from the LogPriorityAccessor
.getLogPriority
in interface LogPriorityAccessor
LogPriority
stored by the LogPriorityAccessor
.public void trace(String aMessage)
LogPriority.TRACE
.trace
in interface RuntimeLogger
aMessage
- The message to be logged.public boolean isLogTrace()
RuntimeLogger
is being configured to log
comments (LogPriority.TRACE
). This method is useful to prevent
the generation of vast amounts of log message String
objects (and
according processing) for the according LogPriority
in case them
messages of that LogPriority
are not logged at all.isLogTrace
in interface RuntimeLogger
public void debug(String aMessage)
LogPriority.DEBUG
. "Info
useful to developers for debugging the application, not useful during
operations." See also http://en.wikipedia.org/wiki/Syslogdebug
in interface RuntimeLogger
aMessage
- The message to be logged.public boolean isLogDebug()
RuntimeLogger
is being configured to log
debug messages (LogPriority.DEBUG
). This method is useful to
prevent the generation of vast amounts of log message String
objects (and according processing) for the according LogPriority
in case them messages of that LogPriority
are not logged at all.isLogDebug
in interface RuntimeLogger
public void info(String aMessage)
LogPriority.INFO
.
"Additional information which might be useful for some stability period."
See also http://en.wikipedia.org/wiki/Sysloginfo
in interface RuntimeLogger
aMessage
- The message to be logged.public boolean isLogInfo()
RuntimeLogger
is being configured to log
infos (LogPriority.INFO
). This method is useful to prevent the
generation of vast amounts of log message String
objects (and
according processing) for the according LogPriority
in case them
messages of that LogPriority
are not logged at all.isLogInfo
in interface RuntimeLogger
public void notice(String aMessage)
LogPriority.NOTICE
. "Events
that are unusual but not error conditions - might be summarized in an
email to developers or admins to spot potential problems - no immediate
action required." See also http://en.wikipedia.org/wiki/Syslognotice
in interface RuntimeLogger
aMessage
- The message to be logged.public boolean isLogNotice()
RuntimeLogger
is being configured to log
notices (LogPriority.NOTICE
). This method is useful to prevent
the generation of vast amounts of log message String
objects (and
according processing) for the according LogPriority
in case them
messages of that LogPriority
are not logged at all.isLogNotice
in interface RuntimeLogger
public void warn(String aMessage)
LogPriority.WARN
. "Warning
messages, not an error, but indication that an error will occur if action
is not taken, e.g. file system 85% full - each item must be resolved
within a given time." See also http://en.wikipedia.org/wiki/Syslogwarn
in interface RuntimeLogger
aMessage
- The message to be logged.public void warn(String aMessage, Throwable aThrowable)
LogPriority.WARN
. "Warning
messages, not an error, but indication that an error will occur if action
is not taken, e.g. file system 85% full - each item must be resolved
within a given time." See also http://en.wikipedia.org/wiki/Syslogwarn
in interface RuntimeLogger
aMessage
- The message to be logged.aThrowable
- An exception that the message should contain.public boolean isLogWarn()
RuntimeLogger
is being configured to log
warnings (LogPriority.WARN
). This method is useful to prevent the
generation of vast amounts of log message String
objects (and
according processing) for the according LogPriority
in case them
messages of that LogPriority
are not logged at all.isLogWarn
in interface RuntimeLogger
public void error(String aMessage)
LogPriority.ERROR
.
"Non-urgent failures, these should be relayed to developers or admins;
each item must be resolved within a given time." See also
http://en.wikipedia.org/wiki/Syslogerror
in interface RuntimeLogger
aMessage
- The message to be logged.public void error(String aMessage, Throwable aThrowable)
LogPriority.ERROR
.
"Non-urgent failures, these should be relayed to developers or admins;
each item must be resolved within a given time." See also
http://en.wikipedia.org/wiki/Syslogerror
in interface RuntimeLogger
aMessage
- The message to be logged.aThrowable
- An exception that the message should contain.public boolean isLogError()
RuntimeLogger
is being configured to log
errors (LogPriority.ERROR
). This method is useful to prevent the
generation of vast amounts of log message String
objects (and
according processing) for the according LogPriority
in case them
messages of that LogPriority
are not logged at all.isLogError
in interface RuntimeLogger
public void critical(String aMessage)
LogPriority.CRITICAL
.
"Should be corrected immediately, but indicates failure in a secondary
system, an example is a loss of a backup ISP connection." See also
http://en.wikipedia.org/wiki/Syslogcritical
in interface RuntimeLogger
aMessage
- The message to be logged.public void critical(String aMessage, Throwable aThrowable)
LogPriority.CRITICAL
.
"Should be corrected immediately, but indicates failure in a secondary
system, an example is a loss of a backup ISP connection." See also
http://en.wikipedia.org/wiki/Syslogcritical
in interface RuntimeLogger
aMessage
- The message to be logged.aThrowable
- An exception that the message should contain.public boolean isLogCritical()
RuntimeLogger
is being configured to log
fatal messages (LogPriority.CRITICAL
). This method is useful to
prevent the generation of vast amounts of log message String
objects (and according processing) for the according LogPriority
in case them messages of that LogPriority
are not logged at all.isLogCritical
in interface RuntimeLogger
public void alert(String aMessage)
LogPriority.ALERT
. "Should
be corrected immediately, therefore notify staff who can fix the problem.
An example would be the loss of a primary ISP connection." See also
http://en.wikipedia.org/wiki/Syslogalert
in interface RuntimeLogger
aMessage
- The message to be logged.public void alert(String aMessage, Throwable aThrowable)
LogPriority.ALERT
.alert
in interface RuntimeLogger
aMessage
- The message to be logged.aThrowable
- An exception that the message should contain.public boolean isLogAlert()
RuntimeLogger
is being configured to log
fatal messages (LogPriority.ALERT
). This method is useful to
prevent the generation of vast amounts of log message String
objects (and according processing) for the according LogPriority
in case them messages of that LogPriority
are not logged at all.isLogAlert
in interface RuntimeLogger
public void panic(String aMessage)
LogPriority.PANIC
. "A
"panic" condition usually affecting multiple apps/servers/sites. At this
level it would usually notify all tech staff on call." ( See also
http://en.wikipedia.org/wiki/Syslogpanic
in interface RuntimeLogger
aMessage
- The message to be logged.public void panic(String aMessage, Throwable aThrowable)
LogPriority.PANIC
. "A
"panic" condition usually affecting multiple apps/servers/sites. At this
level it would usually notify all tech staff on call." ( See also
http://en.wikipedia.org/wiki/Syslogpanic
in interface RuntimeLogger
aMessage
- The message to be logged.aThrowable
- An exception that the message should contain.public boolean isLogPanic()
RuntimeLogger
is being configured to log
fatal messages (LogPriority.PANIC
). This method is useful to
prevent the generation of vast amounts of log message String
objects (and according processing) for the according LogPriority
in case them messages of that LogPriority
are not logged at all.isLogPanic
in interface RuntimeLogger
public void log(LogPriority aPriority, String aMessage, Object... aArguments)
String
are being replaced by the provided arguments. Implementations of this
interface are recommended to use Java's MessageFormat
's syntax,
the placeholder being replaced by the first argument is identified by
"{0}" (without the quotes), the second one by "{1}", the third one by
"{3}" and so on: Given the message to be "{0} + {1} = {2}" and the three
argument be x, y and x + y, then "{0}" is replaced by the value of x,
"{1}" is replaced by the value of y and "{2}" is replaced by the value of
x + y.log
in interface MessageLogger<LogPriority>
aPriority
- The marker for the message.aMessage
- The message to be logged.aArguments
- The arguments used when replacing the placeholders.public void log(LogPriority aPriority, String aMessage, Throwable aThrowable, Object... aArguments)
String
are being replaced by the provided arguments. Implementations of this
interface are recommended to use Java's MessageFormat
's syntax,
the placeholder being replaced by the first argument is identified by
"{0}" (without the quotes), the second one by "{1}", the third one by
"{3}" and so on: Given the message to be "{0} + {1} = {2}" and the three
argument be x, y and x + y, then "{0}" is replaced by the value of x,
"{1}" is replaced by the value of y and "{2}" is replaced by the value of
x + y.log
in interface RuntimeLogger
aPriority
- The level of the message.aMessage
- The message to be logged.aThrowable
- An exception that the message should contain.aArguments
- The arguments used when replacing the placeholders.public void trace(String aMessage, Object... aArguments)
LogPriority.TRACE
. The
placeholders in the message String
are being replaced by the
provided arguments. Implementations of this interface are recommended to
use Java's MessageFormat
's syntax, the placeholder being replaced
by the first argument is identified by "{0}" (without the quotes), the
second one by "{1}", the third one by "{3}" and so on: Given the message
to be "{0} + {1} = {2}" and the three argument be x, y and x + y, then
"{0}" is replaced by the value of x, "{1}" is replaced by the value of y
and "{2}" is replaced by the value of x + y.trace
in interface RuntimeLogger
aMessage
- The message to be logged.aArguments
- The arguments used when replacing the placeholders.public void debug(String aMessage, Object... aArguments)
LogPriority.DEBUG
. "Info
useful to developers for debugging the application, not useful during
operations." The placeholders in the message String
are being
replaced by the provided arguments. Implementations of this interface are
recommended to use Java's MessageFormat
's syntax, the placeholder
being replaced by the first argument is identified by "{0}" (without the
quotes), the second one by "{1}", the third one by "{3}" and so on: Given
the message to be "{0} + {1} = {2}" and the three argument be x, y and x
+ y, then "{0}" is replaced by the value of x, "{1}" is replaced by the
value of y and "{2}" is replaced by the value of x + y. See also
http://en.wikipedia.org/wiki/Syslogdebug
in interface RuntimeLogger
aMessage
- The message to be logged.aArguments
- The arguments used when replacing the placeholders.public void info(String aMessage, Object... aArguments)
LogPriority.INFO
.
"Additional information which might be useful for some stability period."
The placeholders in the message String
are being replaced by the
provided arguments. Implementations of this interface are recommended to
use Java's MessageFormat
's syntax, the placeholder being replaced
by the first argument is identified by "{0}" (without the quotes), the
second one by "{1}", the third one by "{3}" and so on: Given the message
to be "{0} + {1} = {2}" and the three argument be x, y and x + y, then
"{0}" is replaced by the value of x, "{1}" is replaced by the value of y
and "{2}" is replaced by the value of x + y. See also
http://en.wikipedia.org/wiki/Sysloginfo
in interface RuntimeLogger
aMessage
- The message to be logged.aArguments
- The arguments used when replacing the placeholders.public void notice(String aMessage, Object... aArguments)
LogPriority.NOTICE
. "Events
that are unusual but not error conditions - might be summarized in an
email to developers or admins to spot potential problems - no immediate
action required." The placeholders in the message String
are
being replaced by the provided arguments. Implementations of this
interface are recommended to use Java's MessageFormat
's syntax,
the placeholder being replaced by the first argument is identified by
"{0}" (without the quotes), the second one by "{1}", the third one by
"{3}" and so on: Given the message to be "{0} + {1} = {2}" and the three
argument be x, y and x + y, then "{0}" is replaced by the value of x,
"{1}" is replaced by the value of y and "{2}" is replaced by the value of
x + y. See also http://en.wikipedia.org/wiki/Syslognotice
in interface RuntimeLogger
aMessage
- The message to be logged.aArguments
- The arguments used when replacing the placeholders.public void warn(String aMessage, Object... aArguments)
LogPriority.WARN
. "Warning
messages, not an error, but indication that an error will occur if action
is not taken, e.g. file system 85% full - each item must be resolved
within a given time." The placeholders in the message String
are
being replaced by the provided arguments. Implementations of this
interface are recommended to use Java's MessageFormat
's syntax,
the placeholder being replaced by the first argument is identified by
"{0}" (without the quotes), the second one by "{1}", the third one by
"{3}" and so on: Given the message to be "{0} + {1} = {2}" and the three
argument be x, y and x + y, then "{0}" is replaced by the value of x,
"{1}" is replaced by the value of y and "{2}" is replaced by the value of
x + y. See also http://en.wikipedia.org/wiki/Syslogwarn
in interface RuntimeLogger
aMessage
- The message to be logged.aArguments
- The arguments used when replacing the placeholders.public void warn(String aMessage, Throwable aThrowable, Object... aArguments)
LogPriority.WARN
. "Warning
messages, not an error, but indication that an error will occur if action
is not taken, e.g. file system 85% full - each item must be resolved
within a given time." The placeholders in the message String
are
being replaced by the provided arguments. Implementations of this
interface are recommended to use Java's MessageFormat
's syntax,
the placeholder being replaced by the first argument is identified by
"{0}" (without the quotes), the second one by "{1}", the third one by
"{3}" and so on: Given the message to be "{0} + {1} = {2}" and the three
argument be x, y and x + y, then "{0}" is replaced by the value of x,
"{1}" is replaced by the value of y and "{2}" is replaced by the value of
x + y. See also http://en.wikipedia.org/wiki/Syslogwarn
in interface RuntimeLogger
aMessage
- The message to be logged.aThrowable
- An exception that the message should contain.aArguments
- The arguments used when replacing the placeholders.public void error(String aMessage, Object... aArguments)
LogPriority.ERROR
.
"Non-urgent failures, these should be relayed to developers or admins;
each item must be resolved within a given time." The placeholders in the
message String
are being replaced by the provided arguments.
Implementations of this interface are recommended to use Java's
MessageFormat
's syntax, the placeholder being replaced by the
first argument is identified by "{0}" (without the quotes), the second
one by "{1}", the third one by "{3}" and so on: Given the message to be
"{0} + {1} = {2}" and the three argument be x, y and x + y, then "{0}" is
replaced by the value of x, "{1}" is replaced by the value of y and "{2}"
is replaced by the value of x + y. See also
http://en.wikipedia.org/wiki/Syslogerror
in interface RuntimeLogger
aMessage
- The message to be logged.aArguments
- The arguments used when replacing the placeholders.public void error(String aMessage, Throwable aThrowable, Object... aArguments)
LogPriority.ERROR
.
"Non-urgent failures, these should be relayed to developers or admins;
each item must be resolved within a given time." The placeholders in the
message String
are being replaced by the provided arguments.
Implementations of this interface are recommended to use Java's
MessageFormat
's syntax, the placeholder being replaced by the
first argument is identified by "{0}" (without the quotes), the second
one by "{1}", the third one by "{3}" and so on: Given the message to be
"{0} + {1} = {2}" and the three argument be x, y and x + y, then "{0}" is
replaced by the value of x, "{1}" is replaced by the value of y and "{2}"
is replaced by the value of x + y. See also
http://en.wikipedia.org/wiki/Syslogerror
in interface RuntimeLogger
aMessage
- The message to be logged.aThrowable
- An exception that the message should contain.aArguments
- The arguments used when replacing the placeholders.public void critical(String aMessage, Object... aArguments)
LogPriority.CRITICAL
.
"Should be corrected immediately, but indicates failure in a secondary
system, an example is a loss of a backup ISP connection." The
placeholders in the message String
are being replaced by the
provided arguments. Implementations of this interface are recommended to
use Java's MessageFormat
's syntax, the placeholder being replaced
by the first argument is identified by "{0}" (without the quotes), the
second one by "{1}", the third one by "{3}" and so on: Given the message
to be "{0} + {1} = {2}" and the three argument be x, y and x + y, then
"{0}" is replaced by the value of x, "{1}" is replaced by the value of y
and "{2}" is replaced by the value of x + y. See also
http://en.wikipedia.org/wiki/Syslogcritical
in interface RuntimeLogger
aMessage
- The message to be logged.aArguments
- The arguments used when replacing the placeholders.public void critical(String aMessage, Throwable aThrowable, Object... aArguments)
LogPriority.CRITICAL
.
"Should be corrected immediately, but indicates failure in a secondary
system, an example is a loss of a backup ISP connection." See also
http://en.wikipedia.org/wiki/Syslogcritical
in interface RuntimeLogger
aMessage
- The message to be logged.aThrowable
- An exception that the message should contain.aArguments
- The arguments used when replacing the placeholders.public void alert(String aMessage, Object... aArguments)
LogPriority.ALERT
. "Should
be corrected immediately, therefore notify staff who can fix the problem.
An example would be the loss of a primary ISP connection." The
placeholders in the message String
are being replaced by the
provided arguments. Implementations of this interface are recommended to
use Java's MessageFormat
's syntax, the placeholder being replaced
by the first argument is identified by "{0}" (without the quotes), the
second one by "{1}", the third one by "{3}" and so on: Given the message
to be "{0} + {1} = {2}" and the three argument be x, y and x + y, then
"{0}" is replaced by the value of x, "{1}" is replaced by the value of y
and "{2}" is replaced by the value of x + y. See also
http://en.wikipedia.org/wiki/Syslogalert
in interface RuntimeLogger
aMessage
- The message to be logged.aArguments
- The arguments used when replacing the placeholders.public void alert(String aMessage, Throwable aThrowable, Object... aArguments)
LogPriority.ALERT
.alert
in interface RuntimeLogger
aMessage
- The message to be logged.aThrowable
- An exception that the message should contain.aArguments
- The arguments used when replacing the placeholders.public void panic(String aMessage, Object... aArguments)
LogPriority.PANIC
. "A
"panic" condition usually affecting multiple apps/servers/sites. At this
level it would usually notify all tech staff on call." The placeholders
in the message String
are being replaced by the provided
arguments. Implementations of this interface are recommended to use
Java's MessageFormat
's syntax, the placeholder being replaced by
the first argument is identified by "{0}" (without the quotes), the
second one by "{1}", the third one by "{3}" and so on: Given the message
to be "{0} + {1} = {2}" and the three argument be x, y and x + y, then
"{0}" is replaced by the value of x, "{1}" is replaced by the value of y
and "{2}" is replaced by the value of x + y. See also
http://en.wikipedia.org/wiki/Syslogpanic
in interface RuntimeLogger
aMessage
- The message to be logged.aArguments
- The arguments used when replacing the placeholders.public void panic(String aMessage, Throwable aThrowable, Object... aArguments)
LogPriority.PANIC
. "A
"panic" condition usually affecting multiple apps/servers/sites. At this
level it would usually notify all tech staff on call." The placeholders
in the message String
are being replaced by the provided
arguments. Implementations of this interface are recommended to use
Java's MessageFormat
's syntax, the placeholder being replaced by
the first argument is identified by "{0}" (without the quotes), the
second one by "{1}", the third one by "{3}" and so on: Given the message
to be "{0} + {1} = {2}" and the three argument be x, y and x + y, then
"{0}" is replaced by the value of x, "{1}" is replaced by the value of y
and "{2}" is replaced by the value of x + y. See also
http://en.wikipedia.org/wiki/Syslogpanic
in interface RuntimeLogger
aMessage
- The message to be logged.aThrowable
- An exception that the message should contain.aArguments
- The arguments used when replacing the placeholders.public void setLogger(Logger<Object> aLogger)
setLogger
in interface LoggerAccessor.LoggerMutator<LogPriority>
aLogger
- The logger to be stored by the logger property.public void setLogLevel(String aLogLevel)
setLogPriority(LogPriority)
with the difference, that
a String
is passed instead of a LogPriority
element. The
String
variant is required by the configuration framework as used
by the RuntimeLoggerSingleton
.aLogLevel
- The String
representation of the required
LogPriority
.public void setLogPriority(LogPriority aLogPriority)
LogPriority
for the LogPriorityAccessor
.setLogPriority
in interface LogPriorityAccessor.LogPriorityMutator
aLogPriority
- The LogPriority
to be stored by the
LogPriorityAccessor
.public String getName()
getName
in interface org.refcodes.mixin.NameAccessor
public void setName(String aName)
setName
in interface org.refcodes.mixin.NameAccessor.NameMutator
public void printHead()
LogDecorator.printTail()
has been called. Printing the head might result in
printing out the additional logger's information such as the column
names.printHead
in interface LogDecorator
public void printSeparator()
Logger
supports
the such. A separator line may be printed just as of beautifying purposes
and does not belong to the actual log's data. Therefore this method may
just do nothing, depending on the implementing class.printSeparator
in interface LogDecorator
public void printTail()
LogDecorator.printHead()
has been called. Printing the tail might result in
printing out the additional logger's information or visually finishing
the current log sequence.printTail
in interface LogDecorator
public Logger<Object> getLogger()
getLogger
in interface LoggerAccessor<LogPriority>
protected void doLog(LogPriority aPriority, String aMessage, StackTraceElement aStackTraceElement, Throwable aThrowable)
aPriority
- the priorityaMessage
- The message to be logged.aStackTraceElement
- The stack trace element to be logged.aThrowable
- The Exception
to be logged.public static StackTraceElement getCallerStackTraceElement()
Copyright © 2021. All rights reserved.