net.openhft.chronicle.bytes.internal

Class NoBytesStore

java.lang.Object

net.openhft.chronicle.bytes.internal.NoBytesStore

All Implemented Interfaces:

CharSequence, BytesStore, RandomDataInput, RandomDataOutput, net.openhft.chronicle.core.io.ReferenceCounted, net.openhft.chronicle.core.io.ReferenceOwner

public final class NoBytesStore
extends Object
implements BytesStore

This is a ByteStore which uses no space but could be resized to be larger (by replacing it with a ByteStore with space)

Field Summary

Fields

Modifier and Type	Field and Description
static @NotNull Bytes<?>	NO_BYTES
static BytesStore	NO_BYTES_STORE
static long	NO_PAGE

Fields inherited from interface net.openhft.chronicle.bytes.RandomDataInput

charToString

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT, TMP

Method Summary

Modifier and Type	Method and Description
void	addReferenceChangeListener(net.openhft.chronicle.core.io.ReferenceChangeListener referenceChangeListener)
long	addressForRead(long offset) Retrieves the underlying memory address for reading.
default long	addressForRead(long offset, int buffer) Retrieves the underlying memory address for reading.
long	addressForWrite(long offset) Retrieves the underlying memory address for writing.
long	addressForWritePosition() Retrieves the underlying memory address for writing at the current write position.
default ByteOrder	byteOrder() Retrieves the byte order used by the buffer.
@NotNull Bytes<?>	bytesForRead() Returns a Bytes that wraps this ByteStore from the start to the realCapacity.
@NotNull Bytes<?>	bytesForWrite() Returns a Bytes that wraps this ByteStore from the start to the realCapacity.
long	capacity() Provides the maximum limit that can be set for the ByteStore.
boolean	compareAndSwapInt(long offset, int expected, int value) Perform a 32-bit CAS at a given offset.
boolean	compareAndSwapLong(long offset, long expected, long value) Perform a 64-bit CAS at a given offset.
@NotNull BytesStore	copy() Creates and returns a copy of this BytesStore.
long	copyTo(@NotNull BytesStore store) Returns the number of bytes that were copied from this BytesStore to a destination BytesStore.
boolean	equalBytes(@NotNull BytesStore bytesStore, long length) Returns if a portion of a specified BytesStore matches this BytesStore.
boolean	equals(Object obj)
int	hashCode()
boolean	inside(long offset) Returns if a specified offset is inside this BytesStore limits.
boolean	inside(long offset, long bufferSize) Returns if a number of bytes starting from an offset are inside this ByteStore limits.
byte[]	internalNumberBuffer()
boolean	isDirectMemory() Checks if this BytesStore uses direct memory.
boolean	isImmutableEmptyByteStore() Returns if this ByteStore is an immutable empty ByteStore or if it is backed by an immutable empty ByteStore.
default long	lengthWritten(long startPosition) Calculates the length of data written from the given start position.
void	move(long from, long to, long length) Moves a sequence of bytes within this BytesStore from the source to destination index.
void	nativeRead(long position, long address, long size) Expert-level method for transferring data from this byte source to native memory.
void	nativeWrite(long address, long position, long size) Expert-level method that copies data directly from native memory into this BytesStore.
static <T,B extends BytesStore<B,T>> @NotNull BytesStore<B,T>	noBytesStore()
int	peekUnsignedByte(long offset) Reads an unsigned byte value from a specific offset.
byte	readByte(long offset) Reads a byte value from a specific offset.
double	readDouble(long offset) Reads a 64-bit floating point value from a specified offset.
float	readFloat(long offset) Reads a 32-bit floating point value from a specified offset.
int	readInt(long offset) Reads a 32-bit integer value from a specific offset.
default long	readLimit() If the resource is closed, the returned value is unspecified.
long	readLong(long offset) Reads a 64-bit long value from a specific offset.
default long	readPosition() Returns the read position.
default long	readRemaining() Calculates the number of bytes remaining that can be read from the current read position.
short	readShort(long offset) Reads a short value from a specific offset.
byte	readVolatileByte(long offset) Reads a volatile 8-bit byte value from a specified offset.
int	readVolatileInt(long offset) Reads a volatile 32-bit integer value from a specified offset.
long	readVolatileLong(long offset) Reads a volatile 64-bit long value from a specified offset.
short	readVolatileShort(long offset) Reads a volatile 16-bit short value from a specified offset.
default long	realReadRemaining() Calculates the number of bytes that can be safely read directly.
default long	realWriteRemaining() Calculates the number of bytes remaining that can be written from the current write position with resizing.
int	refCount()
void	release(net.openhft.chronicle.core.io.ReferenceOwner owner)
void	releaseLast(net.openhft.chronicle.core.io.ReferenceOwner id)
void	removeReferenceChangeListener(net.openhft.chronicle.core.io.ReferenceChangeListener referenceChangeListener)
void	reserve(net.openhft.chronicle.core.io.ReferenceOwner owner)
boolean	reservedBy(net.openhft.chronicle.core.io.ReferenceOwner owner)
boolean	sharedMemory() Checks if the Bytes use shared memory.
default long	start()
void	testAndSetInt(long offset, int expected, int value) Tests if the current value at the specified offset equals the expected value and, if so, sets it to the provided value.
String	toString()
boolean	tryReserve(net.openhft.chronicle.core.io.ReferenceOwner owner)
Void	underlyingObject()
@NotNull RandomDataOutput	write(long offsetInRDO, byte[] byteArray, int offset, int length) Copies the provided byteArray to this Bytes object starting at writeOffset taking content starting at readOffset but copying at most length bytes.
void	write(long offsetInRDO, @NotNull ByteBuffer bytes, int offset, int length) Copies a segment from the provided ByteBuffer into this data output.
@NotNull RandomDataOutput	write(long writeOffset, @NotNull RandomDataInput bytes, long readOffset, long length) Copies a segment from the provided RandomDataInput into this data output.
long	write8bit(long position, @NotNull BytesStore bs) Writes a BytesStore instance to this RandomDataOutput at the given position.
long	write8bit(long position, @NotNull String s, int start, int length) Writes a portion of a string to this RandomDataOutput at the given position.
@NotNull RandomDataOutput	writeByte(long offset, byte i8) Writes a byte at the specified non-negative offset.
@NotNull RandomDataOutput	writeDouble(long offset, double d) Writes a double-precision floating-point value at the specified non-negative offset.
@NotNull RandomDataOutput	writeFloat(long offset, float d) Writes a single-precision floating-point value at the specified non-negative offset.
@NotNull RandomDataOutput	writeInt(long offset, int i) Writes an integer value at the specified non-negative offset.
default long	writeLimit() Retrieves the maximum writable position within the buffer.
@NotNull RandomDataOutput	writeLong(long offset, long i) Writes a long integer value at the specified non-negative offset.
@NotNull RandomDataOutput	writeOrderedInt(long offset, int i) Performs a non-blocking write operation with a memory barrier to ensure order of stores.
@NotNull RandomDataOutput	writeOrderedLong(long offset, long i) Performs a non-blocking write operation with a memory barrier to ensure order of stores.
default long	writePosition() Returns the write position.
default long	writeRemaining() Calculates the number of bytes remaining that can be written from the current write position.
@NotNull RandomDataOutput	writeShort(long offset, short i) Writes a short integer at the specified non-negative offset.
@NotNull RandomDataOutput	writeVolatileByte(long offset, byte i8) Writes a volatile byte at the specified non-negative offset.
@NotNull RandomDataOutput	writeVolatileInt(long offset, int i32) Writes a volatile integer at the specified non-negative offset.
@NotNull RandomDataOutput	writeVolatileLong(long offset, long i64) Writes a volatile long integer at the specified non-negative offset.
@NotNull RandomDataOutput	writeVolatileShort(long offset, short i16) Writes a volatile short at the specified non-negative offset.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.openhft.chronicle.bytes.BytesStore

addAndGetDouble, addAndGetDoubleNotAtomic, addAndGetFloat, addAndGetFloatNotAtomic, addAndGetInt, addAndGetIntNotAtomic, addAndGetLong, addAndGetShortNotAtomic, addAndGetUnsignedByteNotAtomic, byteCheckSum, byteCheckSum, bytesStore, charAt, cipher, cipher, compareAndSwapDouble, compareAndSwapFloat, contentEquals, copyTo, elasticByteBuffer, empty, endsWith, follow, forFields, from, from, from, hash, isClear, isEmpty, isEqual, lazyNativeBytesStoreWithFixedCapacity, length, nativePointer, nativeStore, nativeStoreFrom, nativeStoreWithFixedCapacity, readWrite, realCapacity, safeLimit, startsWith, startsWith, subSequence, to8bitString, toDebugString, toDebugString, wrap, wrap, wrap, writeMaxInt, writeMaxLong, zeroOut

Methods inherited from interface net.openhft.chronicle.bytes.RandomDataInput

canReadDirect, canReadDirect, compareUtf8, copyTo, copyTo, createCharToString, fastHash, findByte, parseLong, peekVolatileInt, printable, read, readBoolean, readIncompleteLong, readUnsignedByte, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8Limited, readUtf8Limited, readVolatileDouble, readVolatileFloat, subBytes, toByteArray, toTemporaryDirectByteBuffer

Methods inherited from interface net.openhft.chronicle.bytes.RandomDataOutput

append, append, appendAndReturnLength, write, write, writeBoolean, writeByte, writeInt24, writeOrderedDouble, writeOrderedFloat, writeUnsignedByte, writeUnsignedInt, writeUnsignedShort, writeUtf8, writeUtf8Limited, writeVolatileDouble, writeVolatileFloat

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceCounted

releaseLast, reserveTransfer

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

referenceId, referenceName, temporary

Methods inherited from interface java.lang.CharSequence

chars, codePoints

Field Detail

NO_BYTES_STORE

public static final BytesStore NO_BYTES_STORE

NO_PAGE

public static final long NO_PAGE

NO_BYTES

@NotNull
public static final @NotNull Bytes<?> NO_BYTES

Method Detail

noBytesStore

@NotNull
public static <T,B extends BytesStore<B,T>> @NotNull BytesStore<B,T> noBytesStore()

reserve

public void reserve(net.openhft.chronicle.core.io.ReferenceOwner owner)
             throws IllegalStateException

Specified by:

reserve in interface net.openhft.chronicle.core.io.ReferenceCounted

Throws:

IllegalStateException

release

public void release(net.openhft.chronicle.core.io.ReferenceOwner owner)
             throws IllegalStateException

Specified by:

release in interface net.openhft.chronicle.core.io.ReferenceCounted

Throws:

IllegalStateException

releaseLast

public void releaseLast(net.openhft.chronicle.core.io.ReferenceOwner id)
                 throws IllegalStateException

Specified by:

releaseLast in interface net.openhft.chronicle.core.io.ReferenceCounted

Throws:

IllegalStateException

refCount

public int refCount()

Specified by:

refCount in interface net.openhft.chronicle.core.io.ReferenceCounted

addReferenceChangeListener

public void addReferenceChangeListener(net.openhft.chronicle.core.io.ReferenceChangeListener referenceChangeListener)

Specified by:

addReferenceChangeListener in interface net.openhft.chronicle.core.io.ReferenceCounted

removeReferenceChangeListener

public void removeReferenceChangeListener(net.openhft.chronicle.core.io.ReferenceChangeListener referenceChangeListener)

Specified by:

removeReferenceChangeListener in interface net.openhft.chronicle.core.io.ReferenceCounted

tryReserve

public boolean tryReserve(net.openhft.chronicle.core.io.ReferenceOwner owner)

Specified by:

tryReserve in interface net.openhft.chronicle.core.io.ReferenceCounted

reservedBy

public boolean reservedBy(net.openhft.chronicle.core.io.ReferenceOwner owner)

Specified by:

reservedBy in interface net.openhft.chronicle.core.io.ReferenceCounted

writeByte

@NotNull
public @NotNull RandomDataOutput writeByte(long offset,
                                                    byte i8)

Description copied from interface: RandomDataOutput

Writes a byte at the specified non-negative offset.

Specified by:

writeByte in interface RandomDataOutput

Parameters:

offset - The non-negative position within the data stream to write the byte to.

i8 - The byte value to write.

Returns:

Reference to the current instance, allowing for method chaining.

writeShort

@NotNull
public @NotNull RandomDataOutput writeShort(long offset,
                                                     short i)

Description copied from interface: RandomDataOutput

Writes a short integer at the specified non-negative offset.

Specified by:

writeShort in interface RandomDataOutput

Parameters:

offset - The non-negative position within the data stream to write the short integer to.

i - The short integer value to write.

Returns:

Reference to the current instance, allowing for method chaining.

writeInt

@NotNull
public @NotNull RandomDataOutput writeInt(long offset,
                                                   int i)

Description copied from interface: RandomDataOutput

Writes an integer value at the specified non-negative offset.

Specified by:

writeInt in interface RandomDataOutput

Parameters:

offset - The non-negative position within the data stream to write the integer to.

i - The integer value to write.

Returns:

Reference to the current instance, allowing for method chaining.

writeOrderedInt

@NotNull
public @NotNull RandomDataOutput writeOrderedInt(long offset,
                                                          int i)

Description copied from interface: RandomDataOutput

Performs a non-blocking write operation with a memory barrier to ensure order of stores. Writes an integer at the specified non-negative offset.

Specified by:

writeOrderedInt in interface RandomDataOutput

Parameters:

offset - The non-negative position within the data stream to write the integer to.

i - The integer value to write.

Returns:

Reference to the current instance, allowing for method chaining.

writeLong

@NotNull
public @NotNull RandomDataOutput writeLong(long offset,
                                                    long i)

Description copied from interface: RandomDataOutput

Writes a long integer value at the specified non-negative offset.

Specified by:

writeLong in interface RandomDataOutput

Parameters:

offset - The non-negative position within the data stream to write the long integer to.

i - The long integer value to write.

Returns:

Reference to the current instance, allowing for method chaining.

writeOrderedLong

@NotNull
public @NotNull RandomDataOutput writeOrderedLong(long offset,
                                                           long i)

Description copied from interface: RandomDataOutput

Performs a non-blocking write operation with a memory barrier to ensure order of stores. Writes a long integer at the specified non-negative offset.

Specified by:

writeOrderedLong in interface RandomDataOutput

Parameters:

offset - The non-negative position within the data stream to write the long integer to.

i - The long integer value to write.

Returns:

Reference to the current instance, allowing for method chaining.

writeFloat

@NotNull
public @NotNull RandomDataOutput writeFloat(long offset,
                                                     float d)

Description copied from interface: RandomDataOutput

Writes a single-precision floating-point value at the specified non-negative offset.

Specified by:

writeFloat in interface RandomDataOutput

Parameters:

offset - The non-negative position within the data stream to write the float to.

d - The float value to write.

Returns:

Reference to the current instance, allowing for method chaining.

writeDouble

@NotNull
public @NotNull RandomDataOutput writeDouble(long offset,
                                                      double d)

Description copied from interface: RandomDataOutput

Writes a double-precision floating-point value at the specified non-negative offset.

Specified by:

writeDouble in interface RandomDataOutput

Parameters:

offset - The non-negative position within the data stream to write the double to.

d - The double value to write.

Returns:

Reference to the current instance, allowing for method chaining.

writeVolatileByte

@NotNull
public @NotNull RandomDataOutput writeVolatileByte(long offset,
                                                            byte i8)

Description copied from interface: RandomDataOutput

Writes a volatile byte at the specified non-negative offset. The write is volatile, ensuring it is not cached and instantly visible to all threads.

Specified by:

writeVolatileByte in interface RandomDataOutput

Parameters:

offset - The non-negative position within the data stream to write the byte to.

i8 - The byte value to write.

Returns:

Reference to the current instance, allowing for method chaining.

writeVolatileShort

@NotNull
public @NotNull RandomDataOutput writeVolatileShort(long offset,
                                                             short i16)

Description copied from interface: RandomDataOutput

Writes a volatile short at the specified non-negative offset. The write is volatile, ensuring it is not cached and instantly visible to all threads.

Specified by:

writeVolatileShort in interface RandomDataOutput

Parameters:

offset - The non-negative position within the data stream to write the short to.

i16 - The short value to write.

Returns:

Reference to the current instance, allowing for method chaining.

writeVolatileInt

@NotNull
public @NotNull RandomDataOutput writeVolatileInt(long offset,
                                                           int i32)

Description copied from interface: RandomDataOutput

Writes a volatile integer at the specified non-negative offset. The write is volatile, ensuring it is not cached and instantly visible to all threads.

Specified by:

writeVolatileInt in interface RandomDataOutput

Parameters:

offset - The non-negative position within the data stream to write the integer to.

i32 - The integer value to write.

Returns:

Reference to the current instance, allowing for method chaining.

writeVolatileLong

@NotNull
public @NotNull RandomDataOutput writeVolatileLong(long offset,
                                                            long i64)

Description copied from interface: RandomDataOutput

Writes a volatile long integer at the specified non-negative offset. The write is volatile, ensuring it is not cached and instantly visible to all threads.

Specified by:

writeVolatileLong in interface RandomDataOutput

Parameters:

offset - The non-negative position within the data stream to write the long integer to.

i64 - The long integer value to write.

Returns:

Reference to the current instance, allowing for method chaining.

write

@NotNull
public @NotNull RandomDataOutput write(long offsetInRDO,
                                                byte[] byteArray,
                                                int offset,
                                                int length)

Description copied from interface: RandomDataOutput

Copies the provided byteArray to this Bytes object starting at writeOffset taking content starting at readOffset but copying at most length bytes.

Does not update cursors e.g. writePosition()

Specified by:

write in interface RandomDataOutput

Parameters:

offsetInRDO - the non-negative offset within the data output where the segment should be written.

byteArray - the byte array containing the segment to be written.

offset - the non-negative offset within the byte array where the segment begins.

length - the non-negative length of the segment.

Returns:

a reference to this instance.

write

public void write(long offsetInRDO,
                  @NotNull
                  @NotNull ByteBuffer bytes,
                  int offset,
                  int length)

Description copied from interface: RandomDataOutput

Copies a segment from the provided ByteBuffer into this data output.

Does not update cursors e.g. writePosition()

Specified by:

write in interface RandomDataOutput

Parameters:

offsetInRDO - the non-negative offset within the data output where the segment should be written.

bytes - the ByteBuffer containing the segment to be written.

offset - the non-negative offset within the ByteBuffer where the segment begins.

length - the non-negative length of the segment.

write

@NotNull
public @NotNull RandomDataOutput write(long writeOffset,
                                                @NotNull
                                                @NotNull RandomDataInput bytes,
                                                long readOffset,
                                                long length)

Description copied from interface: RandomDataOutput

Copies a segment from the provided RandomDataInput into this data output. This operation does not update the writePosition() of this output nor the RandomCommon.readPosition() of the input.

Specified by:

write in interface RandomDataOutput

Parameters:

writeOffset - the non-negative offset within this data output where the segment should be written.

bytes - the RandomDataInput source containing the segment to be written.

readOffset - the non-negative offset within the source where the segment begins.

length - the non-negative length of the segment.

Returns:

a reference to this instance.

readByte

public byte readByte(long offset)

Description copied from interface: RandomDataInput

Reads a byte value from a specific offset.

Specified by:

readByte in interface RandomDataInput

Parameters:

offset - the location from where the byte value is read.

Returns:

the read byte value.

peekUnsignedByte

public int peekUnsignedByte(long offset)

Description copied from interface: RandomDataInput

Reads an unsigned byte value from a specific offset. Returns -1 if the byte read is at the end of the byte source. The value is returned as an int in order to represent the unsigned byte as a positive value.

Specified by:

peekUnsignedByte in interface RandomDataInput

Parameters:

offset - the location from where the unsigned byte value is read.

Returns:

the unsigned byte value interpreted as a positive int or -1.

readShort

public short readShort(long offset)

Description copied from interface: RandomDataInput

Reads a short value from a specific offset.

Specified by:

readShort in interface RandomDataInput

Parameters:

offset - the location from where the short value is read.

Returns:

the read short value.

readInt

public int readInt(long offset)

Description copied from interface: RandomDataInput

Reads a 32-bit integer value from a specific offset.

Specified by:

readInt in interface RandomDataInput

Parameters:

offset - the location from where the 32-bit integer value is read.

Returns:

the read int value.

readLong

public long readLong(long offset)

Description copied from interface: RandomDataInput

Reads a 64-bit long value from a specific offset.

Specified by:

readLong in interface RandomDataInput

Parameters:

offset - the location from where the long value is read.

Returns:

the read long value.

readFloat

public float readFloat(long offset)

Description copied from interface: RandomDataInput

Reads a 32-bit floating point value from a specified offset.

Specified by:

readFloat in interface RandomDataInput

Parameters:

offset - the location from where the float value is read.

Returns:

the read float value.

readDouble

public double readDouble(long offset)

Description copied from interface: RandomDataInput

Reads a 64-bit floating point value from a specified offset.

Specified by:

readDouble in interface RandomDataInput

Parameters:

offset - the location from where the double value is read.

Returns:

the read double value.

readVolatileByte

public byte readVolatileByte(long offset)
                      throws BufferUnderflowException

Description copied from interface: RandomDataInput

Reads a volatile 8-bit byte value from a specified offset. This operation includes a memory barrier that prevents reordering of instructions before and after it.

Specified by:

readVolatileByte in interface RandomDataInput

Parameters:

offset - the location from where the byte value is read.

Returns:

the volatile byte value.

Throws:

BufferUnderflowException - if the offset is beyond the limits of the byte source.

readVolatileShort

public short readVolatileShort(long offset)
                        throws BufferUnderflowException

Description copied from interface: RandomDataInput

Reads a volatile 16-bit short value from a specified offset. This operation includes a memory barrier that prevents reordering of instructions before and after it.

Specified by:

readVolatileShort in interface RandomDataInput

Parameters:

offset - the location from where the short value is read.

Returns:

the volatile short value.

Throws:

BufferUnderflowException - if the offset is beyond the limits of the byte source.

readVolatileInt

public int readVolatileInt(long offset)
                    throws BufferUnderflowException

Description copied from interface: RandomDataInput

Reads a volatile 32-bit integer value from a specified offset. This operation includes a memory barrier that prevents reordering of instructions before and after it.

Specified by:

readVolatileInt in interface RandomDataInput

Parameters:

offset - the location from where the int value is read.

Returns:

the volatile int value.

Throws:

BufferUnderflowException - if the offset is beyond the limits of the byte source.

readVolatileLong

public long readVolatileLong(long offset)
                      throws BufferUnderflowException

Description copied from interface: RandomDataInput

Reads a volatile 64-bit long value from a specified offset. This operation includes a memory barrier that prevents reordering of instructions before and after it.

Specified by:

readVolatileLong in interface RandomDataInput

Parameters:

offset - the location from where the long value is read.

Returns:

the volatile long value.

Throws:

BufferUnderflowException - if the offset is beyond the limits of the byte source.

isDirectMemory

public boolean isDirectMemory()

Description copied from interface: BytesStore

Checks if this BytesStore uses direct memory.

Specified by:

isDirectMemory in interface BytesStore

Returns:

true if it uses direct memory, false otherwise

copy

@NotNull
public @NotNull BytesStore copy()

Description copied from interface: BytesStore

Creates and returns a copy of this BytesStore.

Specified by:

copy in interface BytesStore

Returns:

a new instance of BytesStore that is a copy of this BytesStore

bytesForRead

@NotNull
public @NotNull Bytes<?> bytesForRead()
                                        throws IllegalStateException

Description copied from interface: BytesStore

Returns a Bytes that wraps this ByteStore from the start to the realCapacity.

The returned Bytes is not elastic and can be both read and written using cursors.

Specified by:

bytesForRead in interface BytesStore

Returns:

a Bytes that wraps this ByteStore

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - if this Bytes has been released

IllegalStateException - if this Bytes is in an unusable state

capacity

public long capacity()

Description copied from interface: BytesStore

Provides the maximum limit that can be set for the ByteStore.

Specified by:

capacity in interface BytesStore

Returns:

the maximum capacity of the ByteStore

underlyingObject

public Void underlyingObject()

Specified by:

underlyingObject in interface BytesStore

Returns:

the underlying object being wrapped, if there is one, or null if not.

inside

public boolean inside(long offset)

Description copied from interface: BytesStore

Returns if a specified offset is inside this BytesStore limits.

Use this test to determine if an offset is considered safe for reading from. Note that it checks we are inside the BytesStore limits *without* including the overlap

Specified by:

inside in interface BytesStore

Parameters:

offset - the specified offset to check

Returns:

true if offset is safe

inside

public boolean inside(long offset,
                      long bufferSize)

Description copied from interface: BytesStore

Returns if a number of bytes starting from an offset are inside this ByteStore limits.

Specified by:

inside in interface BytesStore

Parameters:

offset - the starting index to check

bufferSize - the number of bytes to be read/written

Returns:

true if the bytes between the offset and offset+buffer are inside the BytesStore

copyTo

public long copyTo(@NotNull
                   @NotNull BytesStore store)

Description copied from interface: BytesStore

Returns the number of bytes that were copied from this BytesStore to a destination BytesStore.

Copies the data to another BytesStore as long as space is available in the destination BytesStore.

Specified by:

copyTo in interface BytesStore

Parameters:

store - the BytesStore to copy to

Returns:

how many bytes were copied

nativeWrite

public void nativeWrite(long address,
                        long position,
                        long size)

Description copied from interface: RandomDataOutput

Expert-level method that copies data directly from native memory into this BytesStore.

Specified by:

nativeWrite in interface RandomDataOutput

Parameters:

address - the address in the native memory from where data should be copied.

position - the position in the BytesStore where data should be written.

size - the size of the data, in bytes, to be copied from the native memory.

write8bit

public long write8bit(long position,
                      @NotNull
                      @NotNull BytesStore bs)

Description copied from interface: RandomDataOutput

Writes a BytesStore instance to this RandomDataOutput at the given position. The length of the BytesStore content is encoded using a stop bit encoding scheme.

Specified by:

write8bit in interface RandomDataOutput

Parameters:

position - the position at which the BytesStore content should be written.

bs - the BytesStore instance to write.

Returns:

the offset after the BytesStore has been written.

write8bit

public long write8bit(long position,
                      @NotNull
                      @NotNull String s,
                      int start,
                      int length)

Description copied from interface: RandomDataOutput

Writes a portion of a string to this RandomDataOutput at the given position. The length of the string is encoded using a stop bit encoding scheme.

Specified by:

write8bit in interface RandomDataOutput

Parameters:

position - the position at which the string should be written.

s - the string to write.

start - the starting index from where characters are to be taken from the string.

length - the number of characters to be written from the string.

Returns:

the offset after the string has been written.

nativeRead

public void nativeRead(long position,
                       long address,
                       long size)

Description copied from interface: RandomDataInput

Expert-level method for transferring data from this byte source to native memory.

Specified by:

nativeRead in interface RandomDataInput

Parameters:

position - the starting point within the byte source from which data is copied.

address - the destination address in native memory.

size - the number of bytes to transfer.

compareAndSwapInt

public boolean compareAndSwapInt(long offset,
                                 int expected,
                                 int value)

Description copied from interface: RandomDataInput

Perform a 32-bit CAS at a given offset.

Specified by:

compareAndSwapInt in interface BytesStore

Specified by:

compareAndSwapInt in interface RandomDataInput

Specified by:

compareAndSwapInt in interface RandomDataOutput

Parameters:

offset - to perform CAS

expected - value

value - to set

Returns:

true, if successful.

testAndSetInt

public void testAndSetInt(long offset,
                          int expected,
                          int value)

Description copied from interface: RandomDataOutput

Tests if the current value at the specified offset equals the expected value and, if so, sets it to the provided value.

Specified by:

testAndSetInt in interface RandomDataInput

Specified by:

testAndSetInt in interface RandomDataOutput

Parameters:

offset - the offset at which to perform the test-and-set operation.

expected - the expected current value.

value - the new value to set if the current value matches the expected value.

compareAndSwapLong

public boolean compareAndSwapLong(long offset,
                                  long expected,
                                  long value)

Description copied from interface: RandomDataInput

Perform a 64-bit CAS at a given offset.

Specified by:

compareAndSwapLong in interface BytesStore

Specified by:

compareAndSwapLong in interface RandomDataInput

Specified by:

compareAndSwapLong in interface RandomDataOutput

Parameters:

offset - to perform CAS

expected - value

value - to set

Returns:

true, if successful.

internalNumberBuffer

public byte[] internalNumberBuffer()

Specified by:

internalNumberBuffer in interface RandomDataOutput

equalBytes

public boolean equalBytes(@NotNull
                          @NotNull BytesStore bytesStore,
                          long length)

Description copied from interface: BytesStore

Returns if a portion of a specified BytesStore matches this BytesStore.

Specified by:

equalBytes in interface BytesStore

Parameters:

bytesStore - the BytesStore to match against

length - the length to match

Returns:

true if the bytes up to min(length, this.length(), bytesStore.length()) matched.

move

public void move(long from,
                 long to,
                 long length)

Description copied from interface: BytesStore

Moves a sequence of bytes within this BytesStore from the source to destination index.

Specified by:

move in interface BytesStore

Parameters:

from - the index of the first byte to be moved

to - the index where the first byte should be moved to

length - the number of bytes to be moved

addressForRead

public long addressForRead(long offset)
                    throws BufferUnderflowException

Retrieves the underlying memory address for reading. This is for expert users only.

Parameters:

offset - within this buffer. addressForRead(start()) is the actual addressForRead of the first byte.

Returns:

the underlying addressForRead of the buffer

Throws:

BufferUnderflowException - if the offset is before the start() or the after the capacity()

addressForWrite

public long addressForWrite(long offset)
                     throws BufferOverflowException

Retrieves the underlying memory address for writing. This is for expert users only.

Parameters:

offset - within this buffer. addressForRead(start()) is the actual addressForRead of the first byte.

Returns:

the underlying addressForRead of the buffer

Throws:

BufferOverflowException - if the offset is before the start() or the after the capacity()

addressForWritePosition

public long addressForWritePosition()
                             throws UnsupportedOperationException,
                                    BufferOverflowException

Retrieves the underlying memory address for writing at the current write position. This is for expert users only.

Returns:

The underlying memory address for writing at the current write position.

Throws:

UnsupportedOperationException - if the underlying buffer is on the heap.

BufferOverflowException - if the current write position is before the start or after the capacity.

bytesForWrite

@NotNull
public @NotNull Bytes<?> bytesForWrite()

Description copied from interface: BytesStore

Returns a Bytes that wraps this ByteStore from the start to the realCapacity.

The returned Bytes is not elastic and can be both read and written using cursors.

Specified by:

bytesForWrite in interface BytesStore

Returns:

a Bytes that wraps this BytesStore

sharedMemory

public boolean sharedMemory()

Checks if the Bytes use shared memory.

Returns:

True if the Bytes use shared memory, false otherwise.

isImmutableEmptyByteStore

public boolean isImmutableEmptyByteStore()

Description copied from interface: BytesStore

Returns if this ByteStore is an immutable empty ByteStore or if it is backed by an immutable empty ByteStore.

Specified by:

isImmutableEmptyByteStore in interface BytesStore

Returns:

if immutable empty or backed by such

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

start

public long start()

Returns:

The smallest position allowed in this buffer.

readPosition

public long readPosition()

Returns the read position.

The read position is start() <= readPosition() && readPosition() <= readLimit() && readPosition < safeLimit()

If the resource is closed, the returned value is unspecified.

Returns:

position to read from.

writePosition

public long writePosition()

Returns the write position.

The write position is readPosition() <= writePosition() && writePosition() <= writeLimit()

If the resource is closed, the returned value is unspecified.

Returns:

position to write to.

lengthWritten

public long lengthWritten(long startPosition)

Calculates the length of data written from the given start position.

Typically this calculates the difference however for HexDumpBytes it's not as simple.

If the resource is closed, the returned value is unspecified.

Parameters:

startPosition - The position to calculate the length from.

Returns:

The length of data written from the given start position.

readRemaining

public long readRemaining()

Calculates the number of bytes remaining that can be read from the current read position.

If the resource is closed, the returned value is unspecified.

Returns:

The number of bytes that can still be read.

realReadRemaining

public long realReadRemaining()

Calculates the number of bytes that can be safely read directly.

If the resource is closed, the returned value is unspecified.

Returns:

The number of bytes that can be safely read directly.

writeRemaining

public long writeRemaining()

Calculates the number of bytes remaining that can be written from the current write position.

If the resource is closed, the returned value is unspecified.

Returns:

The number of bytes that can still be written.

realWriteRemaining

public long realWriteRemaining()

Calculates the number of bytes remaining that can be written from the current write position with resizing.

If the resource is closed, the returned value is unspecified.

Returns:

The number of bytes that can still be written with resizing.

readLimit

public long readLimit()

If the resource is closed, the returned value is unspecified.

Returns:

the highest offset or position allowed for this buffer.

writeLimit

public long writeLimit()

Retrieves the maximum writable position within the buffer.

If the resource is closed, the returned value is unspecified.

Returns:

the write limit

addressForRead

public long addressForRead(long offset,
                           int buffer)
                    throws UnsupportedOperationException,
                           BufferUnderflowException,
                           IllegalStateException

Retrieves the underlying memory address for reading. This is for expert users only.

Parameters:

offset - The offset within this buffer.

buffer - The buffer index.

Returns:

The underlying memory address for reading at the specified offset.

Throws:

UnsupportedOperationException - if the underlying buffer is on the heap.

BufferUnderflowException - if the offset is before the start or after the capacity.

IllegalStateException - if the buffer has been closed.

byteOrder

public ByteOrder byteOrder()

Retrieves the byte order used by the buffer.

Returns:

The byte order used by the buffer.