org.apache.commons.collections.buffer

Class SynchronizedBuffer

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.

This class is Serializable from Commons Collections 3.1.

Since: Commons Collections 3.0

Version: $Revision: 155406 $ $Date: 2005-02-26 12:55:26 +0000 (Sat, 26 Feb 2005) $

Author: Stephen Colebourne

Constructor Summary
protected SynchronizedBuffer(Buffer buffer)
Constructor that wraps (not copies).
protected SynchronizedBuffer(Buffer buffer, Object lock)
Constructor that wraps (not copies).
Method Summary
static Bufferdecorate(Buffer buffer)
Factory method to create a synchronized buffer.
Objectget()
protected BuffergetBuffer()
Gets the buffer being decorated.
Objectremove()

Constructor Detail

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 null lock the lock object to use, must not be null

Throws: IllegalArgumentException if the buffer is null

Method Detail

decorate

public static Buffer decorate(Buffer buffer)
Factory method to create a synchronized buffer.

Parameters: buffer the buffer to decorate, must not be null

Returns: a new synchronized Buffer

Throws: IllegalArgumentException if buffer is null

get

public Object get()

getBuffer

protected Buffer getBuffer()
Gets the buffer being decorated.

Returns: the decorated buffer

remove

public Object remove()
Copyright © 2001-2008 Apache Software Foundation. All Rights Reserved.