Bytes (OpenHFT/Chronicle-Bytes 1.9.11 API)

All Superinterfaces:

Appendable, BytesIn<Underlying>, BytesOut<Underlying>, BytesPrepender<Bytes<Underlying>>, BytesStore<Bytes<Underlying>,Underlying>, ByteStringAppender<Bytes<Underlying>>, CharSequence, RandomDataInput, RandomDataOutput<Bytes<Underlying>>, net.openhft.chronicle.core.ReferenceCounted, StreamingCommon<Bytes<Underlying>>, StreamingDataInput<Bytes<Underlying>>, StreamingDataOutput<Bytes<Underlying>>

All Known Implementing Classes:

AbstractBytes, MappedBytes, NativeBytes, UncheckedBytes, UncheckedNativeBytes, VanillaBytes
```
public interface Bytes<Underlying>
extends BytesStore<Bytes<Underlying>,Underlying>, BytesIn<Underlying>, BytesOut<Underlying>
```
Bytes is a pointer to a region of memory within a BytesStore. It can be for a fixed region of memory or an "elastic" buffer which can be resized, but not for a fixed region.
This is a BytesStore which is mutable and not thread safe. It has a write position and read position which must follow these constraints
start() <= readPosition() <= writePosition() <= writeLimit() <= capacity()
Also readLimit() == writePosition() and readPosition() <= safeLimit();

Field Summary

Fields
Modifier and Type Field and Description

static int DEFAULT_BYTE_BUFFER_CAPACITY

static int MAX_BYTE_BUFFER_CAPACITY

static long MAX_CAPACITY
- Fields inherited from interface net.openhft.chronicle.bytes.RandomDataInput
  charToString
- Fields inherited from interface net.openhft.chronicle.bytes.StreamingDataOutput
  JAVA9_STRING_CODER_LATIN, JAVA9_STRING_CODER_UTF16

Fields
Modifier and Type	Field and Description
`static int`	`DEFAULT_BYTE_BUFFER_CAPACITY`
`static int`	`MAX_BYTE_BUFFER_CAPACITY`
`static long`	`MAX_CAPACITY`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`static Bytes`	`allocateDirect(byte[] bytes)` copies the contents of bytes into a direct byte buffer
`static VanillaBytes<Void>`	`allocateDirect(long capacity)` Allocate a fixed size buffer read for writing.
`static NativeBytes<Void>`	`allocateElasticDirect()` Allocate an elastic buffer with initially no size.
`static NativeBytes<Void>`	`allocateElasticDirect(long initialCapacity)` Allocate an elastic buffer with initially no size.
`default Bytes<Underlying>`	`bytesForRead()` Creates a slice of the current Bytes based on its position() and limit().
`BytesStore`	`bytesStore()`
`Bytes<Underlying>`	`clear()` Set the readPosition= writePosition = start, writeLimit = capacity
`Bytes<Underlying>`	`compact()` Compact these Bytes by moving the readPosition to the start.
`BytesStore<Bytes<Underlying>,Underlying>`	`copy()`
`default long`	`copyTo(BytesStore store)` copy bytes from one ByteStore to another
`default void`	`copyTo(OutputStream out)`
`static Bytes<ByteBuffer>`	`elasticByteBuffer()`
`static Bytes<ByteBuffer>`	`elasticByteBuffer(int initialCapacity)` Returns an elastic wrapper for a direct ByteBuffer which will be resized as required, with the given initial capacity.
`static Bytes<ByteBuffer>`	`elasticByteBuffer(int initialCapacity, int maxSize)`
`static Bytes<ByteBuffer>`	`elasticHeapByteBuffer(int initialCapacity)` Returns an elastic wrapper for a heap ByteBuffer which will be resized as required, with the given initial capacity.
`default void`	`ensureCapacity(long size)` grow the buffer if the buffer is elastic, if the buffer is not elastic and there is not enough capacity then this method will throws `BufferOverflowException`
`static Bytes<byte[]>`	`from(CharSequence text)` Convert text to bytes using ISO-8859-1 encoding and return a Bytes ready for reading.
`static Bytes`	`fromHexString(String s)`
`static Bytes<byte[]>`	`fromString(String text)`
`default long`	`indexOf(Bytes source)` Returns the index within this bytes of the first occurrence of the specified sub-bytes.
`default long`	`indexOf(Bytes source, int fromIndex)` Deprecated.
`static int`	`indexOf(BytesStore source, BytesStore target, int fromIndex)` Code shared by String and StringBuffer to do searches.
`default int`	`indexOf(BytesStore source, int fromIndex)` Returns the index within this bytes of the first occurrence of the specified subbytes.
`default boolean`	`isClear()` The Bytes are clear if start() == readPosition() && writeLimit() == capacity()
`boolean`	`isElastic()`
`default boolean`	`isEqual(String s)`
`int`	`lastDecimalPlaces()`
`void`	`lastDecimalPlaces(int lastDecimalPlaces)` Store the last number of decimal places.
`default void`	`parse8bit(Appendable buffer, StopCharsTester stopCharsTester)` parse text with ISO-8859-1 decoding as character terminated.
`default void`	`parse8bit(Appendable buffer, StopCharTester stopCharTester)` parse text with ISO-8859-1 decoding as character terminated.
`default BigDecimal`	`parseBigDecimal()`
`default Boolean`	`parseBoolean(StopCharTester tester)` Return true or false, or null if it could not be detected as true or false.
`default double`	`parseDouble()` parse text as a double decimal.
`default long`	`parseLong()` parse text as a long integer.
`default long`	`parseLongDecimal()` Parse the significant digits of a decimal number.
`default void`	`parseUTF(Appendable buffer, StopCharsTester stopCharsTester)` Deprecated.
`default void`	`parseUTF(Appendable buffer, StopCharTester stopCharTester)` Deprecated.
`default String`	`parseUTF(StopCharTester stopCharTester)` Deprecated.
`default void`	`parseUtf8(Appendable buffer, StopCharsTester stopCharsTester)` parse text with UTF-8 decoding as one or two character terminated.
`default void`	`parseUtf8(Appendable buffer, StopCharTester stopCharTester)` parse text with UTF-8 decoding as character terminated.
`default String`	`parseUtf8(StopCharTester stopCharTester)` parse text with UTF-8 decoding as character terminated.
`default BigDecimal`	`readBigDecimal()`
`default BigInteger`	`readBigInteger()`
`default Reader`	`reader()` Access these bytes as an ISO-8859-1 encoded Reader
`default void`	`readWithLength(long length, BytesOut<Underlying> bytesOut)`
`default boolean`	`readWrite()`
`default long`	`realCapacity()`
`default long`	`safeLimit()`
`default boolean`	`sharedMemory()`
`default boolean`	`skipTo(StopCharTester tester)` Skip text until a terminating character is reached.
`default String`	`toHexString()` display the hex data of `Bytes` from the position() to the limit()
`default String`	`toHexString(long maxLength)` display the hex data of `Bytes` from the position() to the limit()
`default String`	`toHexString(long offset, long maxLength)` display the hex data of `Bytes` from the position() to the limit()
`static String`	`toString(Bytes<?> buffer)` Creates a string from the `position` to the `limit`, The buffer is not modified by this call
`static String`	`toString(Bytes<?> buffer, long maxLen)` Creates a string from the `position` to the `limit`, The buffer is not modified by this call
`static String`	`toString(Bytes buffer, long position, long len)` The buffer is not modified by this call
`default boolean`	`unchecked()`
`default Bytes<Underlying>`	`unchecked(boolean unchecked)` Return a Bytes which is optionally unchecked.
`default void`	`unwrite(long fromOffset, int count)`
`static Bytes<byte[]>`	`wrapForRead(byte[] byteArray)` Wrap the byte[] ready for reading
`static Bytes<ByteBuffer>`	`wrapForRead(ByteBuffer byteBuffer)`
`static Bytes<byte[]>`	`wrapForWrite(byte[] byteArray)` Wrap the byte[] ready for writing
`static Bytes<ByteBuffer>`	`wrapForWrite(ByteBuffer byteBuffer)`

Methods inherited from interface net.openhft.chronicle.bytes.BytesStore
addAndGetByteNotAtomic, addAndGetDoubleNotAtomic, addAndGetFloatNotAtomic, addAndGetIntNotAtomic, addAndGetLongNotAtomic, addAndGetShortNotAtomic, addAndGetUnsignedByteNotAtomic, addAndGetUnsignedIntNotAtomic, addAndGetUnsignedShortNotAtomic, byteCheckSum, bytesForWrite, capacity, charAt, cipher, cipher, contentEquals, empty, endsWith, equalBytes, inside, isDirectMemory, isEmpty, isPresent, isPresent, length, longCheckSum, move, nativePointer, startsWith, startsWith, subSequence, to8bitString, toDebugString, toDebugString, underlyingObject, wrap, wrap, wrap, writeMaxLong, zeroOut

Methods inherited from interface net.openhft.chronicle.bytes.RandomDataInput
addAndGetDouble, addAndGetFloat, addAndGetInt, addAndGetLong, 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, toByteArray, toTemporaryDirectByteBuffer

Methods inherited from interface net.openhft.chronicle.bytes.RandomDataOutput
append, append, nativeWrite, write, write, write, write, write, 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 java.lang.CharSequence
chars, codePoints, toString

Methods inherited from interface net.openhft.chronicle.bytes.StreamingDataInput
inputStream, nativeRead, parseHexLong, parseUTF, parseUtf8, peekUnsignedByte, read, read, read, read, read8bit, read8bit, read8bit, read8bit, readBoolean, readByte, readDouble, readEnum, readFloat, readHistogram, readInt, readLimit, readLong, readPosition, readPositionRemaining, readPositionUnlimited, readShort, readSkip, readStopBit, readStopBitDecimal, readStopBitDouble, readUnsignedByte, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8, readUTFΔ, readUTFΔ, readVolatileInt, readVolatileLong, readWithLength, readWithLength, uncheckedReadSkipBackOne, uncheckedReadSkipOne, uncheckedReadUnsignedByte

Methods inherited from interface net.openhft.chronicle.bytes.ByteStringAppender
append, append, append, append, append, append, append, append, append8bit, append8bit, append8bit, appendBase, appendDateMillis, appendDecimal, appendTimeMillis, writer

Methods inherited from interface net.openhft.chronicle.bytes.StreamingDataOutput
appendUtf8, appendUtf8, appendUtf8, appendUtf8, appendUtf8, appendUtf8, copyFrom, nativeWrite, outputStream, write, write, write, write, write, write, write8bit, write8bit, write8bit, write8bit, writeBigDecimal, writeBigInteger, writeBoolean, writeByte, writeDouble, writeEnum, writeFloat, writeHistogram, writeInt, writeInt24, writeIntAdv, writeLimit, writeLong, writeLongAdv, writeOrderedInt, writeOrderedLong, writePosition, writePositionRemaining, writeShort, writeSkip, writeSome, writeSome, writeStopBit, writeStopBit, writeStopBitDecimal, writeUnsignedByte, writeUnsignedInt, writeUnsignedShort, writeUtf8, writeUtf8, writeUTFΔ, writeWithLength

Methods inherited from interface net.openhft.chronicle.bytes.BytesPrepender
clearAndPad, prepend, prewrite, prewrite, prewriteByte, prewriteInt, prewriteLong, prewriteShort

- Field Detail
  - MAX_CAPACITY
```
static final long MAX_CAPACITY
```
    See Also:
    
    Constant Field Values
  - MAX_BYTE_BUFFER_CAPACITY
```
static final int MAX_BYTE_BUFFER_CAPACITY
```
  - DEFAULT_BYTE_BUFFER_CAPACITY
```
static final int DEFAULT_BYTE_BUFFER_CAPACITY
```
    See Also:
    
    Constant Field Values
- Method Detail
  - elasticByteBuffer
```
static Bytes<ByteBuffer> elasticByteBuffer()
```
    Returns:
    
    an elastic wrapper for a direct ByteBuffer which will be resized as required.
  - elasticByteBuffer
```
static Bytes<ByteBuffer> elasticByteBuffer(int initialCapacity,
                                           int maxSize)
```
  - elasticByteBuffer
```
static Bytes<ByteBuffer> elasticByteBuffer(int initialCapacity)
```
    Returns an elastic wrapper for a direct ByteBuffer which will be resized as required, with the given initial capacity.
  - elasticHeapByteBuffer
```
@NotNull
static Bytes<ByteBuffer> elasticHeapByteBuffer(int initialCapacity)
```
    Returns an elastic wrapper for a heap ByteBuffer which will be resized as required, with the given initial capacity.
  - wrapForRead
```
static Bytes<ByteBuffer> wrapForRead(@NotNull
                                     ByteBuffer byteBuffer)
```
    Parameters:
    
    byteBuffer - to read
    
    Returns:
    
    a Bytes which wrap a ByteBuffer and is ready for reading.
  - wrapForWrite
```
static Bytes<ByteBuffer> wrapForWrite(@NotNull
                                      ByteBuffer byteBuffer)
```
    Parameters:
    
    byteBuffer - to read
    
    Returns:
    
    a Bytes which wrap a ByteBuffer and is ready for writing.
  - wrapForRead
```
static Bytes<byte[]> wrapForRead(@NotNull
                                 byte[] byteArray)
```
    Wrap the byte[] ready for reading
    
    Parameters:
    
    byteArray - to wrap
    
    Returns:
    
    the Bytes ready for reading.
  - wrapForWrite
```
static Bytes<byte[]> wrapForWrite(@NotNull
                                  byte[] byteArray)
```
    Wrap the byte[] ready for writing
    
    Parameters:
    
    byteArray - to wrap
    
    Returns:
    
    the Bytes ready for writing.
  - from
```
static Bytes<byte[]> from(@NotNull
                          CharSequence text)
                   throws IllegalArgumentException,
                          IllegalStateException
```
    Convert text to bytes using ISO-8859-1 encoding and return a Bytes ready for reading.
    
    Specified by:
    
    from in interface BytesStore<Bytes<Underlying>,Underlying>
    
    Parameters:
    
    text - to convert
    
    Returns:
    
    Bytes ready for reading.
    
    Throws:
    
    IllegalArgumentException
    
    IllegalStateException
  - fromString
```
static Bytes<byte[]> fromString(@NotNull
                                String text)
                         throws IllegalArgumentException,
                                IllegalStateException
```
    Throws:
    
    IllegalArgumentException
    
    IllegalStateException
  - allocateDirect
```
static VanillaBytes<Void> allocateDirect(long capacity)
                                  throws IllegalArgumentException
```
    Allocate a fixed size buffer read for writing.
    
    Parameters:
    
    capacity - minimum to allocate
    
    Returns:
    
    a new Bytes ready for writing.
    
    Throws:
    
    IllegalArgumentException
  - allocateElasticDirect
```
static NativeBytes<Void> allocateElasticDirect()
```
    Allocate an elastic buffer with initially no size.
    
    Returns:
    
    Bytes for writing.
  - allocateElasticDirect
```
static NativeBytes<Void> allocateElasticDirect(long initialCapacity)
                                        throws IllegalArgumentException
```
    Allocate an elastic buffer with initially no size.
    
    Returns:
    
    Bytes for writing.
    
    Throws:
    
    IllegalArgumentException
  - toString
```
static String toString(@NotNull
                       Bytes<?> buffer)
                throws BufferUnderflowException
```
    Creates a string from the position to the limit, The buffer is not modified by this call
    
    Parameters:
    
    buffer - the buffer to use
    
    Returns:
    
    a string contain the text from the position to the limit
    
    Throws:
    
    BufferUnderflowException
  - toString
```
static String toString(@NotNull
                       Bytes<?> buffer,
                       long maxLen)
                throws BufferUnderflowException
```
    Creates a string from the position to the limit, The buffer is not modified by this call
    
    Parameters:
    
    buffer - the buffer to use
    
    maxLen - of the result returned
    
    Returns:
    
    a string contain the text from the position to the limit
    
    Throws:
    
    BufferUnderflowException
  - toString
```
static String toString(@NotNull
                       Bytes buffer,
                       long position,
                       long len)
                throws BufferUnderflowException
```
    The buffer is not modified by this call
    
    Parameters:
    
    buffer - the buffer to use
    
    position - the position to create the string from
    
    len - the number of characters to show in the string
    
    Returns:
    
    a string contain the text from offset position
    
    Throws:
    
    BufferUnderflowException
  - allocateDirect
```
@NotNull
static Bytes allocateDirect(@NotNull
                                     byte[] bytes)
                              throws IllegalArgumentException
```
    copies the contents of bytes into a direct byte buffer
    
    Parameters:
    
    bytes - the bytes to wrap
    
    Returns:
    
    a direct byte buffer contain the bytes
    
    Throws:
    
    IllegalArgumentException
  - fromHexString
```
static Bytes fromHexString(@NotNull
                           String s)
```
  - indexOf
```
static int indexOf(@NotNull
                   BytesStore source,
                   @NotNull
                   BytesStore target,
                   int fromIndex)
```
    Code shared by String and StringBuffer to do searches. The source is the character array being searched, and the target is the string being searched for.
    
    Parameters:
    
    source - the read bytes being searched.
    
    target - the read bytes being searched for.
    
    fromIndex - the index to begin searching from,
  - unchecked
```
@NotNull
default Bytes<Underlying> unchecked(boolean unchecked)
                                      throws IllegalStateException
```
    Return a Bytes which is optionally unchecked. This allows bounds checks to be turned off.
    
    Parameters:
    
    unchecked - if true, minimal bounds checks will be performed.
    
    Returns:
    
    Bytes without bounds checking.
    
    Throws:
    
    IllegalStateException - if the underlying BytesStore has been released
  - unchecked
```
default boolean unchecked()
```
  - safeLimit
```
default long safeLimit()
```
    Specified by:
    
    safeLimit in interface BytesStore<Bytes<Underlying>,Underlying>
    
    Returns:
    
    the size which can be safely read. If this isElastic() it can be lower than the point it can safely write.
  - isClear
```
default boolean isClear()
```
    Description copied from interface: BytesStore
    
    The Bytes are clear if start() == readPosition() && writeLimit() == capacity()
    
    Specified by:
    
    isClear in interface BytesStore<Bytes<Underlying>,Underlying>
    
    Returns:
    
    is the readPosition at the start and the writeLimit at the end.
  - realCapacity
```
default long realCapacity()
```
    Specified by:
    
    realCapacity in interface BytesStore<Bytes<Underlying>,Underlying>
    
    Specified by:
    
    realCapacity in interface RandomDataInput
    
    Specified by:
    
    realCapacity in interface StreamingDataOutput<Bytes<Underlying>>
    
    Returns:
    
    if isElastic, this can be much lower than the virtual capacity().
  - copy
```
BytesStore<Bytes<Underlying>,Underlying> copy()
```
    Specified by:
    
    copy in interface BytesStore<Bytes<Underlying>,Underlying>
    
    Returns:
    
    a copy of this Bytes from position() to limit().
  - toHexString
```
@NotNull
default String toHexString()
```
    display the hex data of Bytes from the position() to the limit()
    
    Returns:
    
    hex representation of the buffer, from example [0D ,OA, FF]
  - toHexString
```
@NotNull
default String toHexString(long maxLength)
```
    display the hex data of Bytes from the position() to the limit()
    
    Parameters:
    
    maxLength - limit the number of bytes to be dumped.
    
    Returns:
    
    hex representation of the buffer, from example [0D ,OA, FF]
  - toHexString
```
@NotNull
default String toHexString(long offset,
                                    long maxLength)
```
    display the hex data of Bytes from the position() to the limit()
    
    Parameters:
    
    maxLength - limit the number of bytes to be dumped.
    
    Returns:
    
    hex representation of the buffer, from example [0D ,OA, FF]
  - isElastic
```
boolean isElastic()
```
    Returns:
    
    can the Bytes resize when more data is written than it's realCapacity()
  - ensureCapacity
```
default void ensureCapacity(long size)
                     throws IllegalArgumentException
```
    grow the buffer if the buffer is elastic, if the buffer is not elastic and there is not enough capacity then this method will throws BufferOverflowException
    
    Parameters:
    
    size - the capacity that you required
    
    Throws:
    
    IllegalArgumentException - if the buffer is not elastic and there is not enough space
  - bytesForRead
```
@NotNull
default Bytes<Underlying> bytesForRead()
                                         throws IllegalStateException
```
    Creates a slice of the current Bytes based on its position() and limit(). As a sub-section of a Bytes it cannot be elastic.
    
    Specified by:
    
    bytesForRead in interface BytesStore<Bytes<Underlying>,Underlying>
    
    Returns:
    
    a slice of the existing Bytes where the start is moved to the position and the current limit determines the capacity.
    
    Throws:
    
    IllegalStateException - if the underlying BytesStore has been released
  - bytesStore
```
@Nullable
BytesStore bytesStore()
```
    Specified by:
    
    bytesStore in interface BytesStore<Bytes<Underlying>,Underlying>
    
    Returns:
    
    the ByteStore this Bytes wraps.
  - isEqual
```
default boolean isEqual(String s)
```
  - compact
```
@NotNull
Bytes<Underlying> compact()
```
    Compact these Bytes by moving the readPosition to the start.
    
    Returns:
    
    this
  - copyTo
```
default long copyTo(@NotNull
                    BytesStore store)
```
    copy bytes from one ByteStore to another
    
    Specified by:
    
    copyTo in interface BytesStore<Bytes<Underlying>,Underlying>
    
    Specified by:
    
    copyTo in interface StreamingDataInput<Bytes<Underlying>>
    
    Parameters:
    
    store - to copy to
    
    Returns:
    
    the number of bytes copied.
  - copyTo
```
default void copyTo(OutputStream out)
             throws IOException
```
    Specified by:
    
    copyTo in interface BytesStore<Bytes<Underlying>,Underlying>
    
    Specified by:
    
    copyTo in interface StreamingDataInput<Bytes<Underlying>>
    
    Throws:
    
    IOException
  - sharedMemory
```
default boolean sharedMemory()
```
    Returns:
    
    true if these Bytes use shared memory.
  - unwrite
```
default void unwrite(long fromOffset,
                     int count)
```
  - readBigDecimal
```
@NotNull
default BigDecimal readBigDecimal()
```
  - readBigInteger
```
@NotNull
default BigInteger readBigInteger()
```
  - indexOf
```
default long indexOf(@NotNull
                     Bytes source)
```
    Returns the index within this bytes of the first occurrence of the specified sub-bytes.
    
    The returned index is the smallest value k for which:
    this.startsWith(bytes, k)
    If no such value of k exists, then -1 is returned.
    Parameters:
    
    source - the sub-bytes to search for.
    
    Returns:
    
    the index of the first occurrence of the specified sub-bytes, or -1 if there is no such occurrence.
  - indexOf
```
default int indexOf(@NotNull
                    BytesStore source,
                    int fromIndex)
```
    Returns the index within this bytes of the first occurrence of the specified subbytes.
    
    The returned index is the smallest value k for which:
    this.startsWith(bytes, k)
    If no such value of k exists, then -1 is returned.
    Parameters:
    
    source - the sub-bytes to search for.
    
    fromIndex - start the seach from this offset
    
    Returns:
    
    the index of the first occurrence of the specified sub-bytes, or -1 if there is no such occurrence.
  - indexOf
```
@Deprecated
default long indexOf(@NotNull
                                 Bytes source,
                                 int fromIndex)
```
    Deprecated.
  - clear
```
@NotNull
Bytes<Underlying> clear()
```
    Description copied from interface: StreamingCommon
    
    Set the readPosition= writePosition = start, writeLimit = capacity
    
    Specified by:
    
    clear in interface StreamingCommon<Bytes<Underlying>>
    
    Returns:
    
    this
  - readWrite
```
default boolean readWrite()
```
    Specified by:
    
    readWrite in interface BytesStore<Bytes<Underlying>,Underlying>
    
    Returns:
    
    whether this BytesStore is writable.
  - readWithLength
```
default void readWithLength(long length,
                            @NotNull
                            BytesOut<Underlying> bytesOut)
                     throws BufferUnderflowException,
                            net.openhft.chronicle.core.io.IORuntimeException
```
    Throws:
    
    BufferUnderflowException
    
    net.openhft.chronicle.core.io.IORuntimeException
  - reader
```
@NotNull
default Reader reader()
```
    Access these bytes as an ISO-8859-1 encoded Reader
    
    Returns:
    
    as a Reader
  - parseBoolean
```
@Nullable
default Boolean parseBoolean(@NotNull
                                       StopCharTester tester)
```
    Return true or false, or null if it could not be detected as true or false. Case is not important
    
    false: f, false, n, no, 0
    
    true: t, true, y, yes, 1
    
    Parameters:
    
    tester - to detect the end of the text.
    
    Returns:
    
    true, false, or null if neither.
  - parseUtf8
```
@NotNull
default String parseUtf8(@NotNull
                                  StopCharTester stopCharTester)
```
    parse text with UTF-8 decoding as character terminated.
    
    Parameters:
    
    stopCharTester - to check if the end has been reached.
    
    Returns:
    
    the text as a String.
  - parseUTF
```
@NotNull
 @Deprecated
default String parseUTF(@NotNull
                                              StopCharTester stopCharTester)
```
    Deprecated.
  - parseUtf8
```
default void parseUtf8(@NotNull
                       Appendable buffer,
                       @NotNull
                       StopCharTester stopCharTester)
```
    parse text with UTF-8 decoding as character terminated.
    
    Parameters:
    
    buffer - to populate
    
    stopCharTester - to check if the end has been reached.
  - parseUTF
```
@Deprecated
default void parseUTF(@NotNull
                                  Appendable buffer,
                                  @NotNull
                                  StopCharTester stopCharTester)
```
    Deprecated.
  - parseUtf8
```
default void parseUtf8(@NotNull
                       Appendable buffer,
                       @NotNull
                       StopCharsTester stopCharsTester)
                throws BufferUnderflowException,
                       BufferOverflowException,
                       net.openhft.chronicle.core.io.IORuntimeException
```
    parse text with UTF-8 decoding as one or two character terminated.
    
    Parameters:
    
    buffer - to populate
    
    stopCharsTester - to check if the end has been reached.
    
    Throws:
    
    BufferUnderflowException
    
    BufferOverflowException
    
    net.openhft.chronicle.core.io.IORuntimeException
  - parseUTF
```
@Deprecated
default void parseUTF(@NotNull
                                  Appendable buffer,
                                  @NotNull
                                  StopCharsTester stopCharsTester)
                           throws BufferUnderflowException,
                                  BufferOverflowException,
                                  net.openhft.chronicle.core.io.IORuntimeException
```
    Deprecated.
    
    Throws:
    
    BufferUnderflowException
    
    BufferOverflowException
    
    net.openhft.chronicle.core.io.IORuntimeException
  - parse8bit
```
default void parse8bit(Appendable buffer,
                       @NotNull
                       StopCharTester stopCharTester)
                throws BufferUnderflowException,
                       BufferOverflowException
```
    parse text with ISO-8859-1 decoding as character terminated.
    
    Parameters:
    
    buffer - to populate
    
    stopCharTester - to check if the end has been reached.
    
    Throws:
    
    BufferUnderflowException
    
    BufferOverflowException
  - parse8bit
```
default void parse8bit(Appendable buffer,
                       @NotNull
                       StopCharsTester stopCharsTester)
                throws BufferUnderflowException,
                       BufferOverflowException
```
    parse text with ISO-8859-1 decoding as character terminated.
    
    Parameters:
    
    buffer - to populate
    
    stopCharsTester - to check if the end has been reached.
    
    Throws:
    
    BufferUnderflowException
    
    BufferOverflowException
  - parseLong
```
default long parseLong()
                throws BufferUnderflowException
```
    parse text as a long integer. The terminating character is consumed.
    
    Returns:
    
    a long.
    
    Throws:
    
    BufferUnderflowException
  - parseDouble
```
default double parseDouble()
                    throws BufferUnderflowException
```
    parse text as a double decimal. The terminating character is consumed.
    The number of decimal places can be retrieved with lastDecimalPlaces()
    
    Returns:
    
    a double.
    
    Throws:
    
    BufferUnderflowException
  - parseLongDecimal
```
default long parseLongDecimal()
                       throws BufferUnderflowException
```
    Parse the significant digits of a decimal number.
    The number of decimal places can be retrieved with lastDecimalPlaces()
    
    Returns:
    
    the significant digits
    
    Throws:
    
    BufferUnderflowException
  - lastDecimalPlaces
```
int lastDecimalPlaces()
```
    Returns:
    
    the last number of decimal places for parseDouble or parseLongDecimal
  - lastDecimalPlaces
```
void lastDecimalPlaces(int lastDecimalPlaces)
```
    Store the last number of decimal places. If
    
    Parameters:
    
    lastDecimalPlaces - set the number of decimal places if positive, otherwise 0.
  - skipTo
```
default boolean skipTo(@NotNull
                       StopCharTester tester)
```
    Skip text until a terminating character is reached.
    
    Parameters:
    
    tester - to stop at
    
    Returns:
    
    true if a terminating character was found, false if the end of the buffer was reached.
  - parseBigDecimal
```
@NotNull
default BigDecimal parseBigDecimal()
```

Interface Bytes<Underlying>

Field Summary

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

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

Method Summary

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

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

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

Methods inherited from interface java.lang.CharSequence

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

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

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

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

Field Detail

MAX_CAPACITY

MAX_BYTE_BUFFER_CAPACITY

DEFAULT_BYTE_BUFFER_CAPACITY

Method Detail

elasticByteBuffer

elasticByteBuffer

elasticByteBuffer

elasticHeapByteBuffer

wrapForRead

wrapForWrite

wrapForRead

wrapForWrite

from

fromString

allocateDirect

allocateElasticDirect

allocateElasticDirect

toString

toString

toString

allocateDirect

fromHexString

indexOf

unchecked

unchecked

safeLimit

isClear

realCapacity

copy

toHexString

toHexString

toHexString

isElastic

ensureCapacity

bytesForRead

bytesStore

isEqual

compact

copyTo

copyTo

sharedMemory

unwrite

readBigDecimal

readBigInteger

indexOf

indexOf

indexOf

clear

readWrite

readWithLength

reader

parseBoolean

parseUtf8

parseUTF

parseUtf8

parseUTF

parseUtf8

parseUTF

parse8bit

parse8bit

parseLong

parseDouble

parseLongDecimal

lastDecimalPlaces

lastDecimalPlaces

skipTo