org.finra.herd.service.helper.NotificationMessageInMemoryQueue Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of herd-service Show documentation

This project contains the business service code. This is a classic service tier where business logic is defined along with it's associated transaction management configuration.

There is a newer version: 0.160.0

Show newest version

/*
* Copyright 2015 herd contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*     http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.finra.herd.service.helper;

import java.util.LinkedList;
import java.util.Queue;

import org.springframework.stereotype.Component;

import org.finra.herd.model.dto.NotificationMessage;

/**
 * An in-memory notification message queue.
 */
@Component
public class NotificationMessageInMemoryQueue
{
    private static final ThreadLocal> QUEUE = new ThreadLocal>()
    {
        @Override
        protected Queue initialValue()
        {
            return new LinkedList<>();
        }
    };

    /**
     * Adds a notification message to the queue.
     *
     * @param notificationMessage the notification message to be added
     */
    public void add(NotificationMessage notificationMessage)
    {
        QUEUE.get().add(notificationMessage);
    }

    /**
     * Removes all of the elements from the queue.
     */
    public void clear()
    {
        QUEUE.get().clear();
    }

    /**
     * Returns true if the queue contains no elements.
     *
     * @return true if the queue contains no elements
     */
    public boolean isEmpty()
    {
        return QUEUE.get().isEmpty();
    }

    /**
     * Removes a notification message from the head of the queue.
     *
     * @return the notification message removed from the head of the queue
     * @throws java.util.NoSuchElementException if the queue is empty
     */
    public NotificationMessage remove()
    {
        return QUEUE.get().remove();
    }

    /**
     * Returns the number of elements in the queue.
     *
     * @return the number of elements in the queue
     */
    public int size()
    {
        return QUEUE.get().size();
    }
}