org.apache.commons.collections.buffer
Class SynchronizedBuffer
java.lang.Object
|
+--org.apache.commons.collections.collection.SynchronizedCollection
|
+--org.apache.commons.collections.buffer.SynchronizedBuffer
- All Implemented Interfaces:
- Buffer, Collection
- Direct Known Subclasses:
- BlockingBuffer
- public class SynchronizedBuffer
- extends SynchronizedCollection
- implements Buffer
Decorates another Buffer
to synchronize its behaviour
for a multi-threaded environment.
Methods are synchronized, then forwarded to the decorated buffer.
- Since:
- Commons Collections 3.0
- Version:
- $Revision: 1.2 $ $Date: 2004/01/14 21:43:08 $
- Author:
- Stephen Colebourne
Method Summary |
static Buffer |
decorate(Buffer buffer)
Factory method to create a synchronized buffer. |
Object |
get()
Gets the next object from the buffer without removing it. |
protected Buffer |
getBuffer()
Gets the buffer being decorated. |
Object |
remove()
Gets and removes the next object from the buffer. |
Methods inherited from class org.apache.commons.collections.collection.SynchronizedCollection |
add, addAll, clear, contains, containsAll, decorate, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray, toString |
Methods inherited from interface java.util.Collection |
add, addAll, clear, contains, containsAll, equals, hashCode, isEmpty, iterator, remove, removeAll, retainAll, size, toArray, toArray |
SynchronizedBuffer
protected SynchronizedBuffer(Buffer buffer)
- Constructor that wraps (not copies).
- Parameters:
buffer
- the buffer to decorate, must not be null- Throws:
IllegalArgumentException
- if the buffer is null
SynchronizedBuffer
protected SynchronizedBuffer(Buffer buffer,
Object lock)
- Constructor that wraps (not copies).
- Parameters:
buffer
- the buffer to decorate, must not be nulllock
- the lock object to use, must not be null- Throws:
IllegalArgumentException
- if the buffer is null
decorate
public static Buffer decorate(Buffer buffer)
- Factory method to create a synchronized buffer.
- Parameters:
buffer
- the buffer to decorate, must not be null- Throws:
IllegalArgumentException
- if buffer is null
getBuffer
protected Buffer getBuffer()
- Gets the buffer being decorated.
- Returns:
- the decorated buffer
get
public Object get()
- Description copied from interface:
Buffer
- Gets the next object from the buffer without removing it.
- Specified by:
get
in interface Buffer
- Following copied from interface:
org.apache.commons.collections.Buffer
- Returns:
- the next object in the buffer, which is not removed
- Throws:
BufferUnderflowException
- if the buffer is empty
remove
public Object remove()
- Description copied from interface:
Buffer
- Gets and removes the next object from the buffer.
- Specified by:
remove
in interface Buffer
- Following copied from interface:
org.apache.commons.collections.Buffer
- Returns:
- the next object in the buffer, which is also removed
- Throws:
BufferUnderflowException
- if the buffer is already empty
Copyright © 2001-2004 Apache Software Foundation. All Rights Reserved.