BytesStore (OpenHFT/Chronicle-Bytes 2.23ea25 API)

Type Parameters:

B - BytesStore type

U - Underlying type

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
```
An immutable reference to some bytes with fixed extents. This can be shared safely across thread provided the data referenced is accessed in a thread safe manner. Only offset access within the capacity is possible.

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

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`default double`	`addAndGetDouble(long offset, double adding)` Perform an atomic add and get operation for a 64-bit double
`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)` Perform an atomic add and get operation for a 32-bit float
`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)` Perform an atomic add and get operation for a 32-bit int
`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)` Perform an atomic add and get operation for a 64-bit long
`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)` Obtain the underlying addressForRead.
`default long`	`addressForRead(long offset, int buffer)`
`long`	`addressForWrite(long offset)` Obtain the underlying addressForRead.
`long`	`addressForWritePosition()`
`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()`
`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()`
`default char`	`charAt(int index)` Assume ISO-8859-1 encoding, subclasses can override this.
`default void`	`cipher(@NotNull Cipher cipher, @NotNull Bytes<?> outBytes)`
`default void`	`cipher(@NotNull Cipher cipher, @NotNull Bytes<?> outBytes, @NotNull ByteBuffer using1, @NotNull ByteBuffer using2)`
`default boolean`	`compareAndSwapDouble(long offset, double expected, double value)` Perform a 64-bit double CAS at a given offset.
`default boolean`	`compareAndSwapFloat(long offset, float expected, float value)` Perform a 32-bit float CAS at a given offset.
`default boolean`	`compareAndSwapInt(long offset, int expected, int value)` Perform a 32-bit CAS at a given offset.
`default boolean`	`compareAndSwapLong(long offset, long expected, long value)` Perform a 64-bit CAS at a 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()`
`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)`
`static BytesStore`	`empty()`
`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 <T> BytesStore<?,T>`	`forFields(Object o, String groupName, int padding)`
`static BytesStore`	`from(@NotNull BytesStore cs)` Returns a BytesStore using the bytes in another specified BytesStore.
`static BytesStore`	`from(@NotNull CharSequence cs)` Returns a BytesStore using the bytes in a specified CharSequence.
`static BytesStore`	`from(@NotNull String cs)` Returns a BytesStore using the bytes in a String.
`default long`	`hash(long length)`
`default boolean`	`inside(long offset)` Returns if a specified offset is inside this BytesStore limits.
`default boolean`	`inside(long offset, long buffer)` 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()`
`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.
`default boolean`	`isImmutableEmptyByteStore()` Deprecated.
`static BytesStore<?,Void>`	`lazyNativeBytesStoreWithFixedCapacity(long capacity)`
`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)` Typically this calculates the difference however for HexDumpBytes it's not as simple.
`void`	`move(long from, long to, long length)`
`static @NotNull PointerBytesStore`	`nativePointer()`
`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)`
`default long`	`readLimit()` If the resource is closed, the returned value is unspecified.
`default long`	`readPosition()` Returns the read position.
`default long`	`readRemaining()` Returns the remaining bytes that can be read.
`default boolean`	`readWrite()` Returns if this ByteStore can be both read from and written to.
`default long`	`realCapacity()` Returns the actual capacity that can be potentially read.
`default long`	`realReadRemaining()` If the resource is closed, the returned value is unspecified.
`default long`	`realWriteRemaining()` If the resource is closed, the returned value is unspecified.
`default long`	`safeLimit()`
`boolean`	`sharedMemory()`
`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 `BytesStore`, 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)`
`U`	`underlyingObject()`
`static BytesStore<?,byte[]>`	`wrap(byte[] bytes)` Wraps a byte[].
`static @NotNull BytesStore<?,ByteBuffer>`	`wrap(@NotNull ByteBuffer bb)` Wraps a ByteBuffer which can be either on heap or off heap.
`static @NotNull PointerBytesStore`	`wrap(long address, long length)` Returns a PointerBytesStore that wraps bytes from a starting address in memory.
`default long`	`writeLimit()` Returns the write limit.
`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()` If the resource is closed, the returned value is unspecified.
`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, createCharToString, 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, testAndSetInt, toByteArray, toTemporaryDirectByteBuffer

Methods inherited from interface net.openhft.chronicle.bytes.RandomDataOutput
append, append, 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
refCount, release, releaseLast, releaseLast, reserve, reservedBy, 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
 - compareAndSwapFloat
```
default boolean compareAndSwapFloat(long offset,
 float expected,
 float value)
 throws BufferOverflowException,
 IllegalStateException
```
 Description copied from interface: RandomDataInput
 
 Perform a 32-bit float CAS at a given offset.
 
 Specified by:
 
 compareAndSwapFloat in interface RandomDataInput
 
 Specified by:
 
 compareAndSwapFloat in interface RandomDataOutput>
 
 Parameters:
 
 offset - to perform CAS
 
 expected - value
 
 value - to set
 
 Returns:
 
 true, if successful.
 
 Throws:
 
 BufferOverflowException
 
 IllegalStateException
 - compareAndSwapDouble
```
default boolean compareAndSwapDouble(long offset,
 double expected,
 double value)
 throws BufferOverflowException,
 IllegalStateException
```
 Description copied from interface: RandomDataInput
 
 Perform a 64-bit double CAS at a given offset.
 
 Specified by:
 
 compareAndSwapDouble in interface RandomDataInput
 
 Specified by:
 
 compareAndSwapDouble in interface RandomDataOutput>
 
 Parameters:
 
 offset - to perform CAS
 
 expected - value
 
 value - to set
 
 Returns:
 
 true, if successful.
 
 Throws:
 
 BufferOverflowException
 
 IllegalStateException
 - addAndGetInt
```
default int addAndGetInt(long offset,
 int adding)
 throws BufferUnderflowException,
 IllegalStateException
```
 Description copied from interface: RandomDataInput
 
 Perform an atomic add and get operation for a 32-bit int
 
 Specified by:
 
 addAndGetInt in interface RandomDataInput
 
 Specified by:
 
 addAndGetInt 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
 
 IllegalStateException - if released
 - addAndGetLong
```
default long addAndGetLong(long offset,
 long adding)
 throws BufferUnderflowException,
 IllegalStateException
```
 Description copied from interface: RandomDataInput
 
 Perform an atomic add and get operation for a 64-bit long
 
 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
 
 IllegalStateException - if released
 - addAndGetFloat
```
default float addAndGetFloat(long offset,
 float adding)
 throws BufferUnderflowException,
 IllegalStateException
```
 Description copied from interface: RandomDataInput
 
 Perform an atomic add and get operation for a 32-bit float
 
 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
 
 IllegalStateException
 - addAndGetDouble
```
default double addAndGetDouble(long offset,
 double adding)
 throws BufferUnderflowException,
 IllegalStateException
```
 Description copied from interface: RandomDataInput
 
 Perform an atomic add and get operation for a 64-bit double
 
 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
 
 IllegalStateException - if released
 - from
```
static BytesStore from(@NotNull
 @NotNull CharSequence cs)
 throws IllegalStateException
```
 Returns a BytesStore using the bytes in a specified CharSequence. These chars are encoded using ISO_8859_1
 
 Parameters:
 
 cs - a CharSequence to convert
 
 Returns:
 
 a BytesStore which contains the bytes in cs
 
 Throws:
 
 IllegalStateException
 - from
```
static BytesStore from(@NotNull
 @NotNull BytesStore cs)
 throws IllegalStateException
```
 Returns a BytesStore using the bytes in another specified BytesStore.
 
 Parameters:
 
 cs - a BytesStore
 
 Returns:
 
 the resulting BytesStore
 
 Throws:
 
 IllegalStateException
 - from
```
static BytesStore from(@NotNull
 @NotNull String cs)
```
 Returns a BytesStore using the bytes in a String. The characters in the String are encoded using ISO_8859_1
 
 Parameters:
 
 cs - a String
 
 Returns:
 
 BytesStore
 - forFields
```
static <T> BytesStore<?,T> forFields(Object o,
 String groupName,
 int padding)
```
 - wrap
```
static BytesStore<?,byte[]> wrap(byte[] bytes)
```
 Wraps a byte[]. This means there is one copy in memory.
 
 Parameters:
 
 bytes - to wrap
 
 Returns:
 
 BytesStore
 - wrap
```
@NotNull
static @NotNull BytesStore<?,ByteBuffer> wrap(@NotNull
 @NotNull ByteBuffer bb)
```
 Wraps a ByteBuffer which can be either on heap or off heap.
 
 Parameters:
 
 bb - the ByteBuffer to wrap
 
 Returns:
 
 BytesStore
 - nativeStore
```
static BytesStore<?,Void> nativeStore(long capacity)
```
 This is an elastic native store.
 
 Parameters:
 
 capacity - of the buffer
 - nativeStoreWithFixedCapacity
```
static BytesStore<?,Void> nativeStoreWithFixedCapacity(long capacity)
```
 - lazyNativeBytesStoreWithFixedCapacity
```
static BytesStore<?,Void> lazyNativeBytesStoreWithFixedCapacity(long capacity)
```
 - elasticByteBuffer
```
static BytesStore<?,ByteBuffer> elasticByteBuffer(int size,
 long maxSize)
```
 - 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
 
 Throws:
 
 AssertionError - if the method fails for any reason
 - nativePointer
```
@NotNull
static @NotNull PointerBytesStore nativePointer()
```
 Returns:
 
 a PointerBytesStore which can be set to any addressForRead
 - wrap
```
@NotNull
static @NotNull PointerBytesStore wrap(long address,
 long length)
```
 Returns a PointerBytesStore that wraps bytes from a starting address in memory.
 
 Parameters:
 
 address - the start address of PointerBytesStore
 
 length - the length of PointerBytesStore
 
 Returns:
 
 a PointerBytesStore
 - empty
```
static BytesStore empty()
```
 Returns:
 
 an empty, fixed-sized immutable BytesStore.
 - isDirectMemory
```
boolean isDirectMemory()
```
 Returns:
 
 whether it uses direct memory or not.
 - copy
```
BytesStore<B,U> copy()
 throws IllegalStateException
```
 Returns:
 
 a copy of this BytesStore.
 
 Throws:
 
 IllegalStateException
 - bytesForRead
```
@NotNull
default @NotNull Bytes bytesForRead()
 throws IllegalStateException
```
 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:
 
 IllegalStateException - if this Bytes has been released
 - bytesForWrite
```
@NotNull
default @NotNull Bytes bytesForWrite()
 throws IllegalStateException
```
 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:
 
 IllegalStateException - if this BytesStore has been released
 - 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()
```
 Description copied from interface: RandomDataInput
 
 Returns the actual capacity that can be potentially read.
 
 Specified by:
 
 realCapacity in interface RandomDataInput
 
 Returns:
 
 the actual capacity available before resizing
 - capacity
```
long capacity()
```
 Returns:
 
 The maximum limit you can set.
 - 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 buffer)
```
 Returns if a number of bytes starting from an offset are inside this ByteStore limits. If you are going to write n bytes starting at offset, you need to call this method with buffer=n-1, as the 1st byte is written at offset, and the last at offset+n-1
 Use this test to determine if an offset is considered safe to write to. Note that it checks we are inside the BytesStore limits *including* the overlap
 
 Parameters:
 
 offset - the starting index to check
 
 buffer - the number of bytes after the offset to check
 
 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 IllegalStateException
```
 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:
 
 IllegalStateException - if this BytesStore has been released
 - copyTo
```
default void copyTo(@NotNull
 @NotNull OutputStream out)
 throws IOException,
 IllegalStateException
```
 Copies the bytes in the BytesStore to an OutputStream object.
 
 Parameters:
 
 out - the specified OutputStream that this BytesStore is copied to
 
 Throws:
 
 IllegalStateException - if this Bytes has been released
 
 IOException
 
 See Also:
 
 OutputStream
 - zeroOut
```
@NotNull
default B zeroOut(long start,
 long end)
 throws IllegalStateException
```
 Fills the BytesStore with zeros.
 
 Specified by:
 
 zeroOut in interface RandomDataOutput>
 
 Parameters:
 
 start - first byte inclusive
 
 end - last byte exclusive
 
 Returns:
 
 this
 
 Throws:
 
 IllegalStateException
 - 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:
 
 IndexOutOfBoundsException
 - subSequence
```
@NotNull
default @NotNull CharSequence subSequence(int start,
 int end)
```
 This method constructs a new BytesStore, memory storage type (heap or native) is preserved.
 
 Specified by:
 
 subSequence in interface CharSequence
 - toDebugString
```
@NotNull
default @NotNull String toDebugString()
 throws IllegalStateException
```
 By default the maximum length of data shown is 256 characters. Use toDebugString(long) if you want more.
 
 Returns:
 
 this BytesStore as a DebugString
 
 Throws:
 
 IllegalStateException
 - toDebugString
```
@NotNull
default @NotNull String toDebugString(long maxLength)
 throws IllegalStateException,
 ArithmeticException
```
 Parameters:
 
 maxLength - the maximum length of the output
 
 Returns:
 
 this BytesStore as a DebugString.
 
 Throws:
 
 IllegalStateException
 
 ArithmeticException
 - bytesStore
```
@Nullable
default @Nullable BytesStore bytesStore()
```
 Returns:
 
 the underlying BytesStore
 - equalBytes
```
default boolean equalBytes(@NotNull
 @NotNull BytesStore bytesStore,
 long length)
 throws BufferUnderflowException,
 IllegalStateException
```
 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
 
 IllegalStateException
 - byteCheckSum
```
default int byteCheckSum()
 throws net.openhft.chronicle.core.io.IORuntimeException,
 BufferUnderflowException,
 IllegalStateException
```
 Returns the bytes sum of the readable bytes in this BytesStore.
 
 Returns:
 
 unsigned bytes sum
 
 Throws:
 
 IllegalStateException - if the BytesStore has been released
 
 net.openhft.chronicle.core.io.IORuntimeException
 
 BufferUnderflowException
 - byteCheckSum
```
default int byteCheckSum(long start,
 long end)
 throws BufferUnderflowException,
 IllegalStateException
```
 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
 
 IllegalStateException - if the BytesStore has been released
 - endsWith
```
default boolean endsWith(char c)
 throws IllegalStateException
```
 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:
 
 IllegalStateException
 - startsWith
```
default boolean startsWith(char c)
 throws IllegalStateException
```
 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:
 
 IllegalStateException
 - contentEquals
```
default boolean contentEquals(@Nullable
 @Nullable BytesStore bytesStore)
 throws IllegalStateException
```
 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:
 
 IllegalStateException - if this BytesStore has been released
 - startsWith
```
default boolean startsWith(@Nullable
 @Nullable BytesStore bytesStore)
 throws IllegalStateException
```
 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:
 
 IllegalStateException - if this BytesStore has been released
 - to8bitString
```
@NotNull
default @NotNull String to8bitString()
```
 Returns the content of this BytesStore in 8bitString format.
 
 Returns:
 
 a String from the content of this BytesStore
 - addAndGetUnsignedByteNotAtomic
```
default int addAndGetUnsignedByteNotAtomic(long offset,
 int adding)
 throws BufferUnderflowException,
 IllegalStateException
```
 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
 
 IllegalStateException
 - addAndGetShortNotAtomic
```
default short addAndGetShortNotAtomic(long offset,
 short adding)
 throws BufferUnderflowException,
 IllegalStateException
```
 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
 
 IllegalStateException
 - addAndGetIntNotAtomic
```
default int addAndGetIntNotAtomic(long offset,
 int adding)
 throws BufferUnderflowException,
 IllegalStateException
```
 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
 
 IllegalStateException
 - addAndGetDoubleNotAtomic
```
default double addAndGetDoubleNotAtomic(long offset,
 double adding)
 throws BufferUnderflowException,
 IllegalStateException
```
 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
 
 IllegalStateException
 - addAndGetFloatNotAtomic
```
default float addAndGetFloatNotAtomic(long offset,
 float adding)
 throws BufferUnderflowException,
 IllegalStateException
```
 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
 
 IllegalStateException
 - move
```
void move(long from,
 long to,
 long length)
 throws BufferUnderflowException,
 IllegalStateException,
 ArithmeticException
```
 Throws:
 
 BufferUnderflowException
 
 IllegalStateException
 
 ArithmeticException
 - writeMaxLong
```
default void writeMaxLong(long offset,
 long atLeast)
 throws BufferUnderflowException,
 IllegalStateException
```
 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
 
 IllegalStateException
 - writeMaxInt
```
default void writeMaxInt(long offset,
 int atLeast)
 throws BufferUnderflowException,
 IllegalStateException
```
 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
 
 IllegalStateException
 - 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 IllegalStateException
```
 Throws:
 
 IllegalStateException
 - cipher
```
default void cipher(@NotNull
 @NotNull Cipher cipher,
 @NotNull
 @NotNull Bytes<?> outBytes)
 throws IllegalStateException
```
 Throws:
 
 IllegalStateException
 - 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)
```
 - isEqual
```
default boolean isEqual(long start,
 long length,
 String s)
```
 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
 - compareAndSwapInt
```
default boolean compareAndSwapInt(long offset,
 int expected,
 int value)
 throws BufferOverflowException,
 IllegalStateException
```
 Description copied from interface: RandomDataInput
 
 Perform a 32-bit CAS at a given offset.
 
 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.
 
 Throws:
 
 BufferOverflowException
 
 IllegalStateException
 - compareAndSwapLong
```
default boolean compareAndSwapLong(long offset,
 long expected,
 long value)
 throws BufferOverflowException,
 IllegalStateException
```
 Description copied from interface: RandomDataInput
 
 Perform a 64-bit CAS at a given offset.
 
 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.
 
 Throws:
 
 BufferOverflowException
 
 IllegalStateException
 - isImmutableEmptyByteStore
```
@Deprecated
default boolean isImmutableEmptyByteStore()
```
 Deprecated.
 
 Returns if this ByteStore is an immutable empty ByteStore or if it is backed by an immutable empty ByteStore.
 
 Returns:
 
 if immutable empty or backed by such
 - 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)
```
 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 - to compare against
 
 Returns:
 
 the length from the startPosition
 - readRemaining
```
default long readRemaining()
```
 Returns the remaining bytes that can be read.
 If the resource is closed, the returned value is unspecified.
 
 Returns:
 
 How many more bytes can we read.
 - realReadRemaining
```
default long realReadRemaining()
```
 If the resource is closed, the returned value is unspecified.
 
 Returns:
 
 how much can be safely read directly.
 - writeRemaining
```
default long writeRemaining()
```
 If the resource is closed, the returned value is unspecified.
 
 Returns:
 
 How many more bytes can we written.
 - realWriteRemaining
```
default long realWriteRemaining()
```
 If the resource is closed, the returned value is unspecified.
 
 Returns:
 
 writeRemaining with resize
 - 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()
```
 Returns the write limit.
 If the resource is closed, the returned value is unspecified.
 
 Returns:
 
 the write limit
 - addressForRead
```
long addressForRead(long offset)
 throws UnsupportedOperationException,
 BufferUnderflowException,
 IllegalStateException
```
 Obtain the underlying addressForRead. 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()
 
 IllegalStateException
 - addressForRead
```
default long addressForRead(long offset,
 int buffer)
 throws UnsupportedOperationException,
 BufferUnderflowException,
 IllegalStateException
```
 Throws:
 
 UnsupportedOperationException
 
 BufferUnderflowException
 
 IllegalStateException
 - addressForWrite
```
long addressForWrite(long offset)
 throws UnsupportedOperationException,
 BufferOverflowException,
 IllegalStateException
```
 Obtain the underlying addressForRead. 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()
 
 IllegalStateException
 - addressForWritePosition
```
long addressForWritePosition()
 throws UnsupportedOperationException,
 BufferOverflowException,
 IllegalStateException
```
 Throws:
 
 UnsupportedOperationException
 
 BufferOverflowException
 
 IllegalStateException
 - byteOrder
```
default ByteOrder byteOrder()
```
 - sharedMemory
```
boolean sharedMemory()
```
 Returns:
 
 true if these Bytes use shared memory.

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

Field Summary

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

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

compareAndSwapFloat

compareAndSwapDouble

addAndGetInt

addAndGetLong

addAndGetFloat

addAndGetDouble

from

from

from

forFields

wrap

wrap

nativeStore

nativeStoreWithFixedCapacity

lazyNativeBytesStoreWithFixedCapacity

elasticByteBuffer

nativeStoreFrom

nativePointer

wrap

empty

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

compareAndSwapInt

compareAndSwapLong

isImmutableEmptyByteStore

start

readPosition

writePosition

lengthWritten