Package 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:

Unmodifiable

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

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 1686855 2015-06-22 13:00:27Z tn $

See Also:

Serialized Form

Method Summary

Modifier and Type	Method	Description
boolean	add(java.lang.Object object)
boolean	addAll(java.util.Collection<? extends E> coll)
void	clear()
java.util.Iterator<E>	iterator()
boolean	offer(E obj)
E	poll()
E	remove()
boolean	remove(java.lang.Object object)
boolean	removeAll(java.util.Collection<?> coll)
boolean	retainAll(java.util.Collection<?> coll)
static <E> java.util.Queue<E>	unmodifiableQueue(java.util.Queue<? extends E> queue)	Factory method to create an unmodifiable queue.

Methods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator

contains, containsAll, isEmpty, setCollection, size, toArray, toArray, toString

Methods inherited from class org.apache.commons.collections4.queue.AbstractQueueDecorator

decorated, element, peek

Methods inherited from interface java.util.Collection

contains, containsAll, equals, hashCode, isEmpty, parallelStream, removeIf, size, spliterator, stream, toArray, toArray

Methods inherited from interface java.lang.Iterable

forEach

Methods inherited from class java.lang.Object

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

Method Detail

unmodifiableQueue

public static <E> java.util.Queue<E> unmodifiableQueue(java.util.Queue<? extends 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:

java.lang.NullPointerException - if queue is null

iterator

public java.util.Iterator<E> iterator()

Overrides:

iterator in class AbstractCollectionDecorator<E>

add

public boolean add(java.lang.Object object)

Overrides:

add in class AbstractCollectionDecorator<E>

addAll

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

Overrides:

addAll in class AbstractCollectionDecorator<E>

clear

public void clear()

Overrides:

clear in class AbstractCollectionDecorator<E>

remove

public boolean remove(java.lang.Object object)

Overrides:

remove in class AbstractCollectionDecorator<E>

removeAll

public boolean removeAll(java.util.Collection<?> coll)

Overrides:

removeAll in class AbstractCollectionDecorator<E>

retainAll

public boolean retainAll(java.util.Collection<?> coll)

Overrides:

retainAll in class AbstractCollectionDecorator<E>

offer

public boolean offer(E obj)

Overrides:

offer in class AbstractQueueDecorator<E>

poll

public E poll()

Overrides:

poll in class AbstractQueueDecorator<E>

remove

public E remove()

Overrides:

remove in class AbstractQueueDecorator<E>