Module io.github.mmm.scanner

Package io.github.mmm.scanner

Class SimpleTextFormatMessageHandler

java.lang.Object

io.github.mmm.scanner.SimpleTextFormatMessageHandler

All Implemented Interfaces:

TextFormatMessageHandler

public class SimpleTextFormatMessageHandler
extends Object
implements TextFormatMessageHandler

Default implementation of TextFormatMessageHandler.

Field Summary

Fields

Modifier and Type	Field	Description
static final Function<TextFormatMessageType,org.slf4j.event.Level>	LOG_MAPPER_DEFAULT	Maps each TextFormatMessageType to its analog Level.
static final Function<TextFormatMessageType,org.slf4j.event.Level>	LOG_MAPPER_INFO_AS_DEBUG	Like LOG_MAPPER_DEFAULT but maps info messages to log-level debug.

Constructor Summary

Constructors

Constructor	Description
SimpleTextFormatMessageHandler(boolean throwOnError, org.slf4j.Logger logger, Function<TextFormatMessageType,org.slf4j.event.Level> logLevelMapper, boolean collectMessages)	The constructor.

Method Summary

Modifier and Type	Method	Description
static SimpleTextFormatMessageHandler	get()
TextFormatMessage	handle(TextFormatMessage message)
boolean	isCollectMessages()
static SimpleTextFormatMessageHandler	ofThrowErrors()
static SimpleTextFormatMessageHandler	ofThrowErrorsNoLogging()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

LOG_MAPPER_DEFAULT

public static final Function<TextFormatMessageType,org.slf4j.event.Level> LOG_MAPPER_DEFAULT

Maps each TextFormatMessageType to its analog Level.

LOG_MAPPER_INFO_AS_DEBUG

public static final Function<TextFormatMessageType,org.slf4j.event.Level> LOG_MAPPER_INFO_AS_DEBUG

Like LOG_MAPPER_DEFAULT but maps info messages to log-level debug.

Constructor Details

SimpleTextFormatMessageHandler

public SimpleTextFormatMessageHandler(boolean throwOnError,
 org.slf4j.Logger logger,
 Function<TextFormatMessageType,org.slf4j.event.Level> logLevelMapper,
 boolean collectMessages)

The constructor.

Parameters:

throwOnError - - true to throw a RuntimeException when an error message is handled.

logger - the Logger used to log TextFormatMessages. May be null to omit logging.

logLevelMapper - the Function to map TextFormatMessageType to the according log Level.

collectMessages - the flag for isCollectMessages().

Method Details

handle

public TextFormatMessage handle(TextFormatMessage message)

Specified by:

handle in interface TextFormatMessageHandler

isCollectMessages

public boolean isCollectMessages()

Returns:

true to collect messages (default) or null if no TextFormatMessage should be collected and TextFormatProcessor.getMessages() will always return the empty list.

get

public static SimpleTextFormatMessageHandler get()

Returns:

the singleton instance.

ofThrowErrors

public static SimpleTextFormatMessageHandler ofThrowErrors()

Returns:

a SimpleTextFormatMessageHandler that throws an exception in case of a error message and collects and logs other messages.

ofThrowErrorsNoLogging

public static SimpleTextFormatMessageHandler ofThrowErrorsNoLogging()

Returns:

a SimpleTextFormatMessageHandler that throws an exception in case of a error message and collects other messages without any logging.