org.apache.axis2.transport.base.threads.watermark

Class DefaultWaterMarkQueue<T>

java.lang.Object

org.apache.axis2.transport.base.threads.watermark.DefaultWaterMarkQueue<T>

Type Parameters:

T -

All Implemented Interfaces:

Iterable<T>, Collection<T>, BlockingQueue<T>, Queue<T>, WaterMarkQueue<T>

public class DefaultWaterMarkQueue<T>
extends Object
implements WaterMarkQueue<T>

A Default implementation for WaterMarkQueue interface. The implementation uses an ArrayBlockingQueue up to water mark. Then it uses a LinkedBlockingQueue or ArrayBlocking queue from the water mark point. The LinkedBlockingQueue is used if a queue size is specified other than the waterMark.

Constructor Summary

Constructors

Constructor and Description
DefaultWaterMarkQueue(int waterMark) Create a WaterMarkQueue with a waterMark.
DefaultWaterMarkQueue(int waterMark, int size) Create a WaterMarkQueue with a waterMark.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	add(T t)
boolean	addAll(Collection<? extends T> ts)
void	clear()
boolean	contains(Object o)
boolean	containsAll(Collection<?> objects)
int	drainTo(Collection<? super T> objects)
int	drainTo(Collection<? super T> objects, int i)
T	element()
boolean	isEmpty()
Iterator<T>	iterator()
boolean	offer(T t)
boolean	offer(T t, long l, TimeUnit timeUnit)
boolean	offerAfter(T t) Offer the element after the water mark.
T	peek()
T	poll()
T	poll(long l, TimeUnit timeUnit)
void	put(T t)
int	remainingCapacity()
T	remove()
boolean	remove(Object o)
boolean	removeAll(Collection<?> objects)
boolean	retainAll(Collection<?> objects)
int	size()
T	take()
Object[]	toArray()
<T> T[]	toArray(T[] ts)

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

DefaultWaterMarkQueue

public DefaultWaterMarkQueue(int waterMark)

Create a WaterMarkQueue with a waterMark. The queue will first fill up to waterMark. These items will be inserted in to an ArrayBlockingQueue. After this an LinkedBlockingQueue will be used without a bound.

Parameters:

waterMark - the waterMark of the queue

DefaultWaterMarkQueue

public DefaultWaterMarkQueue(int waterMark,
                     int size)

Create a WaterMarkQueue with a waterMark. The queue will first fill up to waterMark. These items will be inserted in to an ArrayBlockingQueue. After this an LinkedBlockingQueue will be used with capacity size - waterMark.

Parameters:

waterMark - the waterMark of the queue

size - the size of the queue

Method Detail

add

public boolean add(T t)

Specified by:

add in interface Collection<T>

Specified by:

add in interface BlockingQueue<T>

Specified by:

add in interface Queue<T>

offer

public boolean offer(T t)

Specified by:

offer in interface BlockingQueue<T>

Specified by:

offer in interface Queue<T>

remove

public T remove()

Specified by:

remove in interface Queue<T>

poll

public T poll()

Specified by:

poll in interface Queue<T>

element

public T element()

Specified by:

element in interface Queue<T>

peek

public T peek()

Specified by:

peek in interface Queue<T>

put

public void put(T t)
         throws InterruptedException

Specified by:

put in interface BlockingQueue<T>

Throws:

InterruptedException

offer

public boolean offer(T t,
            long l,
            TimeUnit timeUnit)
              throws InterruptedException

Specified by:

offer in interface BlockingQueue<T>

Throws:

InterruptedException

take

public T take()
       throws InterruptedException

Specified by:

take in interface BlockingQueue<T>

Throws:

InterruptedException

poll

public T poll(long l,
     TimeUnit timeUnit)
       throws InterruptedException

Specified by:

poll in interface BlockingQueue<T>

Throws:

InterruptedException

remainingCapacity

public int remainingCapacity()

Specified by:

remainingCapacity in interface BlockingQueue<T>

remove

public boolean remove(Object o)

Specified by:

remove in interface Collection<T>

Specified by:

remove in interface BlockingQueue<T>

containsAll

public boolean containsAll(Collection<?> objects)

Specified by:

containsAll in interface Collection<T>

addAll

public boolean addAll(Collection<? extends T> ts)

Specified by:

addAll in interface Collection<T>

removeAll

public boolean removeAll(Collection<?> objects)

Specified by:

removeAll in interface Collection<T>

retainAll

public boolean retainAll(Collection<?> objects)

Specified by:

retainAll in interface Collection<T>

clear

public void clear()

Specified by:

clear in interface Collection<T>

size

public int size()

Specified by:

size in interface Collection<T>

isEmpty

public boolean isEmpty()

Specified by:

isEmpty in interface Collection<T>

contains

public boolean contains(Object o)

Specified by:

contains in interface Collection<T>

Specified by:

contains in interface BlockingQueue<T>

iterator

public Iterator<T> iterator()

Specified by:

iterator in interface Iterable<T>

Specified by:

iterator in interface Collection<T>

toArray

public Object[] toArray()

Specified by:

toArray in interface Collection<T>

toArray

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

Specified by:

toArray in interface Collection<T>

drainTo

public int drainTo(Collection<? super T> objects)

Specified by:

drainTo in interface BlockingQueue<T>

drainTo

public int drainTo(Collection<? super T> objects,
          int i)

Specified by:

drainTo in interface BlockingQueue<T>

offerAfter

public boolean offerAfter(T t)

Description copied from interface: WaterMarkQueue

Offer the element after the water mark.

Specified by:

offerAfter in interface WaterMarkQueue<T>

Parameters:

t - object to be inserted

Returns:

true if the insert is successful