io.funtom.util.concurrent

Class ConcurrentBuffer<T>

java.lang.Object

io.funtom.util.concurrent.ConcurrentBuffer<T>

Type Parameters:

T - The type of the elements in the Buffer

public final class ConcurrentBuffer<T>
extends Object

A concurrent buffer which supports additions of single elements or collections of elements, and also supports removals of all the elements or up to 'n' elements. Addition operations are non-blocking. Adding a collection of elements is not guaranteed to be atomic. Removal operations are always synchronized and performed in an atomic batch. Thread may be suspended if a batch is currently removed from the buffer. The elements being remove from the buffer returned FIFO ordered. A thread that removes elements from the buffer is guaranteed to see the most updated values in the Buffer at the time the removal began. Subsequent additions during the removals may be returned but are not guaranteed to be returned.

Constructor Summary

Constructors

Constructor and Description
ConcurrentBuffer()

Method Summary

Modifier and Type	Method and Description
void	add(T e) Add single element to the buffer
void	addAll(Collection<T> elements) Add collection of elements to the buffer.
List<T>	getAndRemove(int maxElementsToRemove) Same as getAndRemoveAll() but only up to maxElementsToRemove elements will be returned.
List<T>	getAndRemoveAll() Get an remove all the current elements in the buffer.

Methods inherited from class java.lang.Object

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

Constructor Detail

ConcurrentBuffer

public ConcurrentBuffer()

Method Detail

add

public void add(T e)

Add single element to the buffer

Parameters:

e - An element to be added to the buffer.

addAll

public void addAll(Collection<T> elements)

Add collection of elements to the buffer. The operation is not guaranteed to be atomic.

Parameters:

elements - A collection of elements to be added to the buffer.

getAndRemoveAll

public List<T> getAndRemoveAll()

Get an remove all the current elements in the buffer. Calling thread may be suspended since only one thread can remove from the buffer at a time.

Returns:

A list contains all the element in the buffer at the time the removal began. Elements that where added to the buffer during the the removal may be returned but it is not guaranteed

getAndRemove

public List<T> getAndRemove(int maxElementsToRemove)

Same as getAndRemoveAll() but only up to maxElementsToRemove elements will be returned.

Parameters:

maxElementsToRemove - - The maximum number elements to be returned from the buffer in the batch. If maxElementsToRemove = 0 returns an empty list.

Returns:

A list contains up to maxElementsToRemove elements, which where in the buffer at the time the removal began. If they where maxElementsToRemove elements in the buffer at the time the removal began they are guaranteed to be returned. Elements that where added to the buffer during the the removal may be returned but that is not guaranteed.

Throws:

IllegalArgumentException - - If maxElementsToRemove is negative.