public class BlockingBuffer extends SynchronizedBuffer
Buffer
to make get()
and
remove()
block when the Buffer
is empty.
If either get
or remove
is called on an empty
Buffer
, the calling thread waits for notification that
an add
or addAll
operation has completed.
When one or more entries are added to an empty Buffer
,
all threads blocked in get
or remove
are notified.
There is no guarantee that concurrent blocked get
or
remove
requests will be "unblocked" and receive data in the
order that they arrive.
This class is Serializable from Commons Collections 3.1. This class contains an extra field in 3.2, however the serialization specification will handle this gracefully.
Modifier and Type | Method and Description |
---|---|
boolean |
add(java.lang.Object o) |
boolean |
addAll(java.util.Collection c) |
static Buffer |
decorate(Buffer buffer)
Factory method to create a blocking buffer.
|
static Buffer |
decorate(Buffer buffer,
long timeoutMillis)
Factory method to create a blocking buffer with a timeout value.
|
java.lang.Object |
get()
Gets the next value from the buffer, waiting until an object is
added if the buffer is empty.
|
java.lang.Object |
get(long timeout)
Gets the next value from the buffer, waiting until an object is
added for up to the specified timeout value if the buffer is empty.
|
java.lang.Object |
remove()
Removes the next value from the buffer, waiting until an object is
added if the buffer is empty.
|
java.lang.Object |
remove(long timeout)
Removes the next value from the buffer, waiting until an object is
added for up to the specified timeout value if the buffer is empty.
|
clear, contains, containsAll, decorate, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString
public static Buffer decorate(Buffer buffer)
buffer
- the buffer to decorate, must not be nulljava.lang.IllegalArgumentException
- if buffer is nullpublic static Buffer decorate(Buffer buffer, long timeoutMillis)
buffer
- the buffer to decorate, must not be nulltimeoutMillis
- the timeout value in milliseconds, zero or less for no timeoutjava.lang.IllegalArgumentException
- if the buffer is nullpublic boolean add(java.lang.Object o)
add
in interface java.util.Collection
add
in class SynchronizedCollection
public boolean addAll(java.util.Collection c)
addAll
in interface java.util.Collection
addAll
in class SynchronizedCollection
public java.lang.Object get()
get
in interface Buffer
get
in class SynchronizedBuffer
BufferUnderflowException
- if an interrupt is receivedpublic java.lang.Object get(long timeout)
timeout
- the timeout value in millisecondsBufferUnderflowException
- if an interrupt is receivedBufferUnderflowException
- if the timeout expirespublic java.lang.Object remove()
remove
in interface Buffer
remove
in class SynchronizedBuffer
BufferUnderflowException
- if an interrupt is receivedpublic java.lang.Object remove(long timeout)
timeout
- the timeout value in millisecondsBufferUnderflowException
- if an interrupt is receivedBufferUnderflowException
- if the timeout expiresCopyright © 2010 - 2020 Adobe. All Rights Reserved