org.apache.commons.collections4.queue
Class UnmodifiableQueue<E>

java.lang.Object
  org.apache.commons.collections4.collection.AbstractCollectionDecorator<E>
      org.apache.commons.collections4.queue.AbstractQueueDecorator<E>
          org.apache.commons.collections4.queue.UnmodifiableQueue<E>

All Implemented Interfaces:

Serializable, Iterable<E>, Collection<E>, Queue<E>, Unmodifiable

public final class UnmodifiableQueue<E>
extends AbstractQueueDecorator<E>
implements Unmodifiable, Serializable

Decorates another Queue to ensure it can't be altered.

Attempts to modify it will result in an UnsupportedOperationException.

Since:

4.0

Version:

$Id: UnmodifiableQueue.java 1494280 2013-06-18 20:07:04Z tn $

See Also:

Serialized Form

unmodifiableQueue

public static <E> Queue<E> unmodifiableQueue(Queue<E> queue)

Factory method to create an unmodifiable queue.

If the queue passed in is already unmodifiable, it is returned.

Type Parameters:

E - the type of the elements in the queue

Parameters:

queue - the queue to decorate, must not be null

Returns:

an unmodifiable Queue

Throws:

IllegalArgumentException - if queue is null

iterator

public Iterator<E> iterator()

Specified by:

iterator in interface Iterable<E>

Specified by:

iterator in interface Collection<E>

Overrides:

iterator in class AbstractCollectionDecorator<E>

add

public boolean add(Object object)

Specified by:

add in interface Collection<E>

Overrides:

add in class AbstractCollectionDecorator<E>

addAll

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

Specified by:

addAll in interface Collection<E>

Overrides:

addAll in class AbstractCollectionDecorator<E>

clear

public void clear()

Specified by:

clear in interface Collection<E>

Overrides:

clear in class AbstractCollectionDecorator<E>

remove

public boolean remove(Object object)

Specified by:

remove in interface Collection<E>

Overrides:

remove in class AbstractCollectionDecorator<E>

removeAll

public boolean removeAll(Collection<?> coll)

Specified by:

removeAll in interface Collection<E>

Overrides:

removeAll in class AbstractCollectionDecorator<E>

retainAll

public boolean retainAll(Collection<?> coll)

Specified by:

retainAll in interface Collection<E>

Overrides:

retainAll in class AbstractCollectionDecorator<E>

offer

public boolean offer(E obj)

Specified by:

offer in interface Queue<E>

Overrides:

offer in class AbstractQueueDecorator<E>

poll

public E poll()

Specified by:

poll in interface Queue<E>

Overrides:

poll in class AbstractQueueDecorator<E>

remove

public E remove()

Specified by:

remove in interface Queue<E>

Overrides:

remove in class AbstractQueueDecorator<E>