de.undercouch.bson4jackson.io

Class StaticBuffers

java.lang.Object

de.undercouch.bson4jackson.io.StaticBuffers

public class StaticBuffers
extends java.lang.Object

Keeps thread-local re-usable buffers. Each buffer is identified by a key. This class is a singleton, whereas the reference to the instance is hold in a SoftReference so buffers can be freed when they are not needed anymore.

See Also:

BufferRecycler

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	StaticBuffers.Key Possible buffer keys

Field Summary

Fields

Modifier and Type	Field and Description
protected java.nio.ByteBuffer[]	_byteBuffers Maps of already allocated re-usable buffers
protected java.nio.CharBuffer[]	_charBuffers
protected static java.lang.ThreadLocal<java.lang.ref.SoftReference<StaticBuffers>>	_instance A thread-local soft reference to the singleton instance of this class
static int	GLOBAL_MIN_SIZE All buffers have a minimum size of 64 kb

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	StaticBuffers() Hidden constructor

Method Summary

Methods

Modifier and Type	Method and Description
java.nio.ByteBuffer	byteBuffer(StaticBuffers.Key key, int minSize) Creates or re-uses a ByteBuffer that has a minimum size.
java.nio.CharBuffer	charBuffer(StaticBuffers.Key key, int minSize) Creates or re-uses a CharBuffer that has a minimum size.
static StaticBuffers	getInstance()
void	releaseByteBuffer(StaticBuffers.Key key, java.nio.ByteBuffer buf) Marks a buffer a being re-usable.
void	releaseCharBuffer(StaticBuffers.Key key, java.nio.CharBuffer buf) Marks a buffer a being re-usable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

GLOBAL_MIN_SIZE

public static final int GLOBAL_MIN_SIZE

All buffers have a minimum size of 64 kb

See Also:

Constant Field Values

_instance

protected static final java.lang.ThreadLocal<java.lang.ref.SoftReference<StaticBuffers>> _instance

A thread-local soft reference to the singleton instance of this class

_byteBuffers

protected java.nio.ByteBuffer[] _byteBuffers

Maps of already allocated re-usable buffers

_charBuffers

protected java.nio.CharBuffer[] _charBuffers

Constructor Detail

StaticBuffers

protected StaticBuffers()

Hidden constructor

Method Detail

getInstance

public static StaticBuffers getInstance()

Returns:

a thread-local singleton instance of this class

charBuffer

public java.nio.CharBuffer charBuffer(StaticBuffers.Key key,
                             int minSize)

Creates or re-uses a CharBuffer that has a minimum size. Calling this method multiple times with the same key will always return the same buffer, as long as it has the minimum size and is marked to be re-used. Buffers that are allowed to be re-used should be released using releaseCharBuffer(Key, CharBuffer).

Parameters:

key - the buffer's identifier

minSize - the minimum size

Returns:

the CharBuffer instance

See Also:

byteBuffer(Key, int)

releaseCharBuffer

public void releaseCharBuffer(StaticBuffers.Key key,
                     java.nio.CharBuffer buf)

Marks a buffer a being re-usable.

Parameters:

key - the buffer's key

buf - the buffer

See Also:

releaseByteBuffer(Key, ByteBuffer)

byteBuffer

public java.nio.ByteBuffer byteBuffer(StaticBuffers.Key key,
                             int minSize)

Creates or re-uses a ByteBuffer that has a minimum size. Calling this method multiple times with the same key will always return the same buffer, as long as it has the minimum size and is marked to be re-used. Buffers that are allowed to be re-used should be released using releaseByteBuffer(Key, ByteBuffer).

Parameters:

key - the buffer's identifier

minSize - the minimum size

Returns:

the ByteBuffer instance

See Also:

charBuffer(Key, int)

releaseByteBuffer

public void releaseByteBuffer(StaticBuffers.Key key,
                     java.nio.ByteBuffer buf)

Marks a buffer a being re-usable.

Parameters:

key - the buffer's key

buf - the buffer

See Also:

releaseCharBuffer(Key, CharBuffer)