io.lacuna.bifurcan.durable.allocator

Interface IBuffer

public interface IBuffer

A catch-all interface representing allocated bytes, which may be "open" for writing, or closed and either in-memory or spilled to disk (durable).

Method Summary

Modifier and Type	Method and Description
java.nio.ByteBuffer	bytes()
IBuffer	close(int length, boolean spill)
void	free() Frees the buffer, allowing its contents to be overwritten.
boolean	isClosed()
boolean	isDurable()
long	size()
DurableInput	toInput()
void	transferTo(java.nio.channels.WritableByteChannel target) Transfers all bytes from the buffer to target.

Method Detail

size

long size()

Returns:

the number of bytes in the buffer

toInput

DurableInput toInput()

Returns:

a means of reading the buffer

Throws:

java.lang.Exception - if the buffer is open

bytes

java.nio.ByteBuffer bytes()

Returns:

a means of writing to the buffer

Throws:

java.lang.Exception - if the buffer is closed

close

IBuffer close(int length,
              boolean spill)

Returns:

a closed version of the buffer, representing the first length bytes

Throws:

java.lang.Exception - if the buffer is closed

transferTo

void transferTo(java.nio.channels.WritableByteChannel target)

Transfers all bytes from the buffer to target.

Throws:

java.lang.Exception - if the buffer is open.

free

void free()

Frees the buffer, allowing its contents to be overwritten.

isDurable

boolean isDurable()

isClosed

boolean isClosed()