⇒ Index (Frames) |  ⇒ Index (No Frames) |  ⇒ Package |  ⇒ Package Tree |  ⇒ Full Tree 
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:
Collection, Buffer

Known Direct 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
Author:
Stephen Colebourne

Constructor Summary

SynchronizedBuffer(Buffer buffer)

Constructor that wraps (not copies).

SynchronizedBuffer(Buffer buffer, Object lock)

Constructor that wraps (not copies).

Method Summary

static Buffer

decorate(Buffer buffer)

Factory method to create a synchronized buffer.

Object

get()

Buffer

getBuffer()

Gets the buffer being decorated.

Object

remove()

Constructor Details

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:
- if the buffer is null

SynchronizedBuffer

protected SynchronizedBuffer(Buffer buffer)

Constructor that wraps (not copies).

Parameters:
buffer - the buffer to decorate, must not be null
Throws:
- if the buffer is null

Method Details

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:
- 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()