net.openhft.chronicle.bytes

Interface Byteable<B extends BytesStore<B,Underlying>,Underlying>

All Known Subinterfaces:

ByteableIntArrayValues, ByteableLongArrayValues, LongReference, TwoLongReference

All Known Implementing Classes:

AbstractReference, BinaryBooleanReference, BinaryIntArrayReference, BinaryIntReference, BinaryLongArrayReference, BinaryLongReference, BinaryTwoLongReference, GuardedNativeBytes, NativeBytes, NativeBytes.NativeSubBytes, OnHeapBytes, SubBytes, TextBooleanReference, TextIntArrayReference, TextIntReference, TextLongArrayReference, TextLongReference, UncheckedLongReference, VanillaBytes

public interface Byteable<B extends BytesStore<B,Underlying>,Underlying>

This Interface allows a reference to off heap memory to be reassigned.

A reference to off heap memory is a proxy for some memory which sits outside the heap.

Method Summary

Modifier and Type	Method and Description
@Nullable BytesStore<B,Underlying>	bytesStore()
void	bytesStore(BytesStore<B,Underlying> bytesStore, long offset, long length) This setter for a data type which points to an underlying ByteStore.
long	maxSize()
long	offset()

Method Detail

bytesStore

void bytesStore(BytesStore<B,Underlying> bytesStore,
                long offset,
                long length)
         throws IllegalStateException,
                IllegalArgumentException,
                BufferOverflowException,
                BufferUnderflowException

This setter for a data type which points to an underlying ByteStore.

Parameters:

bytesStore - the fix point ByteStore

offset - the offset within the ByteStore

length - the length in the ByteStore

Throws:

IllegalStateException

IllegalArgumentException

BufferOverflowException

BufferUnderflowException

bytesStore

@Nullable
@Nullable BytesStore<B,Underlying> bytesStore()

offset

long offset()

maxSize

long maxSize()

Returns:

the maximum size in byte for this reference.