com.healthmarketscience.jackcess.impl

Class TempBufferHolder

java.lang.Object

com.healthmarketscience.jackcess.impl.TempBufferHolder

Direct Known Subclasses:

TempBufferHolder.HardTempBufferHolder, TempBufferHolder.NoneTempBufferHolder, TempBufferHolder.SoftTempBufferHolder

public abstract class TempBufferHolder
extends java.lang.Object

Manages a reference to a ByteBuffer.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private static class	TempBufferHolder.HardTempBufferHolder TempBufferHolder which has a hard reference to the buffer.
private static class	TempBufferHolder.NoneTempBufferHolder TempBufferHolder which has a no reference to the buffer.
private static class	TempBufferHolder.SoftTempBufferHolder TempBufferHolder which has a soft reference to the buffer.
static class	TempBufferHolder.Type The caching type for the buffer holder.

Field Summary

Fields

Modifier and Type	Field and Description
private boolean	_autoRewind whether or not every get automatically rewinds the buffer
private int	_modCount the mod count of the current buffer (changes on every realloc)
private java.nio.ByteOrder	_order ByteOrder for all allocated buffers
private static java.lang.ref.Reference<java.nio.ByteBuffer>	EMPTY_BUFFER_REF

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	TempBufferHolder(boolean autoRewind, java.nio.ByteOrder order)

Method Summary

Modifier and Type	Method and Description
abstract void	clear() Releases any referenced memory.
java.nio.ByteBuffer	getBuffer(PageChannel pageChannel, int size) Returns a ByteBuffer of at least the given size, with the limit set to the given size, and the predefined byteOrder.
abstract java.nio.ByteBuffer	getExistingBuffer()
int	getModCount()
java.nio.ByteBuffer	getPageBuffer(PageChannel pageChannel) Returns a ByteBuffer of at least the defined page size, with the limit set to the page size, and the predefined byteOrder.
static TempBufferHolder	newHolder(TempBufferHolder.Type type, boolean autoRewind) Creates a new TempBufferHolder.
static TempBufferHolder	newHolder(TempBufferHolder.Type type, boolean autoRewind, java.nio.ByteOrder order) Creates a new TempBufferHolder.
protected abstract void	setNewBuffer(java.nio.ByteBuffer newBuffer) Sets a new buffer for this holder.

Methods inherited from class java.lang.Object

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

Field Detail

EMPTY_BUFFER_REF

private static final java.lang.ref.Reference<java.nio.ByteBuffer> EMPTY_BUFFER_REF

_autoRewind

private final boolean _autoRewind

whether or not every get automatically rewinds the buffer

_order

private final java.nio.ByteOrder _order

ByteOrder for all allocated buffers

_modCount

private int _modCount

the mod count of the current buffer (changes on every realloc)

Constructor Detail

TempBufferHolder

protected TempBufferHolder(boolean autoRewind,
                           java.nio.ByteOrder order)

Method Detail

getModCount

public int getModCount()

Returns:

the modification count of the current buffer (this count is changed every time the buffer is reallocated)

newHolder

public static TempBufferHolder newHolder(TempBufferHolder.Type type,
                                         boolean autoRewind)

Creates a new TempBufferHolder.

Parameters:

type - the type of reference desired for any created buffer

autoRewind - whether or not every get automatically rewinds the buffer

newHolder

public static TempBufferHolder newHolder(TempBufferHolder.Type type,
                                         boolean autoRewind,
                                         java.nio.ByteOrder order)

Creates a new TempBufferHolder.

Parameters:

type - the type of reference desired for any created buffer

autoRewind - whether or not every get automatically rewinds the buffer

order - byte order for all allocated buffers

getPageBuffer

public final java.nio.ByteBuffer getPageBuffer(PageChannel pageChannel)

Returns a ByteBuffer of at least the defined page size, with the limit set to the page size, and the predefined byteOrder. Will be rewound iff autoRewind is enabled for this buffer.

getBuffer

public final java.nio.ByteBuffer getBuffer(PageChannel pageChannel,
                                           int size)

Returns a ByteBuffer of at least the given size, with the limit set to the given size, and the predefined byteOrder. Will be rewound iff autoRewind is enabled for this buffer.

getExistingBuffer

public abstract java.nio.ByteBuffer getExistingBuffer()

Returns:

the currently referenced buffer, null if none

clear

public abstract void clear()

Releases any referenced memory.

setNewBuffer

protected abstract void setNewBuffer(java.nio.ByteBuffer newBuffer)

Sets a new buffer for this holder.