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:
Serializable
,Iterable<E>
,Collection<E>
,Queue<E>
,Unmodifiable
Decorates another
Queue
to ensure it can't be altered.
Attempts to modify it will result in an UnsupportedOperationException.
- Since:
- 4.0
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final long
Serialization version -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
UnmodifiableQueue
(Queue<? extends E> queue) Constructor that wraps (not copies). -
Method Summary
Modifier and TypeMethodDescriptionboolean
boolean
addAll
(Collection<? extends E> coll) void
clear()
iterator()
boolean
poll()
private void
Read the collection in using a custom routine.remove()
boolean
boolean
removeAll
(Collection<?> coll) boolean
boolean
retainAll
(Collection<?> coll) static <E> Queue
<E> unmodifiableQueue
(Queue<? extends E> queue) Factory method to create an unmodifiable queue.private void
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
Methods inherited from interface java.util.Collection
contains, containsAll, equals, hashCode, isEmpty, parallelStream, size, spliterator, stream, toArray, toArray
-
Field Details
-
serialVersionUID
private static final long serialVersionUIDSerialization version- See Also:
-
-
Constructor Details
-
UnmodifiableQueue
Constructor that wraps (not copies).- Parameters:
queue
- the queue to decorate, must not be null- Throws:
NullPointerException
- if queue is null
-
-
Method Details
-
unmodifiableQueue
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:
NullPointerException
- if queue is null
-
writeObject
Write the collection out using a custom routine.- Parameters:
out
- the output stream- Throws:
IOException
- if an I/O error occurs while writing to the output stream
-
readObject
Read the collection in using a custom routine.- Parameters:
in
- the input stream- Throws:
IOException
- if an I/O error occurs while reading from the input streamClassNotFoundException
- if the class of a serialized object can not be found
-
iterator
- Specified by:
iterator
in interfaceCollection<E>
- Specified by:
iterator
in interfaceIterable<E>
- Overrides:
iterator
in classAbstractCollectionDecorator<E>
-
add
- Specified by:
add
in interfaceCollection<E>
- Specified by:
add
in interfaceQueue<E>
- Overrides:
add
in classAbstractCollectionDecorator<E>
-
addAll
- Specified by:
addAll
in interfaceCollection<E>
- Overrides:
addAll
in classAbstractCollectionDecorator<E>
-
clear
public void clear()- Specified by:
clear
in interfaceCollection<E>
- Overrides:
clear
in classAbstractCollectionDecorator<E>
-
remove
- Specified by:
remove
in interfaceCollection<E>
- Overrides:
remove
in classAbstractCollectionDecorator<E>
-
removeIf
- Specified by:
removeIf
in interfaceCollection<E>
- Overrides:
removeIf
in classAbstractCollectionDecorator<E>
- Since:
- 4.4
-
removeAll
- Specified by:
removeAll
in interfaceCollection<E>
- Overrides:
removeAll
in classAbstractCollectionDecorator<E>
-
retainAll
- Specified by:
retainAll
in interfaceCollection<E>
- Overrides:
retainAll
in classAbstractCollectionDecorator<E>
-
offer
-
poll
-
remove
-