pl.chilldev.commons.concurrent.collections

Class MessageBag

java.lang.Object

pl.chilldev.commons.concurrent.collections.MessageBag

All Implemented Interfaces:

Serializable

public class MessageBag
extends Object
implements Serializable

Grouped messages container.

All operations done on objects of this class are synchronized.

Note that after any cleanup types keys are left in the container, just with empty messages lists.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MessageBag.Message Internal message abstraction.

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,List<MessageBag.Message>>	messages Internal messages storage.

Constructor Summary

Constructors

Constructor and Description
MessageBag()

Method Summary

Modifier and Type	Method and Description
void	addMessage(String type, String message) Adds message to container.
protected List<MessageBag.Message>	ensureExists(String type) Ensures that given sub-list exists.
Map<String,List<MessageBag.Message>>	getAllMessages() Returns all messages and clears the container.
List<MessageBag.Message>	getMessages(String type) Returns all messages of given type and clears container for that type.
boolean	hasMessages() Checks if container has any messages.
boolean	hasMessages(String type) Checks if container has messages of given type.

Methods inherited from class java.lang.Object

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

Field Detail

messages

protected Map<String,List<MessageBag.Message>> messages

Internal messages storage.

No need to use synchronized class as all external calls are synchronized by MessageBag class.

Constructor Detail

MessageBag

public MessageBag()

Method Detail

addMessage

public void addMessage(String type,
                       String message)

Adds message to container.

Parameters:

type - Message type.

message - Message content.

hasMessages

public boolean hasMessages()

Checks if container has any messages.

Returns:

Whether there are any messages in the container.

hasMessages

public boolean hasMessages(String type)

Checks if container has messages of given type.

Parameters:

type - Messages type.

Returns:

Whether there are any messages of given type in the container.

getMessages

public List<MessageBag.Message> getMessages(String type)

Returns all messages of given type and clears container for that type.

Parameters:

type - Messages type.

Returns:

All messages of given type. Always returns the lest, at least empty.

getAllMessages

public Map<String,List<MessageBag.Message>> getAllMessages()

Returns all messages and clears the container.

Returns:

All messages grouped by type. Always returns the map, at least empty.

ensureExists

protected List<MessageBag.Message> ensureExists(String type)

Ensures that given sub-list exists.

Parameters:

type - Message type.

Returns:

Messages list for given type.