org.apache.commons.collections
Class BufferUtils
java.lang.Object
org.apache.commons.collections.BufferUtils
public class BufferUtils
extends java.lang.Object
Provides utility methods and decorators for
Buffer
instances.
$Revision: 1.20 $ $Date: 2004/04/01 20:12:00 $- Paul Jack
- Stephen Colebourne
BufferUtils() -
BufferUtils should not normally be instantiated.
|
EMPTY_BUFFER
public static final Buffer EMPTY_BUFFER
An empty unmodifiable buffer.
BufferUtils
public BufferUtils()
BufferUtils
should not normally be instantiated.
blockingBuffer
public static Buffer blockingBuffer(Buffer buffer)
Returns a synchronized buffer backed by the given buffer that will
block on
Buffer.get()
and
Buffer.remove()
operations.
If the buffer is empty, then the
Buffer.get()
and
Buffer.remove()
operations will block until new elements
are added to the buffer, rather than immediately throwing a
BufferUnderflowException
.
buffer
- the buffer to synchronize, must not be null
- a blocking buffer backed by that buffer
predicatedBuffer
public static Buffer predicatedBuffer(Buffer buffer,
Predicate predicate)
Returns a predicated (validating) buffer backed by the given buffer.
Only objects that pass the test in the given predicate can be added to the buffer.
Trying to add an invalid object results in an IllegalArgumentException.
It is important not to use the original buffer after invoking this method,
as it is a backdoor for adding invalid objects.
buffer
- the buffer to predicate, must not be nullpredicate
- the predicate used to evaluate new elements, must not be null
synchronizedBuffer
public static Buffer synchronizedBuffer(Buffer buffer)
Returns a synchronized buffer backed by the given buffer.
Much like the synchronized collections returned by
java.util.Collections
, you must manually synchronize on
the returned buffer's iterator to avoid non-deterministic behavior:
Buffer b = BufferUtils.synchronizedBuffer(myBuffer);
synchronized (b) {
Iterator i = b.iterator();
while (i.hasNext()) {
process (i.next());
}
}
buffer
- the buffer to synchronize, must not be null
- a synchronized buffer backed by that buffer
transformedBuffer
public static Buffer transformedBuffer(Buffer buffer,
Transformer transformer)
Returns a transformed buffer backed by the given buffer.
Each object is passed through the transformer as it is added to the
Buffer. It is important not to use the original buffer after invoking this
method, as it is a backdoor for adding untransformed objects.
buffer
- the buffer to predicate, must not be nulltransformer
- the transformer for the buffer, must not be null
- a transformed buffer backed by the given buffer
typedBuffer
public static Buffer typedBuffer(Buffer buffer,
Class type)
Returns a typed buffer backed by the given buffer.
Only elements of the specified type can be added to the buffer.
buffer
- the buffer to predicate, must not be nulltype
- the type to allow into the buffer, must not be null
unmodifiableBuffer
public static Buffer unmodifiableBuffer(Buffer buffer)
Returns an unmodifiable buffer backed by the given buffer.
buffer
- the buffer to make unmodifiable, must not be null
- an unmodifiable buffer backed by that buffer
Copyright © 2001-2006 Apache Software Foundation. All Rights Reserved.