SynchronizedBuffer documentation

FRAMES NO FRAMES SUMMARY: NESTED CONSTR ENUM FIELD METHOD ELEMENT

DETAIL: FIELD CONSTR ENUM METHOD ELEMENT

org.apache.commons.collections.buffer

Class SynchronizedBuffer

Tab mode

All derived types

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.

SinceCommons Co

Version$Revision:

AuthorStephen Colebourne

Wiki javadoc Use textile entry format.

Add your comments here.

Fields inherited from org.apache.commons.collections.collectionSynchronizedCollection
collection lock

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() No description provided.
protected Buffer	getBuffer() Gets the buffer being decorated.
Object	remove() No description provided.

Methods inherited from java.utilCollection
add (Object) addAll (Collection) clear () contains (Object) containsAll (Collection) equals (Object) hashCode () isEmpty () iterator () remove (Object) removeAll (Collection) retainAll (Collection) size () toArray () toArray (Object[])

Methods inherited from java.langObject
clone () equals (Object) finalize () getClass () hashCode () notify () notifyAll () toString () wait (long) wait (long, int) wait ()

Methods inherited from org.apache.commons.collections.collectionSynchronizedCollection
add (Object) addAll (Collection) clear () contains (Object) containsAll (Collection) decorate (Collection) equals (Object) hashCode () isEmpty () iterator () remove (Object) removeAll (Collection) retainAll (Collection) size () toArray () toArray (Object[]) toString ()

Constructor Detail

SynchronizedBuffer

protected SynchronizedBuffer ( Buffer buffer )

Constructor that wraps (not copies).

Parameters

Type	Name	Description
Buffer	buffer	the buffer to decorate, must not be null

Wiki javadoc Use textile entry format.

Add your comments here.

SynchronizedBuffer

protected SynchronizedBuffer ( Buffer buffer, Object lock )

Constructor that wraps (not copies).

Parameters

Type	Name	Description
Buffer	buffer	the buffer to decorate, must not be null
Object	lock	the lock object to use, must not be null

Wiki javadoc Use textile entry format.

Add your comments here.

Method Detail

decorate

public static Buffer decorate ( Buffer buffer )

Factory method to create a synchronized buffer.

Parameters

Type	Name	Description
Buffer	buffer	the buffer to decorate, must not be null

Wiki javadoc Use textile entry format.

Add your comments here.

get

public Object get ( )

No description provided.

Implements method in Buffer

Wiki javadoc Use textile entry format.

Add your comments here.

getBuffer

protected Buffer getBuffer ( )

Gets the buffer being decorated.

Wiki javadoc Use textile entry format.

Add your comments here.

remove

public Object remove ( )

No description provided.

Implements method in Buffer

Wiki javadoc Use textile entry format.

Add your comments here.