edu.internet2.middleware.grouper.pspng.lbmq

Class AbstractOfferable<E>

java.lang.Object

java.util.AbstractCollection<E>

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

Type Parameters:

E - the type of elements held in this collection

All Implemented Interfaces:

Offerable<E>, Iterable<E>, Collection<E>

Direct Known Subclasses:

LinkedBlockingMultiQueue.SubQueue

public abstract class AbstractOfferable<E>
extends AbstractCollection<E>
implements Offerable<E>

This class provides skeletal implementations of some Offerable operations. The implementations in this class are appropriate when the base implementation does not allow null elements. Method add is based on offer, but throws exceptions instead of indicating failure via false or null returns.

An Offerable implementation that extends this class must minimally define a method Queue.offer(E) which does not permit insertion of null elements, along with methods Collection.size(), and Collection.iterator(). Typically, additional methods will be overridden as well. If these requirements cannot be met, consider instead subclassing AbstractCollection.

Constructor Summary

Constructors

Constructor and Description
AbstractOfferable()

Method Summary

Modifier and Type	Method and Description
boolean	add(E e) Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions, returning true upon success and throwing an IllegalStateException if no space is currently available.
boolean	addAll(Collection<? extends E> c) Adds all of the elements in the specified collection to this queue.

Methods inherited from class java.util.AbstractCollection

clear, contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString

Methods inherited from class java.lang.Object

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

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

offer, offer, put, remainingCapacity

Methods inherited from interface java.util.Collection

equals, hashCode, parallelStream, removeIf, spliterator, stream

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

AbstractOfferable

public AbstractOfferable()

Method Detail

add

public boolean add(E e)

Description copied from interface: Offerable

Inserts the specified element into this queue if it is possible to do so immediately without violating capacity restrictions, returning true upon success and throwing an IllegalStateException if no space is currently available.

Specified by:

add in interface Offerable<E>

Specified by:

add in interface Collection<E>

Overrides:

add in class AbstractCollection<E>

Parameters:

e - the element to add

Returns:

true (as specified by Collection.add(E))

addAll

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

Adds all of the elements in the specified collection to this queue. Attempts to addAll of a queue to itself result in IllegalArgumentException. Further, the behavior of this operation is undefined if the specified collection is modified while the operation is in progress.

This implementation iterates over the specified collection, and adds each element returned by the iterator to this queue, in turn. A runtime exception encountered while trying to add an element (including, in particular, a null element) may result in only some of the elements having been successfully added when the associated exception is thrown.

Specified by:

addAll in interface Collection<E>

Overrides:

addAll in class AbstractCollection<E>

Parameters:

c - collection containing elements to be added to this queue

Returns:

true if this queue changed as a result of the call

Throws:

ClassCastException - if the class of an element of the specified collection prevents it from being added to this queue

NullPointerException - if the specified collection contains a null element and this queue does not permit null elements, or if the specified collection is null

IllegalArgumentException - if some property of an element of the specified collection prevents it from being added to this queue, or if the specified collection is this queue

IllegalStateException - if not all the elements can be added at this time due to insertion restrictions

See Also:

add(Object)