- java.lang.Object
-
- java.util.AbstractCollection<E>
-
- java.util.AbstractQueue<E>
-
- Type Parameters:
E
- the type of elements held in this collection
- All Implemented Interfaces:
- Iterable<E>, Collection<E>, Queue<E>
- Direct Known Subclasses:
- ArrayBlockingQueue, ConcurrentLinkedQueue, DelayQueue, LinkedBlockingDeque, LinkedBlockingQueue, LinkedTransferQueue, PriorityBlockingQueue, PriorityQueue, SynchronousQueue
public abstract class AbstractQueue<E> extends AbstractCollection<E> implements Queue<E>
This class provides skeletal implementations of someQueue
operations. The implementations in this class are appropriate when the base implementation does not allow null elements. Methodsadd
,remove
, andelement
are based onoffer
,poll
, andpeek
, respectively, but throw exceptions instead of indicating failure via false or null returns.A Queue implementation that extends this class must minimally define a method
Queue.offer(E)
which does not permit insertion of null elements, along with methodsQueue.peek()
,Queue.poll()
,Collection.size()
, andCollection.iterator()
. Typically, additional methods will be overridden as well. If these requirements cannot be met, consider instead subclassingAbstractCollection
.This class is a member of the Java Collections Framework.
- Since:
- 1.5
-
-
Constructor Summary
Constructors Modifier Constructor and Description protected
AbstractQueue()
Constructor for use by subclasses.
-
Method Summary
Methods 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.void
clear()
Removes all of the elements from this queue.E
element()
Retrieves, but does not remove, the head of this queue.E
remove()
Retrieves and removes the head of this queue.-
Methods inherited from class java.util.AbstractCollection
contains, containsAll, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString
-
-
-
-
Method Detail
-
add
public 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.This implementation returns true if offer succeeds, else throws an IllegalStateException.
- Specified by:
add
in interfaceCollection<E>
- Specified by:
add
in interfaceQueue<E>
- Overrides:
add
in classAbstractCollection<E>
- Parameters:
e
- the element to add- Returns:
- true (as specified by
Collection.add(E)
) - Throws:
IllegalStateException
- if the element cannot be added at this time due to capacity restrictionsClassCastException
- if the class of the specified element prevents it from being added to this queueNullPointerException
- if the specified element is null and this queue does not permit null elementsIllegalArgumentException
- if some property of this element prevents it from being added to this queue
-
remove
public E remove()
Retrieves and removes the head of this queue. This method differs frompoll
only in that it throws an exception if this queue is empty.This implementation returns the result of poll unless the queue is empty.
- Specified by:
remove
in interfaceQueue<E>
- Returns:
- the head of this queue
- Throws:
NoSuchElementException
- if this queue is empty
-
element
public E element()
Retrieves, but does not remove, the head of this queue. This method differs frompeek
only in that it throws an exception if this queue is empty.This implementation returns the result of peek unless the queue is empty.
- Specified by:
element
in interfaceQueue<E>
- Returns:
- the head of this queue
- Throws:
NoSuchElementException
- if this queue is empty
-
clear
public void clear()
Removes all of the elements from this queue. The queue will be empty after this call returns.This implementation repeatedly invokes
poll
until it returns null.- Specified by:
clear
in interfaceCollection<E>
- Overrides:
clear
in classAbstractCollection<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 interfaceCollection<E>
- Overrides:
addAll
in classAbstractCollection<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 queueNullPointerException
- if the specified collection contains a null element and this queue does not permit null elements, or if the specified collection is nullIllegalArgumentException
- 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 queueIllegalStateException
- if not all the elements can be added at this time due to insertion restrictions- See Also:
add(Object)
-
-
Traduction non disponible
Les API Java ne sont pas encore traduites en français sur l'infobrol. Seule la version anglaise est disponible pour l'instant.
Version en cache
17/11/2024 17:47:45 Cette version de la page est en cache (à la date du 17/11/2024 17:47:45) afin d'accélérer le traitement. Vous pouvez activer le mode utilisateur dans le menu en haut pour afficher la dernère version de la page.Document créé le 29/08/2006, dernière modification le 04/03/2020
Source du document imprimé : https://www.gaudry.be/java-api-rf-java/util/abstractqueue.html
L'infobrol est un site personnel dont le contenu n'engage que moi. Le texte est mis à disposition sous licence CreativeCommons(BY-NC-SA). Plus d'info sur les conditions d'utilisation et sur l'auteur.
Références
Ces références et liens indiquent des documents consultés lors de la rédaction de cette page, ou qui peuvent apporter un complément d'information, mais les auteurs de ces sources ne peuvent être tenus responsables du contenu de cette page.
L'auteur de ce site est seul responsable de la manière dont sont présentés ici les différents concepts, et des libertés qui sont prises avec les ouvrages de référence. N'oubliez pas que vous devez croiser les informations de sources multiples afin de diminuer les risques d'erreurs.