Package jadex.commons.collection
Interface IBlockingQueue<T>
-
- All Known Implementing Classes:
ArrayBlockingQueue
,BlockingQueue
public interface IBlockingQueue<T>
A queue that blocks until an element is available.
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static class
IBlockingQueue.ClosedException
Closed exception.
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description T
dequeue()
Dequeue an element.T
dequeue(long timeout)
Dequeue an element.void
enqueue(T element)
Enqueue an element.boolean
isClosed()
Check if the queue is closed.T
peek()
Peek the topmost element without dequeuing it.java.util.List<T>
setClosed(boolean closed)
Open/close the queue.int
size()
Get the size.
-
-
-
Method Detail
-
enqueue
void enqueue(T element) throws IBlockingQueue.ClosedException
Enqueue an element.- Parameters:
element
- The element.- Throws:
IBlockingQueue.ClosedException
-
dequeue
T dequeue() throws IBlockingQueue.ClosedException
Dequeue an element.- Returns:
- The element. When queue is empty the methods blocks until an element is added.
- Throws:
IBlockingQueue.ClosedException
-
peek
T peek() throws IBlockingQueue.ClosedException
Peek the topmost element without dequeuing it.- Returns:
- The element. When queue is empty the methods blocks until an element is added.
- Throws:
IBlockingQueue.ClosedException
-
dequeue
T dequeue(long timeout) throws IBlockingQueue.ClosedException, java.util.concurrent.TimeoutException
Dequeue an element.- Parameters:
timeout
- the time to wait (in millis) or -1 for no timeout.- Returns:
- The element. When queue is empty the methods blocks until an element is added or the timeout occurs.
- Throws:
IBlockingQueue.ClosedException
java.util.concurrent.TimeoutException
-
setClosed
java.util.List<T> setClosed(boolean closed)
Open/close the queue.- Parameters:
closed
- The closed state.- Returns:
- The remaining elements after the queue has been closed.
-
isClosed
boolean isClosed()
Check if the queue is closed.
-
size
int size()
Get the size.- Returns:
- The size.
-
-