pl.chilldev.commons.concurrent.collections.MessageBag Maven / Gradle / Ivy

Go to download
/**
 * This file is part of the ChillDev-Commons.
 *
 * @license http://mit-license.org/ The MIT license
 * @copyright 2014 - 2015 © by Rafał Wrzeszcz - Wrzasq.pl.
 */

package pl.chilldev.commons.concurrent.collections;

import java.io.Serializable;

import java.util.ArrayList;
import java.util.Date;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * Grupped 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.
 * 
 */
public class MessageBag
    implements
        Serializable
{
    /**
     * Serializable class ID.
     */
    private static final long serialVersionUID = 1L;

    /**
     * Internal message abstraction.
     */
    public static class Message
        implements
            Serializable
    {
        /**
         * Serializable class ID.
         */
        private static final long serialVersionUID = 1L;

        /**
         * Message content.
         */
        protected String content;

        /**
         * Creation date.
         */
        protected Date createdAt = new Date();

        /**
         * Initializes message.
         *
         * @param content Message content.
         */
        public Message(String content)
        {
            this.content = content;
        }

        /**
         * Returns message content.
         *
         * @return Message content.
         */
        public String getContent()
        {
            return this.content;
        }

        /**
         * Returns message creation date.
         *
         * @return Message creation date.
         */
        public Date getCreatedAt()
        {
            return (Date) this.createdAt.clone();
        }
    }

    /**
     * Internal messages storage.
     *
     * 
     * No need to use synchronized class as all external calls are synchronized by MessageBag class.
     * 
     */
    protected Map> messages = new HashMap<>();

    /**
     * Adds message to container.
     *
     * @param type Message type.
     * @param message Message content.
     */
    public synchronized void addMessage(String type, String message)
    {
        this.ensureExists(type);

        this.messages.get(type).add(new MessageBag.Message(message));
    }

    /**
     * Checks if container has any messages.
     *
     * @return Whether there are any messages in the container.
     */
    public synchronized boolean hasMessages()
    {
        for (List list : this.messages.values()) {
            if (!list.isEmpty()) {
                return true;
            }
        }

        return false;
    }

    /**
     * Checks if container has messages of given type.
     *
     * @param type Messages type.
     * @return Whether there are any messages of given type in the container.
     */
    public synchronized boolean hasMessages(String type)
    {
        this.ensureExists(type);

        return !this.messages.get(type).isEmpty();
    }

    /**
     * Returns all messages of given type and clears container for that type.
     *
     * @param type Messages type.
     * @return All messages of given type. Always returns the lest, at least empty.
     */
    public synchronized List getMessages(String type)
    {
        this.ensureExists(type);

        // move all the messages to new list and clear internal container
        List messages = new ArrayList(this.messages.get(type));
        this.messages.get(type).clear();

        return messages;
    }

    /**
     * Returns all messages and clears the container.
     *
     * @return All messages groupped by type. Always returns the map, at least empty.
     */
    public synchronized Map> getAllMessages()
    {
        Map> messages = new HashMap<>();

        for (Map.Entry> entry : this.messages.entrySet()) {
            // move all the messages to new list and clear internal container
            List list = new ArrayList<>(entry.getValue());
            entry.getValue().clear();

            // place sub-container in full map
            messages.put(entry.getKey(), list);
        }

        return messages;
    }

    /**
     * Ensures that given sub-list exists.
     *
     * @param type Message type.
     */
    protected void ensureExists(String type)
    {
        if (!this.messages.containsKey(type)) {
            this.messages.put(type, new ArrayList());
        }
    }
}