class Logger: Any

Logger for operation messages. Building of Loggers is provided by LogManager.

Constructors

<init>

constructor(logger: L4JLogger)

Logger for operation messages. Building of Loggers is provided by LogManager.

Parameters

Name Description
logger: L4JLogger

adapted org.apache.logging.log4j.Logger logger.

Methods

infoOnce

fun infoOnce(message: String)

Log an info message only once. Later log requests are ignored.

Parameters

Name Description
message: String

info message to be logged once

ReturnValue

Name Description
Unit

info

fun info(message: String, prefix: String, suffix: String)

Log one info message with a prefix and suffix.

Parameters

Name Description
message: String
prefix: String
suffix: String

ReturnValue

Name Description
Unit

info

fun info(messages: List<String>, prefix: String, suffix: String)

Log a list of info messages with a prefix and suffix.

Parameters

Name Description
messages: List<String>
prefix: String
suffix: String

ReturnValue

Name Description
Unit

infoParagraph

fun infoParagraph()

Start a new logging paragraph.

ReturnValue

Name Description
Unit

warnOnce

fun warnOnce(message: String)

Log an warning message only once. Later warn requests are ignored.

Parameters

Name Description
message: String

warn message to be logged once

ReturnValue

Name Description
Unit

warn

fun warn(message: String, prefix: String, suffix: String)

Log one warn message with a prefix and suffix.

Parameters

Name Description
message: String
prefix: String
suffix: String

ReturnValue

Name Description
Unit

warn

fun warn(messages: List<String>, prefix: String, suffix: String)

Log a list of warn messages with a prefix and suffix.

Parameters

Name Description
messages: List<String>
prefix: String
suffix: String

ReturnValue

Name Description
Unit

error

fun error(message: String)

Log an error message.

Parameters

Name Description
message: String

ReturnValue

Name Description
Unit

log

fun log(failure: Result.Failure<Exception>, prefix: String, suffix: String)

Log out the exception of a failure.

Parameters

Name Description
failure: Result.Failure<Exception>

failure message to be logged

prefix: String
suffix: String

ReturnValue

Name Description
Unit

log

fun log(exception: Exception, prefix: String, suffix: String)

Log out an exception message as a warning.

Parameters

Name Description
exception: Exception

exception message to be logged

prefix: String
suffix: String

ReturnValue

Name Description
Unit

log

fun log(contextMessage: ContextMessage<Any>, prefix: String, suffix: String)

Log the messages of a ContextMessage.

Parameters

Name Description
contextMessage: ContextMessage<Any>

message to be logged

prefix: String
suffix: String

ReturnValue

Name Description
Unit

log

fun log(result: Result, Exception><ContextMessage<Any>, Exception>, prefix: String, suffix: String)

Log the messages of a ContextMessage within a Result.

Parameters

Name Description
result: Result, Exception><ContextMessage<Any>, Exception>

contains the message to be logged

prefix: String
suffix: String

ReturnValue

Name Description
Unit

toL4JLogger

fun toL4JLogger(): ()

Reveals the adapted logger.

ReturnValue

Name Description
()