RuntimeLoggerImpl (org.refcodes:refcodes-logger 1.2.3 API)

java.lang.Object
- org.refcodes.logger.RuntimeLoggerImpl

All Implemented Interfaces:

LoggerAccessor.LoggerMutator<Logger<Object>>, LogPriorityAccessor, LogPriorityAccessor.LogPriorityMutator, MessageLogger<LogPriority>, RuntimeLogger, org.refcodes.mixin.NameAccessor, org.refcodes.mixin.NameAccessor.NameMutator
```
public class RuntimeLoggerImpl
extends Object
implements RuntimeLogger, LoggerAccessor.LoggerMutator<Logger<Object>>, org.refcodes.mixin.NameAccessor.NameMutator, LogPriorityAccessor.LogPriorityMutator
```
The default implementation of the 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 SystemLoggerImpl will be used as fallback.

Nested Class Summary
- Nested classes/interfaces inherited from interface org.refcodes.logger.LogPriorityAccessor
  LogPriorityAccessor.LogPriorityMutator, LogPriorityAccessor.LogPriorityProperty
- Nested classes/interfaces inherited from interface org.refcodes.mixin.NameAccessor
  org.refcodes.mixin.NameAccessor.NameBuilder<B extends org.refcodes.mixin.NameAccessor.NameBuilder<B>>, org.refcodes.mixin.NameAccessor.NameMutator, org.refcodes.mixin.NameAccessor.NameProperty

Field Summary

Fields
Modifier and Type Field and Description

static LogPriority DEFAULT_LOG_PRIORITY

static String ROOT_LOGGER_NAME
- Fields inherited from interface org.refcodes.logger.RuntimeLogger
  ROOT_LOGGER_ELEMENT_PATH, RUNTIME_LOGGER_CONFIG

Fields
Modifier and Type	Field and Description
`static LogPriority`	`DEFAULT_LOG_PRIORITY`
`static String`	`ROOT_LOGGER_NAME`

Constructor Summary

Constructors
Constructor and 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(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).
`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).

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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.
`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`	`printSeparator()` Prints a separator line in case the underlying `Logger` supports the such.
`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)`
`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`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - ROOT_LOGGER_NAME
```
public static final String ROOT_LOGGER_NAME
```
    See Also:
    
    Constant Field Values
  - DEFAULT_LOG_PRIORITY
```
public static final LogPriority DEFAULT_LOG_PRIORITY
```
- Constructor Detail
  - RuntimeLoggerImpl
```
public 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).
    
    Parameters:
    
    aName - the a name
    
    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.
  - RuntimeLoggerImpl
```
public 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).
    
    Parameters:
    
    aName - the a name
    
    aLogger - The logger used for logging the runtime logs.
  - RuntimeLoggerImpl
```
public 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).
    
    Parameters:
    
    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.
  - RuntimeLoggerImpl
```
public 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).
    
    Parameters:
    
    aLogger - The logger used for logging the runtime logs.
  - RuntimeLoggerImpl
```
public 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).
- Method Detail
  - log
```
public void log(LogPriority aPriority,
                String aMessage)
```
    Creates a new log message.
    
    Specified by:
    
    log in interface MessageLogger<LogPriority>
    
    Parameters:
    
    aPriority - The marker for the message.
    
    aMessage - The message to be logged.
  - log
```
public void log(LogPriority aPriority,
                String aMessage,
                Throwable aThrowable)
```
    Creates a new log message.
    
    Specified by:
    
    log in interface RuntimeLogger
    
    Parameters:
    
    aPriority - The level of the message.
    
    aMessage - The message to be logged.
    
    aThrowable - An exception that the message should contain.
  - isLog
```
public boolean isLog(LogPriority aPriority)
```
    Determines whether the 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.
    
    Specified by:
    
    isLog in interface RuntimeLogger
    
    Parameters:
    
    aPriority - The LogPriority to test whether the RuntimeLogger does log messages of that LogPriority.
    
    Returns:
    
    True in case the RuntimeLogger does log messages of that LogPriority.
  - getLogPriority
```
public LogPriority getLogPriority()
```
    Retrieves the LogPriority from the LogPriorityAccessor.
    
    Specified by:
    
    getLogPriority in interface LogPriorityAccessor
    
    Returns:
    
    The LogPriority stored by the LogPriorityAccessor .
  - trace
```
public void trace(String aMessage)
```
    Logs a log message with log priorityLogPriority.TRACE.
    
    Specified by:
    
    trace in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
  - isLogTrace
```
public boolean isLogTrace()
```
    Determines whether the 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.
    
    Specified by:
    
    isLogTrace in interface RuntimeLogger
    
    Returns:
    
    True in case comments are logged.
  - debug
```
public void debug(String aMessage)
```
    Logs a log message with log priorityLogPriority.DEBUG. "Info useful to developers for debugging the application, not useful during operations." See also http://en.wikipedia.org/wiki/Syslog
    
    Specified by:
    
    debug in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
  - isLogDebug
```
public boolean isLogDebug()
```
    Determines whether the 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.
    
    Specified by:
    
    isLogDebug in interface RuntimeLogger
    
    Returns:
    
    True in case debug messages are logged.
  - info
```
public void info(String aMessage)
```
    Logs a log message with log priorityLogPriority.INFO. "Additional information which might be useful for some stability period." See also http://en.wikipedia.org/wiki/Syslog
    
    Specified by:
    
    info in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
  - isLogInfo
```
public boolean isLogInfo()
```
    Determines whether the 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.
    
    Specified by:
    
    isLogInfo in interface RuntimeLogger
    
    Returns:
    
    True in case infos are logged.
  - notice
```
public void notice(String aMessage)
```
    Logs a log message with log priorityLogPriority.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/Syslog
    
    Specified by:
    
    notice in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
  - isLogNotice
```
public boolean isLogNotice()
```
    Determines whether the 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.
    
    Specified by:
    
    isLogNotice in interface RuntimeLogger
    
    Returns:
    
    True in case infos are logged.
  - warn
```
public void warn(String aMessage)
```
    Logs a log message with log priorityLogPriority.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/Syslog
    
    Specified by:
    
    warn in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
  - warn
```
public void warn(String aMessage,
                 Throwable aThrowable)
```
    Logs a log message with log priorityLogPriority.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/Syslog
    
    Specified by:
    
    warn in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
    
    aThrowable - An exception that the message should contain.
  - isLogWarn
```
public boolean isLogWarn()
```
    Determines whether the 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.
    
    Specified by:
    
    isLogWarn in interface RuntimeLogger
    
    Returns:
    
    True in case warnings are logged.
  - error
```
public void error(String aMessage)
```
    Logs a log message with log priorityLogPriority.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/Syslog
    
    Specified by:
    
    error in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
  - error
```
public void error(String aMessage,
                  Throwable aThrowable)
```
    Logs a log message with log priorityLogPriority.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/Syslog
    
    Specified by:
    
    error in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
    
    aThrowable - An exception that the message should contain.
  - isLogError
```
public boolean isLogError()
```
    Determines whether the 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.
    
    Specified by:
    
    isLogError in interface RuntimeLogger
    
    Returns:
    
    True in case errors are logged.
  - critical
```
public void critical(String aMessage)
```
    Logs a log message with log priorityLogPriority.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/Syslog
    
    Specified by:
    
    critical in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
  - critical
```
public void critical(String aMessage,
                     Throwable aThrowable)
```
    Logs a log message with log priorityLogPriority.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/Syslog
    
    Specified by:
    
    critical in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
    
    aThrowable - An exception that the message should contain.
  - isLogCritical
```
public boolean isLogCritical()
```
    Determines whether the 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.
    
    Specified by:
    
    isLogCritical in interface RuntimeLogger
    
    Returns:
    
    True in case fatal messages are logged.
  - alert
```
public void alert(String aMessage)
```
    Logs a log message with log priorityLogPriority.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/Syslog
    
    Specified by:
    
    alert in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
  - alert
```
public void alert(String aMessage,
                  Throwable aThrowable)
```
    Logs a log message with log priorityLogPriority.ALERT.
    
    Specified by:
    
    alert in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
    
    aThrowable - An exception that the message should contain.
  - isLogAlert
```
public boolean isLogAlert()
```
    Determines whether the 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.
    
    Specified by:
    
    isLogAlert in interface RuntimeLogger
    
    Returns:
    
    True in case fatal messages are logged.
  - panic
```
public void panic(String aMessage)
```
    Logs a log message with log priorityLogPriority.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/Syslog
    
    Specified by:
    
    panic in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
  - panic
```
public void panic(String aMessage,
                  Throwable aThrowable)
```
    Logs a log message with log priorityLogPriority.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/Syslog
    
    Specified by:
    
    panic in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
    
    aThrowable - An exception that the message should contain.
  - isLogPanic
```
public boolean isLogPanic()
```
    Determines whether the 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.
    
    Specified by:
    
    isLogPanic in interface RuntimeLogger
    
    Returns:
    
    True in case fatal messages are logged.
  - log
```
public void log(LogPriority aPriority,
                String aMessage,
                Object... aArguments)
```
    Creates a new log message. 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.
    
    Specified by:
    
    log in interface MessageLogger<LogPriority>
    
    Parameters:
    
    aPriority - The marker for the message.
    
    aMessage - The message to be logged.
    
    aArguments - The arguments used when replacing the placeholders.
  - log
```
public void log(LogPriority aPriority,
                String aMessage,
                Throwable aThrowable,
                Object... aArguments)
```
    Creates a new log message. 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.
    
    Specified by:
    
    log in interface RuntimeLogger
    
    Parameters:
    
    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.
  - trace
```
public void trace(String aMessage,
                  Object... aArguments)
```
    Logs a log message with log priorityLogPriority.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.
    
    Specified by:
    
    trace in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
    
    aArguments - The arguments used when replacing the placeholders.
  - debug
```
public void debug(String aMessage,
                  Object... aArguments)
```
    Logs a log message with log priorityLogPriority.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/Syslog
    
    Specified by:
    
    debug in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
    
    aArguments - The arguments used when replacing the placeholders.
  - info
```
public void info(String aMessage,
                 Object... aArguments)
```
    Logs a log message with log priorityLogPriority.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/Syslog
    
    Specified by:
    
    info in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
    
    aArguments - The arguments used when replacing the placeholders.
  - notice
```
public void notice(String aMessage,
                   Object... aArguments)
```
    Logs a log message with log priorityLogPriority.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/Syslog
    
    Specified by:
    
    notice in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
    
    aArguments - The arguments used when replacing the placeholders.
  - warn
```
public void warn(String aMessage,
                 Object... aArguments)
```
    Logs a log message with log priorityLogPriority.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/Syslog
    
    Specified by:
    
    warn in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
    
    aArguments - The arguments used when replacing the placeholders.
  - warn
```
public void warn(String aMessage,
                 Throwable aThrowable,
                 Object... aArguments)
```
    Logs a log message with log priorityLogPriority.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/Syslog
    
    Specified by:
    
    warn in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
    
    aThrowable - An exception that the message should contain.
    
    aArguments - The arguments used when replacing the placeholders.
  - error
```
public void error(String aMessage,
                  Object... aArguments)
```
    Logs a log message with log priorityLogPriority.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/Syslog
    
    Specified by:
    
    error in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
    
    aArguments - The arguments used when replacing the placeholders.
  - error
```
public void error(String aMessage,
                  Throwable aThrowable,
                  Object... aArguments)
```
    Logs a log message with log priorityLogPriority.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/Syslog
    
    Specified by:
    
    error in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
    
    aThrowable - An exception that the message should contain.
    
    aArguments - The arguments used when replacing the placeholders.
  - critical
```
public void critical(String aMessage,
                     Object... aArguments)
```
    Logs a log message with log priorityLogPriority.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/Syslog
    
    Specified by:
    
    critical in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
    
    aArguments - The arguments used when replacing the placeholders.
  - critical
```
public void critical(String aMessage,
                     Throwable aThrowable,
                     Object... aArguments)
```
    Logs a log message with log priorityLogPriority.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/Syslog
    
    Specified by:
    
    critical in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
    
    aThrowable - An exception that the message should contain.
    
    aArguments - The arguments used when replacing the placeholders.
  - alert
```
public void alert(String aMessage,
                  Object... aArguments)
```
    Logs a log message with log priorityLogPriority.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/Syslog
    
    Specified by:
    
    alert in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
    
    aArguments - The arguments used when replacing the placeholders.
  - alert
```
public void alert(String aMessage,
                  Throwable aThrowable,
                  Object... aArguments)
```
    Logs a log message with log priorityLogPriority.ALERT.
    
    Specified by:
    
    alert in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
    
    aThrowable - An exception that the message should contain.
    
    aArguments - The arguments used when replacing the placeholders.
  - panic
```
public void panic(String aMessage,
                  Object... aArguments)
```
    Logs a log message with log priorityLogPriority.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/Syslog
    
    Specified by:
    
    panic in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
    
    aArguments - The arguments used when replacing the placeholders.
  - panic
```
public void panic(String aMessage,
                  Throwable aThrowable,
                  Object... aArguments)
```
    Logs a log message with log priorityLogPriority.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/Syslog
    
    Specified by:
    
    panic in interface RuntimeLogger
    
    Parameters:
    
    aMessage - The message to be logged.
    
    aThrowable - An exception that the message should contain.
    
    aArguments - The arguments used when replacing the placeholders.
  - setLogger
```
public void setLogger(Logger<Object> aLogger)
```
    Sets the logger for the logger property.
    
    Specified by:
    
    setLogger in interface LoggerAccessor.LoggerMutator<Logger<Object>>
    
    Parameters:
    
    aLogger - The logger to be stored by the logger property.
  - setLogLevel
```
public void setLogLevel(String aLogLevel)
```
    Similar to 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.
    
    Parameters:
    
    aLogLevel - The String representation of the required LogPriority.
  - setLogPriority
```
public void setLogPriority(LogPriority aLogPriority)
```
    Sets the LogPriority for the LogPriorityAccessor.
    
    Specified by:
    
    setLogPriority in interface LogPriorityAccessor.LogPriorityMutator
    
    Parameters:
    
    aLogPriority - The LogPriority to be stored by the LogPriorityAccessor.
  - getName
```
public String getName()
```
    Specified by:
    
    getName in interface org.refcodes.mixin.NameAccessor
  - setName
```
public void setName(String aName)
```
    Specified by:
    
    setName in interface org.refcodes.mixin.NameAccessor.NameMutator
  - printSeparator
```
public void printSeparator()
```
    Prints a separator line in case the underlying 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.
    
    Specified by:
    
    printSeparator in interface RuntimeLogger
  - doLog
```
protected void doLog(LogPriority aPriority,
                     String aMessage,
                     StackTraceElement aStackTraceElement,
                     Throwable aThrowable)
```
    Helper method to log the required information.
    
    Parameters:
    
    aPriority - the a priority
    
    aMessage - The message to be logged.
    
    aStackTraceElement - The stack trace element to be logged.
    
    aThrowable - The Exception to be logged.
  - getCallerStackTraceElement
```
public static StackTraceElement getCallerStackTraceElement()
```
    Returns the stack trace element belonging to the caller of the caller of this method. When you use this method in your code, you get the stack trace element of the method calling your method.
    
    Returns:
    
    The stack element of the caller of the caller of this method.

Class RuntimeLoggerImpl

Nested Class Summary

Nested classes/interfaces inherited from interface org.refcodes.logger.LogPriorityAccessor

Nested classes/interfaces inherited from interface org.refcodes.mixin.NameAccessor

Field Summary

Fields inherited from interface org.refcodes.logger.RuntimeLogger

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

ROOT_LOGGER_NAME

DEFAULT_LOG_PRIORITY

Constructor Detail

RuntimeLoggerImpl

RuntimeLoggerImpl

RuntimeLoggerImpl

RuntimeLoggerImpl

RuntimeLoggerImpl

Method Detail

log

log

isLog

getLogPriority

trace

isLogTrace

debug

isLogDebug

info

isLogInfo

notice

isLogNotice

warn

warn

isLogWarn

error

error

isLogError

critical

critical

isLogCritical

alert

alert

isLogAlert

panic

panic

isLogPanic

log

log

trace

debug

info

notice

warn

warn

error

error

critical

critical

alert

alert

panic

panic

setLogger

setLogLevel

setLogPriority

getName

setName

printSeparator

doLog

getCallerStackTraceElement