Module io.github.mmm.base

Package io.github.mmm.base.text

Class AbstractTextFormatMessageHandler

java.lang.Object

io.github.mmm.base.text.AbstractTextFormatMessageHandler

All Implemented Interfaces:

TextFormatMessageHandler

public abstract class AbstractTextFormatMessageHandler
extends Object
implements TextFormatMessageHandler

Default implementation of TextFormatMessageHandler.

Constructor Summary

Constructors

Constructor	Description
AbstractTextFormatMessageHandler(boolean throwOnError, boolean collectMessages)	The constructor.

Method Summary

Modifier and Type	Method	Description
void	add(TextFormatMessage message)
List<TextFormatMessage>	getMessages()
TextFormatMessage	handle(TextFormatMessage message)	Method to allow custom handling or even transformation of TextFormatMessages.
boolean	isCollectMessages()

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractTextFormatMessageHandler

public AbstractTextFormatMessageHandler(boolean throwOnError,
 boolean collectMessages)

The constructor.

Parameters:

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

collectMessages - the flag for isCollectMessages().

Method Details

add

public void add(TextFormatMessage message)

Specified by:

add in interface TextFormatMessageHandler

Parameters:

message - the TextFormatMessage to add.

handle

public TextFormatMessage handle(TextFormatMessage message)

Method to allow custom handling or even transformation of TextFormatMessages. Does nothing by default and may be overridden e.g. to log messages and throw a RuntimeException in case of an error.

Parameters:

message - the TextFormatMessage to handle.

Returns:

the given TextFormatMessage or potentially a transformation.

Throws:

RuntimeException - in case the TextFormatMessage should immediately lead to an exception aborting any further processing. By default TextFormatMessages should be collected in TextFormatProcessor.getMessages() in order to allow maximum fault-tolerance.

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.

getMessages

public List<TextFormatMessage> getMessages()

Specified by:

getMessages in interface TextFormatMessageHandler

Returns:

the List of TextFormatMessages.