Class BlockingBuffer
- java.lang.Object
-
- org.apache.commons.collections.collection.SynchronizedCollection
-
- org.apache.commons.collections.buffer.SynchronizedBuffer
-
- org.apache.commons.collections.buffer.BlockingBuffer
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Iterable
,java.util.Collection
,Buffer
@Deprecated(since="2021-04-30") public class BlockingBuffer extends SynchronizedBuffer
Deprecated.Commons Collections 3 is in maintenance mode. Commons Collections 4 should be used instead.Decorates anotherBuffer
to makeget()
andremove()
block when theBuffer
is empty.If either
get
orremove
is called on an emptyBuffer
, the calling thread waits for notification that anadd
oraddAll
operation has completed.When one or more entries are added to an empty
Buffer
, all threads blocked inget
orremove
are notified. There is no guarantee that concurrent blockedget
orremove
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.
- Since:
- Commons Collections 3.0
- See Also:
- Serialized Form
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description boolean
add(java.lang.Object o)
Deprecated.boolean
addAll(java.util.Collection c)
Deprecated.static Buffer
decorate(Buffer buffer)
Deprecated.Factory method to create a blocking buffer.static Buffer
decorate(Buffer buffer, long timeoutMillis)
Deprecated.Factory method to create a blocking buffer with a timeout value.java.lang.Object
get()
Deprecated.Gets the next value from the buffer, waiting until an object is added if the buffer is empty.java.lang.Object
get(long timeout)
Deprecated.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()
Deprecated.Removes the next value from the buffer, waiting until an object is added if the buffer is empty.java.lang.Object
remove(long timeout)
Deprecated.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.-
Methods inherited from class org.apache.commons.collections.collection.SynchronizedCollection
clear, contains, containsAll, decorate, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString
-
-
-
-
Method Detail
-
decorate
public static Buffer decorate(Buffer buffer)
Deprecated.Factory method to create a blocking buffer.- Parameters:
buffer
- the buffer to decorate, must not be null- Returns:
- a new blocking Buffer
- Throws:
java.lang.IllegalArgumentException
- if buffer is null
-
decorate
public static Buffer decorate(Buffer buffer, long timeoutMillis)
Deprecated.Factory method to create a blocking buffer with a timeout value.- Parameters:
buffer
- the buffer to decorate, must not be nulltimeoutMillis
- the timeout value in milliseconds, zero or less for no timeout- Returns:
- a new blocking buffer
- Throws:
java.lang.IllegalArgumentException
- if the buffer is null- Since:
- Commons Collections 3.2
-
add
public boolean add(java.lang.Object o)
Deprecated.- Specified by:
add
in interfacejava.util.Collection
- Overrides:
add
in classSynchronizedCollection
-
addAll
public boolean addAll(java.util.Collection c)
Deprecated.- Specified by:
addAll
in interfacejava.util.Collection
- Overrides:
addAll
in classSynchronizedCollection
-
get
public java.lang.Object get()
Deprecated.Gets the next value from the buffer, waiting until an object is added if the buffer is empty. This method uses the default timeout set in the constructor.- Specified by:
get
in interfaceBuffer
- Overrides:
get
in classSynchronizedBuffer
- Returns:
- the next object in the buffer, which is not removed
- Throws:
BufferUnderflowException
- if an interrupt is received
-
get
public java.lang.Object get(long timeout)
Deprecated.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.- Parameters:
timeout
- the timeout value in milliseconds- Throws:
BufferUnderflowException
- if an interrupt is receivedBufferUnderflowException
- if the timeout expires- Since:
- Commons Collections 3.2
-
remove
public java.lang.Object remove()
Deprecated.Removes the next value from the buffer, waiting until an object is added if the buffer is empty. This method uses the default timeout set in the constructor.- Specified by:
remove
in interfaceBuffer
- Overrides:
remove
in classSynchronizedBuffer
- Returns:
- the next object in the buffer, which is also removed
- Throws:
BufferUnderflowException
- if an interrupt is received
-
remove
public java.lang.Object remove(long timeout)
Deprecated.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.- Parameters:
timeout
- the timeout value in milliseconds- Throws:
BufferUnderflowException
- if an interrupt is receivedBufferUnderflowException
- if the timeout expires- Since:
- Commons Collections 3.2
-
-