de.vandermeer.skb.base.managers

Class MessageMgr

Object

MessageMgr

All Implemented Interfaces:

CategoryHas, HasToStringStyle

public class MessageMgr
extends Object
implements HasToStringStyle

Manages Info, Warning and Error messages supporting Message5WH, IsInfoSet, IsWarningSet, IsErrorSet, and DoesRender objects as well as arrays and collections of them.

Since:

v0.0.6 (was in skb-commons before)

Version:

v0.2.0 build 170404 (04-Apr-17) for Java 1.8

Author:

Sven van der Meer <vdmeer.sven@mykolab.com>

Field Summary

Fields

Modifier and Type	Field and Description
protected Object	appID The identifier (or name) of the application using the message manager.
protected boolean	doCollectMessages Flag to define the behavior for message collection.
protected STGroup	max100stg STGroup for max100 messages.
protected Map<E_MessageType,MessageTypeHandler>	messageHandlers Maps of message handlers for message types.
protected LinkedHashMap<String,E_MessageType>	messages Map of collected messages (errors, warnings, information) as rendered strings.
protected MessageRenderer	renderer Message renderer.

Method Summary

Modifier and Type	Method and Description
MessageMgr	clear() Resets the collected messages and all counters.
static Message5WH	createErrorMessage(String what, Object... obj) Creates a new error message.
static Message5WH	createInfoMessage(String what, Object... obj) Creates a new information message.
static Message5WH	createWarningMessage(String what, Object... obj) Creates a new warning message.
Collection<String>	getMessageCollection() Returns the collected messages.
int	getMessageCount(E_MessageType type) Returns the current count for the given message type since its last initialization or reset.
Map<String,E_MessageType>	getMessageMap() Returns the collected messages.
boolean	hasErrors() Returns true if the manager has errors reported, false otherwise
boolean	hasInfos() Returns true if the manager has infos reported, false otherwise
boolean	hasWarnings() Returns true if the manager has warnings reported, false otherwise
boolean	isEnabledFor(E_MessageType type) Returns is the report level is enabled or not.
static Map<String,Set<String>>	loadChunks() Returns a map set with all expected template names and their expected arguments.
protected boolean	report(IsMessageSet messageSet) Reports a message.
protected boolean	report(Message5WH message) Reports a message.
boolean	report(Object obj) Reports a message.
protected boolean	reportKnownClasses(Object message) Reports a message trying all known classes (message formats).
MessageMgr	setRenderer(MessageRenderer renderer) Sets an renderer for the object, which then will be used to render all messages.
String	toString()

Methods inherited from class Object

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

Methods inherited from interface HasToStringStyle

getStyle, getStyle

Field Detail

messages

protected final LinkedHashMap<String,E_MessageType> messages

Map of collected messages (errors, warnings, information) as rendered strings.

messageHandlers

protected final Map<E_MessageType,MessageTypeHandler> messageHandlers

Maps of message handlers for message types.

doCollectMessages

protected final boolean doCollectMessages

Flag to define the behavior for message collection.

renderer

protected MessageRenderer renderer

Message renderer.

max100stg

protected final STGroup max100stg

STGroup for max100 messages.

appID

protected final Object appID

The identifier (or name) of the application using the message manager.

Method Detail

loadChunks

public static final Map<String,Set<String>> loadChunks()

Returns a map set with all expected template names and their expected arguments. The map that maintains the expected templates and their arguments for the manager. Any STGroup handed over the the manager will be tested against this map. Templates or template arguments that are missing can be reported, and the report manager will not invoke in any report activity if the provided STGroup does not provide for all required chunks. The set templates and their arguments are:

• max ::= name, number, type

Returns:

template map

createInfoMessage

public static Message5WH createInfoMessage(String what,
                                           Object... obj)

Creates a new information message.

Parameters:

what - the what part of the message (what has happened)

obj - objects to add to the message

Returns:

new information message

createWarningMessage

public static Message5WH createWarningMessage(String what,
                                              Object... obj)

Creates a new warning message.

Parameters:

what - the what part of the message (what has happened)

obj - objects to add to the message

Returns:

new information message

createErrorMessage

public static Message5WH createErrorMessage(String what,
                                            Object... obj)

Creates a new error message.

Parameters:

what - the what part of the message (what has happened)

obj - objects to add to the message

Returns:

new information message

setRenderer

public MessageMgr setRenderer(MessageRenderer renderer)

Sets an renderer for the object, which then will be used to render all messages.

Parameters:

renderer - new renderer

Returns:

self to allow chaining

getMessageCollection

public Collection<String> getMessageCollection()

Returns the collected messages.

Returns:

empty if collection is disabled, a list of collected reports otherwise

getMessageMap

public Map<String,E_MessageType> getMessageMap()

Returns the collected messages.

Returns:

empty if collection is disabled, a list of collected reports otherwise

hasErrors

public boolean hasErrors()

Returns true if the manager has errors reported, false otherwise

Returns:

true if errors have been reported, false otherwise

hasWarnings

public boolean hasWarnings()

Returns true if the manager has warnings reported, false otherwise

Returns:

true if warnings have been reported, false otherwise

hasInfos

public boolean hasInfos()

Returns true if the manager has infos reported, false otherwise

Returns:

true if infos have been reported, false otherwise

getMessageCount

public int getMessageCount(E_MessageType type)

Returns the current count for the given message type since its last initialization or reset.

Parameters:

type - message type to report count for

Returns:

current count of messages, -1 if not in active list

isEnabledFor

public boolean isEnabledFor(E_MessageType type)

Returns is the report level is enabled or not.

Parameters:

type - message type to check

Returns:

true if the message type is in the list of active message types of the manager and if the associated logger is enabled, false otherwise

report

protected boolean report(Message5WH message)

Reports a message.

Parameters:

message - to be reported

Returns:

true if the message was reported, false otherwise

report

protected boolean report(IsMessageSet messageSet)

Reports a message.

Parameters:

messageSet - message to be reported

Returns:

true if the message was reported, false otherwise

reportKnownClasses

protected boolean reportKnownClasses(Object message)

Reports a message trying all known classes (message formats).

Parameters:

message - message to be reported

Returns:

true if the message was reported, false otherwise

report

public boolean report(Object obj)

Reports a message. This methods understands the message formats Message5WH, IsMessageSet, HasErrorSet, HasWarningSet, and HasInfoSet. It also does process iterators, iterables, and arrays of any type to process the message formats mentioned above. All objects not understood will be silently ignored.

Parameters:

obj - message object or object containing messages for reporting

Returns:

true if one or all message have been reported, false otherwise

clear

public MessageMgr clear()

Resets the collected messages and all counters.

Returns:

returns self to allow for chained calls

toString

public String toString()

Overrides:

toString in class Object