edu.internet2.middleware.grouper.pspng.lbmq

Class AbstractPollable<E>

java.lang.Object

edu.internet2.middleware.grouper.pspng.lbmq.AbstractPollable<E>

Type Parameters:

E - the type of elements held in this collection

All Implemented Interfaces:

Pollable<E>

Direct Known Subclasses:

LinkedBlockingMultiQueue

public abstract class AbstractPollable<E>
extends Object
implements Pollable<E>

This class provides skeletal implementations of some Pollable operations. The implementations in this class are appropriate when the base implementation does not allow null elements. Methods remove, and element are based on poll, and peek, respectively, but throw exceptions instead of indicating failure via false or null returns.

A Pollable implementation that extends this class must minimally define methods Queue.peek() and Queue.poll(). Typically, additional methods will be overridden as well.

Constructor Summary

Constructors

Constructor and Description
AbstractPollable()

Method Summary

Modifier and Type	Method and Description
E	element() Retrieves, but does not remove, the head of this queue.
E	remove() Retrieves and removes the head of this queue.

Methods inherited from class java.lang.Object

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

Methods inherited from interface edu.internet2.middleware.grouper.pspng.lbmq.Pollable

drainTo, drainTo, peek, poll, poll, take

Constructor Detail

AbstractPollable

public AbstractPollable()

Method Detail

remove

public E remove()

Retrieves and removes the head of this queue. This method differs from poll only in that it throws an exception if this queue is empty.

This implementation returns the result of poll unless the queue is empty.

Specified by:

remove in interface Pollable<E>

Returns:

the head of this queue

Throws:

NoSuchElementException - if this queue is empty

element

public E element()

Retrieves, but does not remove, the head of this queue. This method differs from peek only in that it throws an exception if this queue is empty.

This implementation returns the result of peek unless the queue is empty.

Specified by:

element in interface Pollable<E>

Returns:

the head of this queue

Throws:

NoSuchElementException - if this queue is empty