Package io.github.ai4ci.util

Class ThreadSafeBuffer<X>

java.lang.Object

io.github.ai4ci.util.ThreadSafeBuffer<X>

Type Parameters:

X - the buffer type

All Implemented Interfaces:

Serializable, Iterable<X>, Collection<X>, BlockingQueue<X>, Queue<X>

public class ThreadSafeBuffer<X>
extends Object
implements Serializable, BlockingQueue<X>

A circular buffer that can be written to by many threads and read from primarily by one thread. Will block putting thread if the buffer is full.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
ThreadSafeBuffer(Class<X> type, int size)

Method Summary

Modifier and Type	Method	Description
boolean	add(X e)
boolean	addAll(Collection<? extends X> c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
int	drainTo(Collection<? super X> c)
int	drainTo(Collection<? super X> c, int maxElements)
X	element()
boolean	isEmpty()
Iterator<X>	iterator()
X	next()
boolean	offer(X e)
boolean	offer(X e, long timeout, TimeUnit unit)
X	peek()
X	poll()
X	poll(long timeout, TimeUnit unit)
void	put(X value)
int	remainingCapacity()
X	remove()
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()
X	take()
X[]	toArray()
<T> T[]	toArray(T[] a)

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream, toArray

Methods inherited from interface java.lang.Iterable

forEach

Constructor Details

ThreadSafeBuffer

public ThreadSafeBuffer(Class<X> type,
 int size)

Method Details

put

public void put(X value)

Specified by:

put in interface BlockingQueue<X>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<X>

poll

public X poll()

Specified by:

poll in interface Queue<X>

next

public X next()

size

public int size()

Specified by:

size in interface Collection<X>

toArray

public X[] toArray()

Specified by:

toArray in interface Collection<X>

contains

public boolean contains(Object o)

Specified by:

contains in interface BlockingQueue<X>

Specified by:

contains in interface Collection<X>

iterator

public Iterator<X> iterator()

Specified by:

iterator in interface Collection<X>

Specified by:

iterator in interface Iterable<X>

toArray

public <T> T[] toArray(T[] a)

Specified by:

toArray in interface Collection<X>

remove

public boolean remove(Object o)

Specified by:

remove in interface BlockingQueue<X>

Specified by:

remove in interface Collection<X>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<X>

addAll

public boolean addAll(Collection<? extends X> c)

Specified by:

addAll in interface Collection<X>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<X>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<X>

clear

public void clear()

Specified by:

clear in interface Collection<X>

add

public boolean add(X e)

Specified by:

add in interface BlockingQueue<X>

Specified by:

add in interface Collection<X>

Specified by:

add in interface Queue<X>

offer

public boolean offer(X e)

Specified by:

offer in interface BlockingQueue<X>

Specified by:

offer in interface Queue<X>

remove

public X remove()

Specified by:

remove in interface Queue<X>

element

public X element()

Specified by:

element in interface Queue<X>

peek

public X peek()

Specified by:

peek in interface Queue<X>

offer

public boolean offer(X e,
 long timeout,
 TimeUnit unit)
              throws InterruptedException

Specified by:

offer in interface BlockingQueue<X>

Throws:

InterruptedException

take

public X take()
       throws InterruptedException

Specified by:

take in interface BlockingQueue<X>

Throws:

InterruptedException

poll

public X poll(long timeout,
 TimeUnit unit)
       throws InterruptedException

Specified by:

poll in interface BlockingQueue<X>

Throws:

InterruptedException

remainingCapacity

public int remainingCapacity()

Specified by:

remainingCapacity in interface BlockingQueue<X>

drainTo

public int drainTo(Collection<? super X> c)

Specified by:

drainTo in interface BlockingQueue<X>

drainTo

public int drainTo(Collection<? super X> c,
 int maxElements)

Specified by:

drainTo in interface BlockingQueue<X>