Module com.aoapps.persistence

Package com.aoapps.persistence

Class AbstractPersistentBuffer

java.lang.Object

com.aoapps.persistence.AbstractPersistentBuffer

All Implemented Interfaces:

PersistentBuffer, Closeable, AutoCloseable

Direct Known Subclasses:

LargeMappedPersistentBuffer, MappedPersistentBuffer, RandomAccessFileBuffer, TwoCopyBarrierBuffer

public abstract class AbstractPersistentBuffer
extends Object
implements PersistentBuffer

Provides a base implementation of PersistentBuffer in terms of basic read/write methods. This class is not thread safe.

Author:

AO Industries, Inc.

Field Summary

Fields

Modifier and Type	Field	Description
protected ProtectionLevel	protectionLevel

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractPersistentBuffer(ProtectionLevel protectionLevel)

Method Summary

Modifier and Type	Method	Description
byte	get(long position)	Implemented as call to get(long, byte[], int, int).
void	get(long position, byte[] buff, int off, int len)	Implemented as calls to PersistentBuffer.getSome(long, byte[], int, int).
boolean	getBoolean(long position)	Implemented as call to get(long).
InputStream	getInputStream(long position, long length)	Implemented as calls to get(long) and PersistentBuffer.getSome(long, byte[], int, int).
int	getInt(long position)	Implemented as call to get(long, byte[], int, int).
long	getLong(long position)	Implemented as call to get(long, byte[], int, int).
OutputStream	getOutputStream(long position, long length)	Implemented as calls to put(long, byte) and PersistentBuffer.put(long, byte[], int, int).
ProtectionLevel	getProtectionLevel()	Gets the protection level currently enforced by the buffer.
void	put(long position, byte value)	Implemented as call to PersistentBuffer.put(long, byte[], int, int).
void	putInt(long position, int value)	Implemented as call to PersistentBuffer.put(long, byte[], int, int).
void	putLong(long position, long value)	Implemented as call to PersistentBuffer.put(long, byte[], int, int).

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.aoapps.persistence.PersistentBuffer

barrier, capacity, close, ensureZeros, getSome, isClosed, put, setCapacity

Field Detail

protectionLevel

protected final ProtectionLevel protectionLevel

Constructor Detail

AbstractPersistentBuffer

protected AbstractPersistentBuffer(ProtectionLevel protectionLevel)

Method Detail

getProtectionLevel

public ProtectionLevel getProtectionLevel()

Description copied from interface: PersistentBuffer

Gets the protection level currently enforced by the buffer.

Specified by:

getProtectionLevel in interface PersistentBuffer

See Also:

PersistentBuffer.barrier(boolean)

get

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

Implemented as calls to PersistentBuffer.getSome(long, byte[], int, int).

Specified by:

get in interface PersistentBuffer

Throws:

IOException

See Also:

PersistentBuffer.getSome(long, byte[], int, int)

getBoolean

public boolean getBoolean(long position)
                   throws IOException

Implemented as call to get(long).

Specified by:

getBoolean in interface PersistentBuffer

Throws:

IOException

See Also:

get(long)

get

public byte get(long position)
         throws IOException

Implemented as call to get(long, byte[], int, int). For performance reasons, it is strongly recommended to provide a more efficient implementation of this method.

Specified by:

get in interface PersistentBuffer

Throws:

IOException

See Also:

get(long, byte[], int, int)

getInt

public int getInt(long position)
           throws IOException

Implemented as call to get(long, byte[], int, int).

Specified by:

getInt in interface PersistentBuffer

Throws:

IOException

See Also:

get(long, byte[], int, int)

getLong

public long getLong(long position)
             throws IOException

Implemented as call to get(long, byte[], int, int).

Specified by:

getLong in interface PersistentBuffer

Throws:

IOException

See Also:

get(long, byte[], int, int)

put

public void put(long position,
                byte value)
         throws IOException

Implemented as call to PersistentBuffer.put(long, byte[], int, int). For performance reasons, it is strongly recommended to provide a more efficient implementation of this method.

Specified by:

put in interface PersistentBuffer

Throws:

IOException

See Also:

PersistentBuffer.put(long, byte[], int, int)

putInt

public void putInt(long position,
                   int value)
            throws IOException

Implemented as call to PersistentBuffer.put(long, byte[], int, int).

Specified by:

putInt in interface PersistentBuffer

Throws:

IOException

See Also:

PersistentBuffer.put(long, byte[], int, int)

putLong

public void putLong(long position,
                    long value)
             throws IOException

Implemented as call to PersistentBuffer.put(long, byte[], int, int).

Specified by:

putLong in interface PersistentBuffer

Throws:

IOException

See Also:

PersistentBuffer.put(long, byte[], int, int)

getInputStream

public InputStream getInputStream(long position,
                                  long length)
                           throws IOException,
                                  BufferUnderflowException

Implemented as calls to get(long) and PersistentBuffer.getSome(long, byte[], int, int).

Specified by:

getInputStream in interface PersistentBuffer

Throws:

BufferUnderflowException - on end of file

IOException

See Also:

get(long), PersistentBuffer.getSome(long, byte[], int, int)

getOutputStream

public OutputStream getOutputStream(long position,
                                    long length)
                             throws IOException,
                                    BufferOverflowException

Implemented as calls to put(long, byte) and PersistentBuffer.put(long, byte[], int, int).

Specified by:

getOutputStream in interface PersistentBuffer

Throws:

IOException

BufferOverflowException

See Also:

put(long, byte), PersistentBuffer.put(long, byte[], int, int)