de.vandermeer.skb.base.managers

Class MessageMgrBuilder

Object

MessageMgrBuilder

public class MessageMgrBuilder
extends Object

Builds a MessageMgr object with all settings.

Since:

v0.0.13

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 IsErrorSetFT	buildErrors Errors of the builder.
protected boolean	doCollectMessages Flag to define the behavior for message collection.
protected Map<E_MessageType,MessageTypeHandler>	messageHandlers Maps of message handlers for message types.

Constructor Summary

Constructors

Constructor and Description
MessageMgrBuilder(Object appID) Creates a new builder with given application identifier (name).

Method Summary

Modifier and Type	Method and Description
MessageMgr	build() Builds a MessageMgr.
MessageMgrBuilder	enableMessageCollection() Enables collection of messages for the manager.
IsErrorSetFT	getBuildErrors() Returns errors the builder collected.
MessageMgrBuilder	setHandler(E_MessageType type) Activate a message type and sets a type handler with max count set to 100.
MessageMgrBuilder	setHandler(E_MessageType type, int maxCount) Activate a message type and sets a type handler with max count.
MessageMgrBuilder	setHandler(E_MessageType type, int maxCount, Logger logger) Activate a message type and sets a type handler with max count using specific logger.
MessageMgrBuilder	setHandler(E_MessageType type, Logger logger) Activate a message type and sets a type handler with max count set to 100 using specific logger.

Methods inherited from class Object

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

Field Detail

buildErrors

protected final IsErrorSetFT buildErrors

Errors of the builder.

messageHandlers

protected final Map<E_MessageType,MessageTypeHandler> messageHandlers

Maps of message handlers for message types.

doCollectMessages

protected boolean doCollectMessages

Flag to define the behavior for message collection.

appID

protected final Object appID

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

Constructor Detail

MessageMgrBuilder

public MessageMgrBuilder(Object appID)

Creates a new builder with given application identifier (name).

Parameters:

appID - identifier (or name) of the application using the manager

Throws:

IllegalArgumentException - if application identifier was null or its toString() is blank

Method Detail

getBuildErrors

public IsErrorSetFT getBuildErrors()

Returns errors the builder collected.

Returns:

builder's errors

setHandler

public MessageMgrBuilder setHandler(E_MessageType type)

Activate a message type and sets a type handler with max count set to 100. An existing handler will be overwritten.

Parameters:

type - message type to be activated, nothing will be set if null

Returns:

self to allow for chaining

setHandler

public MessageMgrBuilder setHandler(E_MessageType type,
                                    int maxCount)

Activate a message type and sets a type handler with max count. An existing handler will be overwritten.

Parameters:

type - message type to be activated, nothing will be set if null

maxCount - max count for the handler, -1 to ignore or greater than 0 to be used

Returns:

self to allow for chaining

setHandler

public MessageMgrBuilder setHandler(E_MessageType type,
                                    Logger logger)

Activate a message type and sets a type handler with max count set to 100 using specific logger. An existing handler will be overwritten.

Parameters:

type - message type to be activated, nothing will be set if null

logger - the logger to be used for the handler, if null the message will be added to the local list

Returns:

self to allow for chaining

setHandler

public MessageMgrBuilder setHandler(E_MessageType type,
                                    int maxCount,
                                    Logger logger)

Activate a message type and sets a type handler with max count using specific logger. An existing handler will be overwritten.

Parameters:

type - message type to be activated, nothing will be set if null

maxCount - max count for the handler, -1 to ignore or greater than 0 to be used

logger - the logger to be used for the handler, if null the message will be added to the local list

Returns:

self to allow for chaining

enableMessageCollection

public MessageMgrBuilder enableMessageCollection()

Enables collection of messages for the manager.

Returns:

self to allow for chaining

build

public MessageMgr build()

Builds a MessageMgr.

Returns:

an new manager if all required parameters are set, null if not with errors being logged