Abstract Abstract categorySets a category for the next log message. The respective log method must be called on the returned object (method chaining). The returned object allows to call more parameter specifying methods. If the returned object is withdrawn, the set category information is lost. The category of the new log message defaults to the logger's category.
The category to set for the next log message. If a Category object or a string is provided, it will be used as the actual category of the message. If a string is provided that starts with a period, e.g. '.subcategory', it will be used as a sub category of the parent logger's category. The categories will then be concatenated separated by a perios ('.').
The log message builder object that allows to specify more parameters of the next log message.
Abstract fallSets the next log message to be appended to the fallback appender. The respective log method must be called on the returned object (method chaining). If the returned object is withdrawn, the set fallback information is lost. This disables the evaluation of message filters to the appenders. The log framework does this internally, if errors in custom code or appenders occur.
Optional fallBack: booleanIf true, the next message will be handled by a fallback appender.
The returned object allows to call more parameter specifying methods.
Abstract idSets the id for the next log message. The respective log method must be called on the returned object (method chaining). The returned object allows to call more parameter specifying methods. If the returned object is withdrawn, the set id information is lost.
The id to set for the next log message
The log message builder object that allows to specify more parameters of the next log message.
Information about the actions that are executed by the software. For User feedback.
The actual log message.
Optional parameters: null | objectThe log message parameters. Its keys will replace the '%key%' placeholders in the message string.
Abstract logCreates a new LogMessage by calling the abstract methods in this interface.
The severity of the log message. Possible values are specified by the LogMessage.Severity Enum.
The actual log message.
Optional parameters: null | objectThe log message parameters. Its keys will replace the '%key%' placeholders in the message string.
Abstract onceSets the onceId for the new log message. The respective log method must be called on the returned object (method chaining). If the returned object is withdrawn, the set fallback information is lost. If set, other messages using the same onceid will not be handled.
Optional onceId: string | booleanif set to true, only, the combination of loglevel, id or message text will be used for identifying similar messages
Abstract originSets the origin (current environment) for the next log message. The respective log method must be called on the returned object (method chaining). The returned object allows to call more parameter specifying methods. If the returned object is withdrawn, the set origin information is lost. The origin of the new log message defaults to the logger's origin. If providing an origin that differs from the logger's origin, the strings are concatenated separated by a slash ('/')
The origin to set for the next log message
The log message builder object that allows to specify more parameters of the next log message.
Abstract refSets a ref fragment for the next log message. The respective log method must be called on the returned object (method chaining). The returned object allows to call more parameter specifying methods. If the returned object is withdrawn, the set ref fragment information is lost. The ref fragment of the new log message defaults to the logger's ref fragment. All fragments in the chain of loggers are concatenated separated by a colon (':')
The ref fragment to set for the next log message
The log message builder object that allows to specify more parameters of the next log message.
Warnings about unintended behaviour or usage of the software or possible security and safety risks.
The actual log message.
Optional parameters: null | objectThe log message parameters. Its keys will replace the '%key%' placeholders in the message string.
This abstract class specifies all methods for the creation of log messages.