rsb.util

Class LimitedQueue<ElementType>

java.lang.Object

rsb.util.LimitedQueue<ElementType>

Type Parameters:

ElementType - contained element type

All Implemented Interfaces:

Iterable<ElementType>, Collection<ElementType>, BlockingQueue<ElementType>, Queue<ElementType>

Direct Known Subclasses:

TimeLimitedQueue

public class LimitedQueue<ElementType>
extends Object
implements BlockingQueue<ElementType>

A limited capacity BlockingQueue which overrides add in order to remove the oldest element when the size limit is reached.

Author:

jwienke

Constructor Summary

Constructors

Constructor and Description
LimitedQueue(int capacity) Creates a queue with the specified capacity.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(ElementType e)
boolean	addAll(Collection<? extends ElementType> c)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> c)
int	drainTo(Collection<? super ElementType> c)
int	drainTo(Collection<? super ElementType> c, int maxElements)
ElementType	element()
protected BlockingQueue<ElementType>	getQueue() Returns the underlying queue.
boolean	isEmpty()
Iterator<ElementType>	iterator()
boolean	offer(ElementType e)
boolean	offer(ElementType e, long timeout, TimeUnit unit)
ElementType	peek()
ElementType	poll()
ElementType	poll(long timeout, TimeUnit unit)
void	put(ElementType e)
int	remainingCapacity()
ElementType	remove()
boolean	remove(Object o)
boolean	removeAll(Collection<?> c)
boolean	retainAll(Collection<?> c)
int	size()
ElementType	take()
Object[]	toArray()
<TargetType> TargetType[]	toArray(TargetType[] 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

Constructor Detail

LimitedQueue

public LimitedQueue(int capacity)

Creates a queue with the specified capacity. Oldest elements are removed on add in case the capacity limit is reached.

Parameters:

capacity - capacity of the queue

Method Detail

getQueue

protected BlockingQueue<ElementType> getQueue()

Returns the underlying queue.

Returns:

queue instance

remove

public ElementType remove()

Specified by:

remove in interface Queue<ElementType>

poll

public ElementType poll()

Specified by:

poll in interface Queue<ElementType>

element

public ElementType element()

Specified by:

element in interface Queue<ElementType>

peek

public ElementType peek()

Specified by:

peek in interface Queue<ElementType>

size

public int size()

Specified by:

size in interface Collection<ElementType>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<ElementType>

iterator

public Iterator<ElementType> iterator()

Specified by:

iterator in interface Iterable<ElementType>

Specified by:

iterator in interface Collection<ElementType>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<ElementType>

toArray

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

Specified by:

toArray in interface Collection<ElementType>

containsAll

public boolean containsAll(Collection<?> c)

Specified by:

containsAll in interface Collection<ElementType>

addAll

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

Specified by:

addAll in interface Collection<ElementType>

removeAll

public boolean removeAll(Collection<?> c)

Specified by:

removeAll in interface Collection<ElementType>

retainAll

public boolean retainAll(Collection<?> c)

Specified by:

retainAll in interface Collection<ElementType>

clear

public void clear()

Specified by:

clear in interface Collection<ElementType>

add

public boolean add(ElementType e)

Specified by:

add in interface Collection<ElementType>

Specified by:

add in interface BlockingQueue<ElementType>

Specified by:

add in interface Queue<ElementType>

offer

public boolean offer(ElementType e)

Specified by:

offer in interface BlockingQueue<ElementType>

Specified by:

offer in interface Queue<ElementType>

put

public void put(ElementType e)
         throws InterruptedException

Specified by:

put in interface BlockingQueue<ElementType>

Throws:

InterruptedException

offer

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

Specified by:

offer in interface BlockingQueue<ElementType>

Throws:

InterruptedException

take

public ElementType take()
                 throws InterruptedException

Specified by:

take in interface BlockingQueue<ElementType>

Throws:

InterruptedException

poll

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

Specified by:

poll in interface BlockingQueue<ElementType>

Throws:

InterruptedException

remainingCapacity

public int remainingCapacity()

Specified by:

remainingCapacity in interface BlockingQueue<ElementType>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<ElementType>

Specified by:

remove in interface BlockingQueue<ElementType>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<ElementType>

Specified by:

contains in interface BlockingQueue<ElementType>

drainTo

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

Specified by:

drainTo in interface BlockingQueue<ElementType>

drainTo

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

Specified by:

drainTo in interface BlockingQueue<ElementType>