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>
-
- Type Parameters:
E
- the type of elements held in this queue
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Iterable<E>
,java.util.Collection<E>
,java.util.Queue<E>
,Unmodifiable
public final class UnmodifiableQueue<E> extends AbstractQueueDecorator<E> implements Unmodifiable
Decorates anotherQueue
to ensure it can't be altered.Attempts to modify it will result in an UnsupportedOperationException.
- Since:
- 4.0
- See Also:
- Serialized Form
-
-
Field Summary
Fields Modifier and Type Field Description private static long
serialVersionUID
Serialization version
-
Constructor Summary
Constructors Modifier Constructor Description private
UnmodifiableQueue(java.util.Queue<? extends E> queue)
Constructor that wraps (not copies).
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods 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()
private void
readObject(java.io.ObjectInputStream in)
Read the collection in using a custom routine.E
remove()
boolean
remove(java.lang.Object object)
boolean
removeAll(java.util.Collection<?> coll)
boolean
removeIf(java.util.function.Predicate<? super E> filter)
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.private void
writeObject(java.io.ObjectOutputStream out)
Write the collection out using a custom routine.-
Methods inherited from class org.apache.commons.collections4.queue.AbstractQueueDecorator
decorated, element, peek
-
Methods inherited from class org.apache.commons.collections4.collection.AbstractCollectionDecorator
contains, containsAll, isEmpty, setCollection, size, toArray, toArray, toString
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
-
-
-
Field Detail
-
serialVersionUID
private static final long serialVersionUID
Serialization version- See Also:
- Constant Field Values
-
-
Constructor Detail
-
UnmodifiableQueue
private UnmodifiableQueue(java.util.Queue<? extends E> queue)
Constructor that wraps (not copies).- Parameters:
queue
- the queue to decorate, must not be null- Throws:
java.lang.NullPointerException
- if queue is null
-
-
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
-
writeObject
private void writeObject(java.io.ObjectOutputStream out) throws java.io.IOException
Write the collection out using a custom routine.- Parameters:
out
- the output stream- Throws:
java.io.IOException
- if an I/O error occurs while writing to the output stream
-
readObject
private void readObject(java.io.ObjectInputStream in) throws java.io.IOException, java.lang.ClassNotFoundException
Read the collection in using a custom routine.- Parameters:
in
- the input stream- Throws:
java.io.IOException
- if an I/O error occurs while reading from the input streamjava.lang.ClassNotFoundException
- if the class of a serialized object can not be found
-
iterator
public java.util.Iterator<E> iterator()
- Specified by:
iterator
in interfacejava.util.Collection<E>
- Specified by:
iterator
in interfacejava.lang.Iterable<E>
- Overrides:
iterator
in classAbstractCollectionDecorator<E>
-
add
public boolean add(java.lang.Object object)
- Specified by:
add
in interfacejava.util.Collection<E>
- Specified by:
add
in interfacejava.util.Queue<E>
- Overrides:
add
in classAbstractCollectionDecorator<E>
-
addAll
public boolean addAll(java.util.Collection<? extends E> coll)
- Specified by:
addAll
in interfacejava.util.Collection<E>
- Overrides:
addAll
in classAbstractCollectionDecorator<E>
-
clear
public void clear()
- Specified by:
clear
in interfacejava.util.Collection<E>
- Overrides:
clear
in classAbstractCollectionDecorator<E>
-
remove
public boolean remove(java.lang.Object object)
- Specified by:
remove
in interfacejava.util.Collection<E>
- Overrides:
remove
in classAbstractCollectionDecorator<E>
-
removeIf
public boolean removeIf(java.util.function.Predicate<? super E> filter)
- Specified by:
removeIf
in interfacejava.util.Collection<E>
- Overrides:
removeIf
in classAbstractCollectionDecorator<E>
- Since:
- 4.4
-
removeAll
public boolean removeAll(java.util.Collection<?> coll)
- Specified by:
removeAll
in interfacejava.util.Collection<E>
- Overrides:
removeAll
in classAbstractCollectionDecorator<E>
-
retainAll
public boolean retainAll(java.util.Collection<?> coll)
- Specified by:
retainAll
in interfacejava.util.Collection<E>
- Overrides:
retainAll
in classAbstractCollectionDecorator<E>
-
offer
public boolean offer(E obj)
- Specified by:
offer
in interfacejava.util.Queue<E>
- Overrides:
offer
in classAbstractQueueDecorator<E>
-
poll
public E poll()
- Specified by:
poll
in interfacejava.util.Queue<E>
- Overrides:
poll
in classAbstractQueueDecorator<E>
-
remove
public E remove()
- Specified by:
remove
in interfacejava.util.Queue<E>
- Overrides:
remove
in classAbstractQueueDecorator<E>
-
-