net.openhft.lang.io

Class DirectStore

java.lang.Object

net.openhft.lang.io.DirectStore

All Implemented Interfaces:

AutoCloseable, BytesStore

public class DirectStore
extends Object
implements BytesStore, AutoCloseable

Author:

peter.lawrey

Constructor Summary

Constructors

Constructor and Description
DirectStore(long size)
DirectStore(ObjectSerializer objectSerializer, long size, boolean zeroOut)

Method Summary

Modifier and Type	Method and Description
long	address()
static DirectStore	allocate(long size)
static DirectStore	allocateLazy(long size)
static BytesStore	allocateLazy(long sizeInBytes, ObjectSerializer objectSerializer)
DirectBytes	bytes() Create a bytes whose content is the whole bytes store.
DirectBytes	bytes(long offset, long length) Slice a Bytes object with start address of address+ offset and capacity of length.
void	close() calls free
File	file()
void	free()
ObjectSerializer	objectSerializer()
void	resize(long newSize, boolean zeroOut) Resizes this DirectStore to the newSize.
long	size()

Methods inherited from class java.lang.Object

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

Constructor Detail

DirectStore

public DirectStore(long size)

DirectStore

public DirectStore(ObjectSerializer objectSerializer,
                   long size,
                   boolean zeroOut)

Method Detail

allocate

@NotNull
public static DirectStore allocate(long size)

allocateLazy

@NotNull
public static DirectStore allocateLazy(long size)

allocateLazy

public static BytesStore allocateLazy(long sizeInBytes,
                                      ObjectSerializer objectSerializer)

objectSerializer

public ObjectSerializer objectSerializer()

Specified by:

objectSerializer in interface BytesStore

resize

public void resize(long newSize,
                   boolean zeroOut)

Resizes this DirectStore to the newSize.

If zeroOut is false, the memory past the old size is not zeroed out and will generally be garbage.

DirectStore don't keep track of the child DirectBytes instances, so after the resize they might point to the wrong memory. Use at your own risk.

Parameters:

newSize - new size of this DirectStore

zeroOut - if the memory past the old size should be zeroed out on increasing resize

Throws:

IllegalArgumentException - if the newSize is not positive

bytes

@NotNull
public DirectBytes bytes()

Description copied from interface: BytesStore

Create a bytes whose content is the whole bytes store. Call of this method is equivalent to bytes(0, size()) call.

Specified by:

bytes in interface BytesStore

Returns:

the new bytes

See Also:

BytesStore.bytes(long, long)

bytes

@NotNull
public DirectBytes bytes(long offset,
                                  long length)

Description copied from interface: BytesStore

Slice a Bytes object with start address of address+ offset and capacity of length.

If this BytesStore is Bytes itself rather than natural BytesStore object, this method will offset the new bytes from the bytes' start, not from bytes' position like BytesCommon.slice(long, long).

offset should be non-negative, length should be positive, offset + length should be less or equal to size.

Specified by:

bytes in interface BytesStore

Parameters:

offset - offset of the new bytes from the bytes store address

length - capacity and limit of the new bytes

Returns:

the sliced Bytes

See Also:

BytesStore.bytes()

address

public long address()

Specified by:

address in interface BytesStore

free

public void free()

Specified by:

free in interface BytesStore

size

public long size()

Specified by:

size in interface BytesStore

file

public File file()

Specified by:

file in interface BytesStore

close

public void close()

calls free

Specified by:

close in interface AutoCloseable