net.kuujo.catalyst.buffer

Class MappedBytes

java.lang.Object

net.kuujo.catalyst.buffer.AbstractBytes

net.kuujo.catalyst.buffer.NativeBytes

net.kuujo.catalyst.buffer.MappedBytes

All Implemented Interfaces:

AutoCloseable, Bytes, BytesInput<Bytes>, BytesOutput<Bytes>

public class MappedBytes
extends NativeBytes

Mapped bytes.

Mapped bytes provide direct access to memory from allocated by a MappedByteBuffer. Memory is allocated by opening and expanding the given File to the desired count and mapping the file contents into memory via FileChannel.map(java.nio.channels.FileChannel.MapMode, long, long).

Closing the bytes via Bytes.close() will result in BytesOutput.flush() being automatically called.

Author:

Jordan Halterman

Field Summary

Fields inherited from interface net.kuujo.catalyst.buffer.Bytes

BOOLEAN, BYTE, CHARACTER, DOUBLE, FLOAT, INTEGER, LONG, MEDIUM, SHORT

Method Summary

Modifier and Type	Method and Description
static MappedBytes	allocate(File file, FileChannel.MapMode mode, long size) Allocates a mapped buffer.
static MappedBytes	allocate(File file, long size) Allocates a mapped buffer in FileChannel.MapMode.READ_WRITE mode.
MappedBytes	copy() Copies the bytes to a new byte array.
void	delete() Deletes the underlying file.
Bytes	flush() Flushes the bytes to the underlying persistence layer.
boolean	isDirect() Returns a boolean value indicating whether the bytes are direct.
boolean	isFile() Returns a boolean value indicating whether the bytes are backed by a file.

Methods inherited from class net.kuujo.catalyst.buffer.NativeBytes

close, read, read, readBoolean, readByte, readChar, readDouble, readFloat, readInt, readLong, readMedium, readShort, readString, readUnsignedByte, readUnsignedInt, readUnsignedMedium, readUnsignedShort, readUTF8, resize, size, write, write, writeBoolean, writeByte, writeChar, writeDouble, writeFloat, writeInt, writeLong, writeMedium, writeShort, writeString, writeUnsignedByte, writeUnsignedInt, writeUnsignedMedium, writeUnsignedShort, writeUTF8, zero, zero, zero

Methods inherited from class net.kuujo.catalyst.buffer.AbstractBytes

order, order

Methods inherited from class java.lang.Object

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

Method Detail

allocate

public static MappedBytes allocate(File file,
                                   long size)

Allocates a mapped buffer in FileChannel.MapMode.READ_WRITE mode.

Memory will be mapped by opening and expanding the given File to the desired count and mapping the file contents into memory via FileChannel.map(java.nio.channels.FileChannel.MapMode, long, long).

Parameters:

file - The file to map into memory. If the file doesn't exist it will be automatically created.

size - The count of the buffer to allocate (in bytes).

Returns:

The mapped buffer.

Throws:

NullPointerException - If file is null

IllegalArgumentException - If count is greater than MappedMemory.MAX_SIZE

See Also:

allocate(java.io.File, java.nio.channels.FileChannel.MapMode, long)

allocate

public static MappedBytes allocate(File file,
                                   FileChannel.MapMode mode,
                                   long size)

Allocates a mapped buffer.

Memory will be mapped by opening and expanding the given File to the desired count and mapping the file contents into memory via FileChannel.map(java.nio.channels.FileChannel.MapMode, long, long).

Parameters:

file - The file to map into memory. If the file doesn't exist it will be automatically created.

mode - The mode with which to map the file.

size - The count of the buffer to allocate (in bytes).

Returns:

The mapped buffer.

Throws:

NullPointerException - If file is null

IllegalArgumentException - If count is greater than MappedMemory.MAX_SIZE

See Also:

allocate(java.io.File, long)

copy

public MappedBytes copy()

Copies the bytes to a new byte array.

Returns:

A new MappedBytes instance backed by a copy of this instance's memory.

isDirect

public boolean isDirect()

Description copied from interface: Bytes

Returns a boolean value indicating whether the bytes are direct.

Specified by:

isDirect in interface Bytes

Overrides:

isDirect in class NativeBytes

Returns:

Indicates whether the bytes are direct.

isFile

public boolean isFile()

Description copied from interface: Bytes

Returns a boolean value indicating whether the bytes are backed by a file.

Specified by:

isFile in interface Bytes

Overrides:

isFile in class AbstractBytes

Returns:

Indicates whether the bytes are backed by a file.

flush

public Bytes flush()

Description copied from interface: BytesOutput

Flushes the bytes to the underlying persistence layer.

Specified by:

flush in interface BytesOutput<Bytes>

Overrides:

flush in class NativeBytes

Returns:

The flushed buffer.

delete

public void delete()

Deletes the underlying file.