com.aoindustries.util.persistent

Class AbstractPersistentBlockBuffer

java.lang.Object

com.aoindustries.util.persistent.AbstractPersistentBlockBuffer

All Implemented Interfaces:

PersistentBlockBuffer

Direct Known Subclasses:

DynamicPersistentBlockBuffer, FixedPersistentBlockBuffer

public abstract class AbstractPersistentBlockBuffer
extends Object
implements PersistentBlockBuffer

Base class for any implementation that treats a PersistentBuffer as a set of allocatable blocks.

Author:

AO Industries, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
protected PersistentBuffer	pbuffer

Constructor Summary

Constructors

Constructor and Description
AbstractPersistentBlockBuffer(PersistentBuffer pbuffer)

Method Summary

Modifier and Type	Method and Description
void	barrier(boolean force) Ensures that all writes before this barrier occur before all writes after this barrier.
void	close() Closes this buffer.
protected abstract void	ensureCapacity(long capacity) Ensures the underlying persistent buffer is of adequate capacity.
void	get(long id, long offset, byte[] buff, int off, int len) Gets bytes from this block.
protected abstract long	getBlockAddress(long id) Gets the address of the block in the underlying persistent buffer.
InputStream	getInputStream(long id, long offset, long length) Gets an input stream that reads from this buffer.
int	getInt(long id, long offset) Gets an integer from this block.
long	getLong(long id, long offset) Gets a long from this block.
OutputStream	getOutputStream(long id, long offset, long length) Gets an output stream that writes to this buffer.
ProtectionLevel	getProtectionLevel() Gets the protection level currently implemented by the buffer.
boolean	isClosed() Checks if this buffer is closed.
protected boolean	isInBounds(long id, long offset, long len) Checks that a request is within the bounds of the block.
void	put(long id, long offset, byte[] buff, int off, int len) Puts bytes to this block.
void	putInt(long id, long offset, int value) Puts an integer to this block.
void	putLong(long id, long offset, long value) Puts a long to this block.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aoindustries.util.persistent.PersistentBlockBuffer

allocate, deallocate, getBlockSize, iterateBlockIds

Field Detail

pbuffer

protected final PersistentBuffer pbuffer

Constructor Detail

AbstractPersistentBlockBuffer

public AbstractPersistentBlockBuffer(PersistentBuffer pbuffer)

Method Detail

isClosed

public boolean isClosed()

Description copied from interface: PersistentBlockBuffer

Checks if this buffer is closed.

Specified by:

isClosed in interface PersistentBlockBuffer

close

public void close()
           throws IOException

Description copied from interface: PersistentBlockBuffer

Closes this buffer.

Specified by:

close in interface PersistentBlockBuffer

Throws:

IOException

getProtectionLevel

public ProtectionLevel getProtectionLevel()

Description copied from interface: PersistentBlockBuffer

Gets the protection level currently implemented by the buffer.

Specified by:

getProtectionLevel in interface PersistentBlockBuffer

See Also:

PersistentBlockBuffer.barrier(boolean)

barrier

public void barrier(boolean force)
             throws IOException

Description copied from interface: PersistentBlockBuffer

Ensures that all writes before this barrier occur before all writes after this barrier. If force is true, will also commit to physical media synchronously before returning. This request may be ignored or force downgraded to barrier-only depending on the current protection level.

Specified by:

barrier in interface PersistentBlockBuffer

Throws:

IOException

See Also:

PersistentBlockBuffer.getProtectionLevel()

isInBounds

protected boolean isInBounds(long id,
                             long offset,
                             long len)
                      throws IOException

Checks that a request is within the bounds of the block.

Throws:

IOException

get

public void get(long id,
                long offset,
                byte[] buff,
                int off,
                int len)
         throws IOException

Description copied from interface: PersistentBlockBuffer

Gets bytes from this block. Bounds checking is performed only when assertions are enabled.

Specified by:

get in interface PersistentBlockBuffer

Throws:

IOException

getInt

public int getInt(long id,
                  long offset)
           throws IOException

Description copied from interface: PersistentBlockBuffer

Gets an integer from this block. Bounds checking is performed only when assertions are enabled.

Specified by:

getInt in interface PersistentBlockBuffer

Throws:

IOException

getLong

public long getLong(long id,
                    long offset)
             throws IOException

Description copied from interface: PersistentBlockBuffer

Gets a long from this block. Bounds checking is performed only when assertions are enabled.

Specified by:

getLong in interface PersistentBlockBuffer

Throws:

IOException

getInputStream

public InputStream getInputStream(long id,
                                  long offset,
                                  long length)
                           throws IOException

Description copied from interface: PersistentBlockBuffer

Gets an input stream that reads from this buffer. Bounds checking is performed only when assertions are enabled.

Specified by:

getInputStream in interface PersistentBlockBuffer

Throws:

IOException

put

public void put(long id,
                long offset,
                byte[] buff,
                int off,
                int len)
         throws IOException

Description copied from interface: PersistentBlockBuffer

Puts bytes to this block. Bounds checking is performed only when assertions are enabled.

Specified by:

put in interface PersistentBlockBuffer

Throws:

IOException

putInt

public void putInt(long id,
                   long offset,
                   int value)
            throws IOException

Description copied from interface: PersistentBlockBuffer

Puts an integer to this block. Bounds checking is performed only when assertions are enabled.

Specified by:

putInt in interface PersistentBlockBuffer

Throws:

IOException

putLong

public void putLong(long id,
                    long offset,
                    long value)
             throws IOException

Description copied from interface: PersistentBlockBuffer

Puts a long to this block. Bounds checking is performed only when assertions are enabled.

Specified by:

putLong in interface PersistentBlockBuffer

Throws:

IOException

getOutputStream

public OutputStream getOutputStream(long id,
                                    long offset,
                                    long length)
                             throws IOException

Description copied from interface: PersistentBlockBuffer

Gets an output stream that writes to this buffer. Bounds checking is performed only when assertions are enabled.

Specified by:

getOutputStream in interface PersistentBlockBuffer

Throws:

IOException

getBlockAddress

protected abstract long getBlockAddress(long id)
                                 throws IOException

Gets the address of the block in the underlying persistent buffer. This should only be called for allocated blocks, implementations should check this with assertions.

Throws:

IOException

ensureCapacity

protected abstract void ensureCapacity(long capacity)
                                throws IOException

Ensures the underlying persistent buffer is of adequate capacity. Grows the underlying storage if needed.

Throws:

IOException