BytesStore (OpenHFT/Chronicle Bytes 2.25ea0 API)

Type Parameters:

B - The BytesStore type

U - The underlying data type the BytesStore manages

All Superinterfaces:

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

All Known Subinterfaces:

Bytes

All Known Implementing Classes:

AbstractBytes, AbstractBytesStore, ChunkedMappedBytes, CommonMappedBytes, EmbeddedBytes, GuardedNativeBytes, HeapBytesStore, HexDumpBytes, MappedBytes, MappedBytesStore, NativeBytes, NativeBytesStore, NoBytesStore, OnHeapBytes, PointerBytesStore, SingleMappedBytes, SubBytes, UncheckedBytes, UncheckedNativeBytes, VanillaBytes
```
public interface BytesStore,U>
extends RandomDataInput, RandomDataOutput, net.openhft.chronicle.core.io.ReferenceCounted, CharSequence
```
This interface represents an immutable reference to a segment of bytes with a fixed range. It can be safely shared across threads given that the data it references is accessed in a thread-safe manner. Direct access is only possible within the allocated capacity of the BytesStore.

Field Summary
- Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner
  INIT, TMP

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default double`	`addAndGetDouble(long offset, double adding)` Similar to `addAndGetInt(long, int)` but operates on a double value.
`default double`	`addAndGetDoubleNotAtomic(long offset, double adding)` Perform a not atomic add and get operation for a float value.
`default float`	`addAndGetFloat(long offset, float adding)` Similar to `addAndGetInt(long, int)` but operates on a float value.
`default float`	`addAndGetFloatNotAtomic(long offset, float adding)` Perform a not atomic add and get operation for a float value.
`default int`	`addAndGetInt(long offset, int adding)` Adds an integer to the current integer value at the specified offset and returns the result.
`default int`	`addAndGetIntNotAtomic(long offset, int adding)` Perform a not atomic add and get operation for an int value.
`default long`	`addAndGetLong(long offset, long adding)` Similar to `addAndGetInt(long, int)` but operates on a long value.
`default short`	`addAndGetShortNotAtomic(long offset, short adding)` Perform a not atomic add and get operation for a short value.
`default int`	`addAndGetUnsignedByteNotAtomic(long offset, int adding)` Perform a not atomic add and get operation for an unsigned byte value.
`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 int`	`byteCheckSum()` Returns the bytes sum of the readable bytes in this BytesStore.
`default int`	`byteCheckSum(long start, long end)` Returns the bytes sum between the specified indexes; start (inclusive) and end (exclusive).
`default ByteOrder`	`byteOrder()` Retrieves the byte order used by the buffer.
`default @NotNull Bytes<U>`	`bytesForRead()` Returns a Bytes that wraps this ByteStore from the `start` to the `realCapacity`.
`default @NotNull Bytes<U>`	`bytesForWrite()` Returns a Bytes that wraps this ByteStore from the `start` to the `realCapacity`.
`default @Nullable BytesStore`	`bytesStore()`
`long`	`capacity()` Provides the maximum limit that can be set for the ByteStore.
`default char`	`charAt(int index)` Assume ISO-8859-1 encoding, subclasses can override this.
`default void`	`cipher(@NotNull Cipher cipher, @NotNull Bytes<?> outBytes)` Convenience method to perform the cipher operation using thread local ByteBuffers for temporary buffers.
`default void`	`cipher(@NotNull Cipher cipher, @NotNull Bytes<?> outBytes, @NotNull ByteBuffer using1, @NotNull ByteBuffer using2)` Encrypts or decrypts this BytesStore using the provided Cipher and writes the result to the outBytes.
`default boolean`	`compareAndSwapDouble(long offset, double expected, double value)` Similar to `compareAndSwapFloat(long, float, float)` but operates on a double value.
`default boolean`	`compareAndSwapFloat(long offset, float expected, float value)` Performs a compare-and-swap operation on the specified float value at the given offset.
`default boolean`	`contentEquals(@Nullable BytesStore bytesStore)` Returns if the content of this BytesStore is the same as the content of a specified BytesStore.
`BytesStore<B,U>`	`copy()` Creates and returns a copy of this BytesStore.
`default long`	`copyTo(@NotNull BytesStore store)` Returns the number of bytes that were copied from this BytesStore to a destination BytesStore.
`default void`	`copyTo(@NotNull OutputStream out)` Copies the bytes in the BytesStore to an OutputStream object.
`static BytesStore<?,ByteBuffer>`	`elasticByteBuffer(int size, long maxSize)` Creates a flexible ByteBuffer instance that resides in native memory.
`static BytesStore`	`empty()` Provides an empty, fixed-sized and immutable BytesStore.
`default boolean`	`endsWith(char c)` Returns if the BytesStore ends with a specified character.
`default boolean`	`equalBytes(@NotNull BytesStore bytesStore, long length)` Returns if a portion of a specified BytesStore matches this BytesStore.
`static @NotNull BytesStore<?,ByteBuffer>`	`follow(@NotNull ByteBuffer bb)` Wraps a ByteBuffer which can be either on heap or off heap without taking ownership of that buffer.
`static <T> BytesStore<?,T>`	`forFields(Object o, String groupName, int padding)` Provides a BytesStore that allows access to a group of fields in a given object.
`static BytesStore`	`from(@NotNull BytesStore cs)` Returns a BytesStore using the bytes in another specified BytesStore.
`static BytesStore`	`from(@NotNull CharSequence cs)` Converts a CharSequence into a BytesStore.
`static BytesStore`	`from(@NotNull String cs)` Converts a String into a BytesStore.
`default long`	`hash(long length)` Computes a hash code for this ByteStore's content up to the specified length.
`default boolean`	`inside(long offset)` Returns if a specified offset is inside this BytesStore limits.
`default boolean`	`inside(long offset, long bufferSize)` Returns if a number of bytes starting from an offset are inside this ByteStore limits.
`default boolean`	`isClear()` Returns if the `readPosition` is at the `start` and the `writeLimit` is at the `end`.
`boolean`	`isDirectMemory()` Checks if this BytesStore uses direct memory.
`default boolean`	`isEmpty()`
`default boolean`	`isEqual(long start, long length, String s)` Returns if a specified portion of this BytesStore is equal to a specified String.
`static BytesStore<?,Void>`	`lazyNativeBytesStoreWithFixedCapacity(long capacity)` Creates a lazily initialized BytesStore instance with a fixed capacity that resides in native memory.
`default int`	`length()` This method is inherited from CharSequence so result should be the length of the contained chars sequence although it actually returns the number of underlying bytes.
`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.
`static @NotNull PointerBytesStore`	`nativePointer()` Creates a new PointerBytesStore that can be set to any address in memory.
`static BytesStore<?,Void>`	`nativeStore(long capacity)` This is an elastic native store.
`static BytesStore<?,Void>`	`nativeStoreFrom(byte[] bytes)` Creates and returns a new BytesStore that resides in native memory whereby the contents and size of the native memory is determined by the provided `bytes` array.
`static BytesStore<?,Void>`	`nativeStoreWithFixedCapacity(long capacity)` Creates a BytesStore instance with a fixed capacity that resides in native memory.
`default long`	`readLimit()` If the resource is closed, the returned value is unspecified.
`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.
`default boolean`	`readWrite()` Returns if this ByteStore can be both read from and written to.
`default long`	`realCapacity()` Returns the actual capacity of the ByteStore before any resizing occurs.
`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.
`default long`	`safeLimit()`
`boolean`	`sharedMemory()` Checks if the Bytes use shared memory.
`default long`	`start()`
`default boolean`	`startsWith(@Nullable BytesStore bytesStore)` Returns if the content of this BytesStore starts with bytes equal to the content of a specified BytesStore.
`default boolean`	`startsWith(char c)` Returns if the BytesStore starts with a specified character.
`default @NotNull CharSequence`	`subSequence(int start, int end)` This method constructs a new , memory storage type (heap or native) is preserved.
`default @NotNull String`	`to8bitString()` Returns the content of this BytesStore in 8bitString format.
`default @NotNull String`	`toDebugString()` By default the maximum length of data shown is 256 characters.
`default @NotNull String`	`toDebugString(long maxLength)` This is assumed to be used to print the contents on a best effort basis.
`U`	`underlyingObject()`
`static BytesStore<?,byte[]>`	`wrap(byte[] bytes)` Wraps a byte array into a BytesStore.
`static @NotNull BytesStore<?,ByteBuffer>`	`wrap(@NotNull ByteBuffer bb)` Wraps a ByteBuffer into a BytesStore.
`static @NotNull PointerBytesStore`	`wrap(long address, long length)` Creates a PointerBytesStore that wraps bytes starting from a specific address in memory.
`default long`	`writeLimit()` Retrieves the maximum writable position within the buffer.
`default void`	`writeMaxInt(long offset, int atLeast)` Writes an int value at a specified offset if the value is not smaller than the current value at that offset.
`default void`	`writeMaxLong(long offset, long atLeast)` Writes a long value at a specified offset if the value is not smaller than the current value at that offset.
`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.
`default B`	`zeroOut(long start, long end)` Fills the BytesStore with zeros.

Methods inherited from interface net.openhft.chronicle.bytes.RandomDataInput
canReadDirect, canReadDirect, compareUtf8, copyTo, copyTo, fastHash, findByte, nativeRead, parseLong, peekUnsignedByte, peekVolatileInt, printable, read, readBoolean, readByte, readDouble, readFloat, readIncompleteLong, readInt, readLong, readShort, readUnsignedByte, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8Limited, readUtf8Limited, readVolatileByte, readVolatileDouble, readVolatileFloat, readVolatileInt, readVolatileLong, readVolatileShort, subBytes, toByteArray, toTemporaryDirectByteBuffer

Methods inherited from interface net.openhft.chronicle.bytes.RandomDataOutput
append, append, appendAndReturnLength, compareAndSwapInt, compareAndSwapLong, nativeWrite, testAndSetInt, write, write, write, write, write, write8bit, write8bit, writeBoolean, writeByte, writeByte, writeDouble, writeFloat, writeInt, writeInt24, writeLong, writeOrderedDouble, writeOrderedFloat, writeOrderedInt, writeOrderedLong, writeShort, writeUnsignedByte, writeUnsignedInt, writeUnsignedShort, writeUtf8, writeUtf8Limited, writeVolatileByte, writeVolatileDouble, writeVolatileFloat, writeVolatileInt, writeVolatileLong, writeVolatileShort

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceCounted
addReferenceChangeListener, refCount, release, releaseLast, releaseLast, removeReferenceChangeListener, reserve, reserveTransfer, tryReserve

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceOwner
referenceId, referenceName, temporary

Methods inherited from interface java.lang.CharSequence
chars, codePoints, toString

- Method Detail
 - from
```
static BytesStore from(@NotNull
 @NotNull CharSequence cs)
 throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Converts a CharSequence into a BytesStore. The characters are encoded using ISO_8859_1.
 
 Parameters:
 
 cs - the CharSequence to be converted
 
 Returns:
 
 a BytesStore which contains the bytes from the CharSequence
 
 Throws:
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 - from
```
static BytesStore from(@NotNull
 @NotNull BytesStore cs)
 throws net.openhft.chronicle.core.io.ClosedIllegalStateException
```
 Returns a BytesStore using the bytes in another specified BytesStore.
 
 Parameters:
 
 cs - the source BytesStore
 
 Returns:
 
 a new BytesStore that is a copy of the source
 
 Throws:
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 - from
```
static BytesStore from(@NotNull
 @NotNull String cs)
```
 Converts a String into a BytesStore. The characters in the String are encoded using ISO_8859_1.
 
 Parameters:
 
 cs - the String to be converted
 
 Returns:
 
 a BytesStore which contains the bytes from the String
 - forFields
```
static <T> BytesStore<?,T> forFields(Object o,
 String groupName,
 int padding)
```
 Provides a BytesStore that allows access to a group of fields in a given object.
 
 Parameters:
 
 o - the object that contains the fields
 
 groupName - the group name of the fields
 
 padding - the padding to be used
 
 Returns:
 
 a BytesStore which points to the fields
 - wrap
```
static BytesStore<?,byte[]> wrap(byte[] bytes)
```
 Wraps a byte array into a BytesStore. There will be only one copy in memory.
 
 Parameters:
 
 bytes - the byte array to be wrapped
 
 Returns:
 
 a BytesStore that contains the bytes from the array
 - wrap
```
@NotNull
static @NotNull BytesStore<?,ByteBuffer> wrap(@NotNull
 @NotNull ByteBuffer bb)
```
 Wraps a ByteBuffer into a BytesStore. The ByteBuffer can be either on heap or off heap. When the resulting BytesStore is closed, the direct ByteBuffer will be deallocated and should not be used anymore.
 
 Parameters:
 
 bb - the ByteBuffer to be wrapped
 
 Returns:
 
 a BytesStore that contains the bytes from the ByteBuffer
 
 See Also:
 
 follow(ByteBuffer)
 - follow
```
@NotNull
static @NotNull BytesStore<?,ByteBuffer> follow(@NotNull
 @NotNull ByteBuffer bb)
```
 Wraps a ByteBuffer which can be either on heap or off heap without taking ownership of that buffer.
 When resulting BytesStore instance is closed, direct byteBuffer will not be deallocated so its life cycle should be tracked elsewhere.
 
 Parameters:
 
 bb - the ByteBuffer to follow
 
 Returns:
 
 a BytesStore that directly interfaces with the given ByteBuffer
 
 See Also:
 
 wrap(ByteBuffer)
 - nativeStore
```
static BytesStore<?,Void> nativeStore(long capacity)
```
 This is an elastic native store. Creates a flexible BytesStore instance that resides in native memory.
 
 Parameters:
 
 capacity - the initial capacity of the buffer
 
 Returns:
 
 a BytesStore with the provided capacity in native memory
 - nativeStoreWithFixedCapacity
```
static BytesStore<?,Void> nativeStoreWithFixedCapacity(long capacity)
```
 Creates a BytesStore instance with a fixed capacity that resides in native memory.
 
 Parameters:
 
 capacity - the fixed capacity of the buffer
 
 Returns:
 
 a BytesStore with the provided fixed capacity in native memory
 - lazyNativeBytesStoreWithFixedCapacity
```
static BytesStore<?,Void> lazyNativeBytesStoreWithFixedCapacity(long capacity)
```
 Creates a lazily initialized BytesStore instance with a fixed capacity that resides in native memory.
 
 Parameters:
 
 capacity - the fixed capacity of the buffer
 
 Returns:
 
 a BytesStore with the provided fixed capacity in native memory, initialized on demand
 - elasticByteBuffer
```
static BytesStore<?,ByteBuffer> elasticByteBuffer(int size,
 long maxSize)
```
 Creates a flexible ByteBuffer instance that resides in native memory.
 
 Parameters:
 
 size - the initial size of the ByteBuffer
 
 maxSize - the maximum allowable size of the ByteBuffer
 
 Returns:
 
 a ByteBuffer with the provided initial size and maximum size in native memory
 - nativeStoreFrom
```
static BytesStore<?,Void> nativeStoreFrom(byte[] bytes)
```
 Creates and returns a new BytesStore that resides in native memory whereby the contents and size of the native memory is determined by the provided bytes array.
 
 Parameters:
 
 bytes - the content to initialize the new ByteStore
 
 Returns:
 
 a new BytesStore that resides in native memory whereby the contents and size of the native memory is determined by the provided bytes array
 - nativePointer
```
@NotNull
static @NotNull PointerBytesStore nativePointer()
```
 Creates a new PointerBytesStore that can be set to any address in memory.
 
 Returns:
 
 a new, uninitialized PointerBytesStore
 - wrap
```
@NotNull
static @NotNull PointerBytesStore wrap(long address,
 long length)
```
 Creates a PointerBytesStore that wraps bytes starting from a specific address in memory.
 
 Parameters:
 
 address - the starting memory address for the PointerBytesStore
 
 length - the length of the memory segment to be wrapped by the PointerBytesStore
 
 Returns:
 
 a PointerBytesStore that wraps the specified memory segment
 - empty
```
static BytesStore empty()
```
 Provides an empty, fixed-sized and immutable BytesStore.
 
 Returns:
 
 an instance of an empty BytesStore
 - compareAndSwapFloat
```
default boolean compareAndSwapFloat(long offset,
 float expected,
 float value)
 throws BufferOverflowException,
 net.openhft.chronicle.core.io.ClosedIllegalStateException
```
 Performs a compare-and-swap operation on the specified float value at the given offset. If the current float value at the offset equals the expected value, it's replaced with the provided new value.
 
 Specified by:
 
 compareAndSwapFloat in interface RandomDataOutput>
 
 Parameters:
 
 offset - the position where the float value is stored
 
 expected - the expected current value
 
 value - the new value to be set if the current value equals the expected value
 
 Returns:
 
 true if the compare-and-swap was successful, false otherwise
 
 Throws:
 
 BufferOverflowException - If the offset is out of bounds
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 - compareAndSwapDouble
```
default boolean compareAndSwapDouble(long offset,
 double expected,
 double value)
 throws BufferOverflowException,
 net.openhft.chronicle.core.io.ClosedIllegalStateException
```
 Similar to compareAndSwapFloat(long, float, float) but operates on a double value.
 
 Specified by:
 
 compareAndSwapDouble in interface RandomDataOutput>
 
 Parameters:
 
 offset - the offset at which to perform the CAS operation.
 
 expected - the expected current value.
 
 value - the new value to set if the current value matches the expected value.
 
 Returns:
 
 true if the CAS operation was successful (the value was updated), false otherwise.
 
 Throws:
 
 BufferOverflowException - If the offset plus the size of a double exceeds the buffer's capacity.
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 - addAndGetInt
```
default int addAndGetInt(long offset,
 int adding)
 throws BufferUnderflowException,
 net.openhft.chronicle.core.io.ClosedIllegalStateException
```
 Adds an integer to the current integer value at the specified offset and returns the result.
 
 Specified by:
 
 addAndGetInt in interface RandomDataInput
 
 Specified by:
 
 addAndGetInt in interface RandomDataOutput>
 
 Parameters:
 
 offset - the position where the integer is stored
 
 adding - the integer to add
 
 Returns:
 
 the result of the addition
 
 Throws:
 
 BufferUnderflowException - If the offset is out of bounds
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 - addAndGetLong
```
default long addAndGetLong(long offset,
 long adding)
 throws BufferUnderflowException,
 net.openhft.chronicle.core.io.ClosedIllegalStateException
```
 Similar to addAndGetInt(long, int) but operates on a long value.
 
 Specified by:
 
 addAndGetLong in interface RandomDataInput
 
 Specified by:
 
 addAndGetLong in interface RandomDataOutput>
 
 Parameters:
 
 offset - to add and get
 
 adding - value to add, can be 1
 
 Returns:
 
 the sum
 
 Throws:
 
 BufferUnderflowException - If the offset is outside the limits of the Bytes
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 - addAndGetFloat
```
default float addAndGetFloat(long offset,
 float adding)
 throws BufferUnderflowException,
 net.openhft.chronicle.core.io.ClosedIllegalStateException
```
 Similar to addAndGetInt(long, int) but operates on a float value.
 
 Specified by:
 
 addAndGetFloat in interface RandomDataInput
 
 Specified by:
 
 addAndGetFloat in interface RandomDataOutput>
 
 Parameters:
 
 offset - to add and get
 
 adding - value to add, can be 1
 
 Returns:
 
 the sum
 
 Throws:
 
 BufferUnderflowException - If the offset is outside the limits of the Bytes
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 - addAndGetDouble
```
default double addAndGetDouble(long offset,
 double adding)
 throws BufferUnderflowException,
 net.openhft.chronicle.core.io.ClosedIllegalStateException
```
 Similar to addAndGetInt(long, int) but operates on a double value.
 
 Specified by:
 
 addAndGetDouble in interface RandomDataInput
 
 Specified by:
 
 addAndGetDouble in interface RandomDataOutput>
 
 Parameters:
 
 offset - to add and get
 
 adding - value to add, can be 1
 
 Returns:
 
 the sum
 
 Throws:
 
 BufferUnderflowException - If the offset is outside the limits of the Bytes
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 - isDirectMemory
```
boolean isDirectMemory()
```
 Checks if this BytesStore uses direct memory.
 
 Returns:
 
 true if it uses direct memory, false otherwise
 - copy
```
BytesStore<B,U> copy()
 throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Creates and returns a copy of this BytesStore.
 
 Returns:
 
 a new instance of BytesStore that is a copy of this BytesStore
 
 Throws:
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 - bytesForRead
```
@NotNull
default @NotNull Bytes bytesForRead()
 throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 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.
 
 Returns:
 
 a Bytes that wraps this ByteStore
 
 Throws:
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 - bytesForWrite
```
@NotNull
default @NotNull Bytes bytesForWrite()
 throws net.openhft.chronicle.core.io.ClosedIllegalStateException
```
 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.
 
 Returns:
 
 a Bytes that wraps this BytesStore
 
 Throws:
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 - isClear
```
default boolean isClear()
```
 Returns if the readPosition is at the start and the writeLimit is at the end.
 I.e start() == readPosition() && writeLimit() == capacity()
 
 Returns:
 
 if the readPosition is at the start and the writeLimit is at the end
 - realCapacity
```
default long realCapacity()
```
 Returns the actual capacity of the ByteStore before any resizing occurs.
 
 Specified by:
 
 realCapacity in interface RandomDataInput
 
 Returns:
 
 the current capacity of the ByteStore
 - capacity
```
long capacity()
```
 Provides the maximum limit that can be set for the ByteStore.
 
 Returns:
 
 the maximum capacity of the ByteStore
 - underlyingObject
```
@Nullable
U underlyingObject()
```
 Returns:
 
 the underlying object being wrapped, if there is one, or null if not.
 - inside
```
default boolean inside(long offset)
```
 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
 
 Parameters:
 
 offset - the specified offset to check
 
 Returns:
 
 true if offset is safe
 - inside
```
default boolean inside(long offset,
 long bufferSize)
```
 Returns if a number of bytes starting from an offset are inside this ByteStore limits.
 
 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
 - safeLimit
```
default long safeLimit()
```
 Returns:
 
 how many bytes can be safely read, i.e. what is the real capacity of the underlying data.
 - copyTo
```
default long copyTo(@NotNull
 @NotNull BytesStore store)
 throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 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.
 
 Parameters:
 
 store - the BytesStore to copy to
 
 Returns:
 
 how many bytes were copied
 
 Throws:
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 - copyTo
```
default void copyTo(@NotNull
 @NotNull OutputStream out)
 throws IOException,
 net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Copies the bytes in the BytesStore to an OutputStream object.
 
 Parameters:
 
 out - the specified OutputStream that this BytesStore is copied to
 
 Throws:
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 
 IOException
 
 See Also:
 
 OutputStream
 - zeroOut
```
@NotNull
default B zeroOut(long start,
 long end)
 throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Fills the BytesStore with zeros.
 
 Specified by:
 
 zeroOut in interface RandomDataOutput>
 
 Parameters:
 
 start - first byte inclusive
 
 end - last byte exclusive
 
 Returns:
 
 this
 
 Throws:
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 - length
```
default int length()
```
 This method is inherited from CharSequence so result should be the length of the contained chars sequence although it actually returns the number of underlying bytes. These 2 numbers are only the same if the encoding we are using is single char for single byte.
 
 Specified by:
 
 length in interface CharSequence
 
 Returns:
 
 length in bytes to read or Integer.MAX_VALUE if longer.
 - charAt
```
default char charAt(int index)
 throws IndexOutOfBoundsException
```
 Assume ISO-8859-1 encoding, subclasses can override this.
 
 Specified by:
 
 charAt in interface CharSequence
 
 Throws:
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 
 IndexOutOfBoundsException
 - subSequence
```
@NotNull
default @NotNull CharSequence subSequence(int start,
 int end)
```
 This method constructs a new , memory storage type (heap or native) is preserved.
 
 Specified by:
 
 subSequence in interface CharSequence
 - toDebugString
```
@NotNull
default @NotNull String toDebugString()
```
 By default the maximum length of data shown is 256 characters. Use toDebugString(long) if you want more.
 This is assumed to be used to print the contents on a best effort basis. If an Error occurs it will be returned in the String.
 
 Returns:
 
 this BytesStore as a DebugString
 - toDebugString
```
@NotNull
default @NotNull String toDebugString(long maxLength)
```
 This is assumed to be used to print the contents on a best effort basis. If an Error occurs it will be returned in the String.
 
 Parameters:
 
 maxLength - the maximum length of the output
 
 Returns:
 
 this BytesStore as a DebugString.
 - bytesStore
```
@Nullable
default @Nullable BytesStore bytesStore()
```
 Returns:
 
 the underlying BytesStore
 - equalBytes
```
default boolean equalBytes(@NotNull
 @NotNull BytesStore bytesStore,
 long length)
 throws BufferUnderflowException,
 net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Returns if a portion of a specified BytesStore matches this 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.
 
 Throws:
 
 BufferUnderflowException - If there's not enough data to be moved
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way
 - byteCheckSum
```
default int byteCheckSum()
 throws net.openhft.chronicle.core.io.IORuntimeException,
 BufferUnderflowException,
 net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Returns the bytes sum of the readable bytes in this BytesStore.
 
 Returns:
 
 unsigned bytes sum
 
 Throws:
 
 BufferUnderflowException - If there's not enough data to be moved
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way
 
 net.openhft.chronicle.core.io.IORuntimeException
 - byteCheckSum
```
default int byteCheckSum(long start,
 long end)
 throws BufferUnderflowException,
 net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Returns the bytes sum between the specified indexes; start (inclusive) and end (exclusive).
 
 Parameters:
 
 start - the index of the first byte to sum
 
 end - the index of the last byte to sum
 
 Returns:
 
 unsigned bytes sum
 
 Throws:
 
 BufferUnderflowException - If the specified indexes are outside the limits of the BytesStore
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 - endsWith
```
default boolean endsWith(char c)
 throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Returns if the BytesStore ends with a specified character.
 
 Parameters:
 
 c - the character to look for
 
 Returns:
 
 true if the specified character is the same as the last character of this BytesStore
 
 Throws:
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 - startsWith
```
default boolean startsWith(char c)
 throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Returns if the BytesStore starts with a specified character.
 
 Parameters:
 
 c - the character to look for
 
 Returns:
 
 true if the specified character is the same as the first character of this BytesStore
 
 Throws:
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 - contentEquals
```
default boolean contentEquals(@Nullable
 @Nullable BytesStore bytesStore)
 throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Returns if the content of this BytesStore is the same as the content of a specified BytesStore.
 
 Parameters:
 
 bytesStore - the BytesStore to compare with
 
 Returns:
 
 true if this BytesStore and the input BytesStore contain the same data
 
 Throws:
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 - startsWith
```
default boolean startsWith(@Nullable
 @Nullable BytesStore bytesStore)
 throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Returns if the content of this BytesStore starts with bytes equal to the content of a specified BytesStore.
 
 Parameters:
 
 bytesStore - the BytesStore to compare with
 
 Returns:
 
 true if the content of this BytesStore starts with bytesStore
 
 Throws:
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 - to8bitString
```
@NotNull
default @NotNull String to8bitString()
 throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Returns the content of this BytesStore in 8bitString format.
 
 Returns:
 
 a String from the content of this BytesStore
 
 Throws:
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 - addAndGetUnsignedByteNotAtomic
```
default int addAndGetUnsignedByteNotAtomic(long offset,
 int adding)
 throws BufferUnderflowException,
 net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Perform a not atomic add and get operation for an unsigned byte value. This method does not check for unsigned byte overflow.
 
 Parameters:
 
 offset - to add and get
 
 adding - value to add, can be 1
 
 Returns:
 
 the sum
 
 Throws:
 
 BufferUnderflowException - If there's not enough data to be moved
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 - addAndGetShortNotAtomic
```
default short addAndGetShortNotAtomic(long offset,
 short adding)
 throws BufferUnderflowException,
 net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Perform a not atomic add and get operation for a short value.
 
 Parameters:
 
 offset - to add and get
 
 adding - value to add, can be 1
 
 Returns:
 
 the sum
 
 Throws:
 
 BufferUnderflowException - If there's not enough data to be moved
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 - addAndGetIntNotAtomic
```
default int addAndGetIntNotAtomic(long offset,
 int adding)
 throws BufferUnderflowException,
 net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Perform a not atomic add and get operation for an int value.
 
 Parameters:
 
 offset - to add and get
 
 adding - value to add, can be 1
 
 Returns:
 
 the sum
 
 Throws:
 
 BufferUnderflowException - If there's not enough data to be moved
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 - addAndGetDoubleNotAtomic
```
default double addAndGetDoubleNotAtomic(long offset,
 double adding)
 throws BufferUnderflowException,
 net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Perform a not atomic add and get operation for a float value.
 
 Parameters:
 
 offset - to add and get
 
 adding - value to add, can be 1
 
 Returns:
 
 the sum
 
 Throws:
 
 BufferUnderflowException - If there's not enough data to be moved
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 - addAndGetFloatNotAtomic
```
default float addAndGetFloatNotAtomic(long offset,
 float adding)
 throws BufferUnderflowException,
 net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Perform a not atomic add and get operation for a float value.
 
 Parameters:
 
 offset - to add and get
 
 adding - value to add, can be 1
 
 Returns:
 
 the sum
 
 Throws:
 
 BufferUnderflowException - If there's not enough data to be moved
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 - move
```
void move(long from,
 long to,
 long length)
 throws BufferUnderflowException,
 ArithmeticException,
 net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Moves a sequence of bytes within this BytesStore from the source to destination index.
 
 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
 
 Throws:
 
 BufferUnderflowException - If there's not enough data to be moved
 
 ArithmeticException - If the move would result in an index overflow
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 - writeMaxLong
```
default void writeMaxLong(long offset,
 long atLeast)
 throws BufferUnderflowException,
 net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Writes a long value at a specified offset if the value is not smaller than the current value at that offset.
 
 Parameters:
 
 offset - the offset to write to
 
 atLeast - the long value that is to be written at offset if it is not less than the current value at offset
 
 Throws:
 
 BufferUnderflowException - If there's not enough data to be moved
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way
 - writeMaxInt
```
default void writeMaxInt(long offset,
 int atLeast)
 throws BufferUnderflowException,
 net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Writes an int value at a specified offset if the value is not smaller than the current value at that offset.
 
 Parameters:
 
 offset - the offset to write to
 
 atLeast - the int value that is to be written at offset if it is not less than the current value at offset
 
 Throws:
 
 BufferUnderflowException - If there's not enough data to be moved
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way
 - isEmpty
```
default boolean isEmpty()
```
 Returns:
 
 true if the number of readable bytes of this BytesStore is zero.
 - cipher
```
default void cipher(@NotNull
 @NotNull Cipher cipher,
 @NotNull
 @NotNull Bytes<?> outBytes,
 @NotNull
 @NotNull ByteBuffer using1,
 @NotNull
 @NotNull ByteBuffer using2)
 throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Encrypts or decrypts this BytesStore using the provided Cipher and writes the result to the outBytes. It ensures that outBytes has sufficient capacity for the result and restores the original read position of outBytes after operation.
 
 Parameters:
 
 cipher - the Cipher to use for encryption or decryption
 
 outBytes - the Bytes object where the result will be written
 
 using1 - a ByteBuffer to use as temporary buffer during the operation
 
 using2 - another ByteBuffer to use as temporary buffer during the operation
 
 Throws:
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way
 - cipher
```
default void cipher(@NotNull
 @NotNull Cipher cipher,
 @NotNull
 @NotNull Bytes<?> outBytes)
 throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Convenience method to perform the cipher operation using thread local ByteBuffers for temporary buffers. It encrypts or decrypts this BytesStore using the provided Cipher and writes the result to the outBytes.
 
 Parameters:
 
 cipher - the Cipher to use for encryption or decryption
 
 outBytes - the Bytes object where the result will be written
 
 Throws:
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way
 - readWrite
```
default boolean readWrite()
```
 Returns if this ByteStore can be both read from and written to.
 This is in contrast to a ByteStore than can only be read.
 
 Returns:
 
 if this ByteStore can be both read from and written to
 - hash
```
default long hash(long length)
```
 Computes a hash code for this ByteStore's content up to the specified length.
 
 Parameters:
 
 length - the length up to which the hash code is to be computed
 
 Returns:
 
 the computed hash code
 
 Throws:
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 - isEqual
```
default boolean isEqual(long start,
 long length,
 String s)
 throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 Returns if a specified portion of this BytesStore is equal to a specified String. The portion is specified with its offset and length.
 
 Parameters:
 
 start - the portion offset
 
 length - the number of bytes from this BytesStore that should be compared to s
 
 s - the String to compare to
 
 Returns:
 
 true if the specified portion of this BytesStore is equal to s
 
 Throws:
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.
 - start
```
default long start()
```
 Returns:
 
 The smallest position allowed in this buffer.
 - readPosition
```
default 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
```
default 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
```
default 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
```
default 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
```
default 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
```
default 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
```
default 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
```
default long readLimit()
```
 If the resource is closed, the returned value is unspecified.
 
 Returns:
 
 the highest offset or position allowed for this buffer.
 - writeLimit
```
default 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
```
long addressForRead(long offset)
 throws UnsupportedOperationException,
 BufferUnderflowException,
 net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 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:
 
 UnsupportedOperationException - If the underlying buffer is on the heap
 
 BufferUnderflowException - If the offset is before the start() or the after the capacity()
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way
 - addressForRead
```
default long addressForRead(long offset,
 int buffer)
 throws UnsupportedOperationException,
 BufferUnderflowException,
 net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 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.
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way
 - addressForWrite
```
long addressForWrite(long offset)
 throws UnsupportedOperationException,
 BufferOverflowException,
 net.openhft.chronicle.core.io.ClosedIllegalStateException,
 net.openhft.chronicle.core.io.ThreadingIllegalStateException
```
 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:
 
 UnsupportedOperationException - If the underlying buffer is on the heap
 
 BufferOverflowException - If the offset is before the start() or the after the capacity()
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way
 - addressForWritePosition
```
long addressForWritePosition()
 throws UnsupportedOperationException,
 BufferOverflowException,
 net.openhft.chronicle.core.io.ClosedIllegalStateException
```
 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.
 
 net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.
 
 net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way
 - byteOrder
```
default ByteOrder byteOrder()
```
 Retrieves the byte order used by the buffer.
 
 Returns:
 
 The byte order used by the buffer.
 - sharedMemory
```
boolean sharedMemory()
```
 Checks if the Bytes use shared memory.
 
 Returns:
 
 True if the Bytes use shared memory, false otherwise.

Interface BytesStore<B extends BytesStore<B,U>,U>

Field Summary

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

Method Summary

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

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

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

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

Methods inherited from interface java.lang.CharSequence

Method Detail

from

from

from

forFields

wrap

wrap

follow

nativeStore

nativeStoreWithFixedCapacity

lazyNativeBytesStoreWithFixedCapacity

elasticByteBuffer

nativeStoreFrom

nativePointer

wrap

empty

compareAndSwapFloat

compareAndSwapDouble

addAndGetInt

addAndGetLong

addAndGetFloat

addAndGetDouble

isDirectMemory

copy

bytesForRead

bytesForWrite

isClear

realCapacity

capacity

underlyingObject

inside

inside

safeLimit

copyTo

copyTo

zeroOut

length

charAt

subSequence

toDebugString

toDebugString

bytesStore

equalBytes

byteCheckSum

byteCheckSum

endsWith

startsWith

contentEquals

startsWith

to8bitString

addAndGetUnsignedByteNotAtomic

addAndGetShortNotAtomic

addAndGetIntNotAtomic

addAndGetDoubleNotAtomic

addAndGetFloatNotAtomic

move

writeMaxLong

writeMaxInt

isEmpty

cipher

cipher

readWrite

hash

isEqual

start

readPosition

writePosition

lengthWritten

readRemaining

realReadRemaining

writeRemaining