AbstractBytes (OpenHFT/Chronicle-Bytes 2.20.111 API)

java.lang.Object
- net.openhft.chronicle.core.io.AbstractReferenceCounted
- - net.openhft.chronicle.bytes.AbstractBytes<Underlying>

All Implemented Interfaces:

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

Direct Known Subclasses:

MappedBytes, UncheckedBytes, VanillaBytes
```
public abstract class AbstractBytes<Underlying>
extends net.openhft.chronicle.core.io.AbstractReferenceCounted
implements Bytes<Underlying>
```

Field Summary

Fields
Modifier and Type	Field and Description
`protected @NotNull BytesStore<Bytes<Underlying>,Underlying>`	`bytesStore`
`protected boolean`	`isPresent`
`protected long`	`readPosition`
`protected long`	`writeLimit`
`protected long`	`writePosition`

Fields inherited from class net.openhft.chronicle.core.io.AbstractReferenceCounted
WARN_COUNT, WARN_NS

Fields inherited from interface net.openhft.chronicle.bytes.Bytes
DEFAULT_BYTE_BUFFER_CAPACITY, MAX_BYTE_BUFFER_CAPACITY, MAX_CAPACITY, MAX_HEAP_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 inherited from interface net.openhft.chronicle.core.io.ReferenceOwner
INIT

Method Summary

All Methods Instance Methods Concrete Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`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()`
`@NotNull AbstractBytes`	`append(double d)` Append a double in decimal notation
`int`	`byteCheckSum()` Return the bytes sum of the readable bytes.
`int`	`byteCheckSum(int start, int end)`
`int`	`byteCheckSum(long start, long end)`
`default ByteOrder`	`byteOrder()`
`@NotNull BytesStore`	`bytesStore()`
`protected void`	`bytesStore(BytesStore<Bytes<Underlying>,Underlying> bytesStore)`
`boolean`	`canReadDirect(long length)`
`boolean`	`canWriteDirect(long count)`
`long`	`capacity()`
`@NotNull Bytes<Underlying>`	`clear()` Set the readPosition= writePosition = start, writeLimit = capacity
`@NotNull Bytes<Underlying>`	`clearAndPad(long length)` Clear a buffer, with a given padding to allow for prepending later.
`@NotNull Bytes<Underlying>`	`compact()` Compact these Bytes by moving the readPosition to the start.
`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.
`boolean`	`compareAndSwapInt(long offset, int expected, int value)` Perform a 32-bit CAS at a given offset.
`boolean`	`compareAndSwapLong(long offset, long expected, long value)` Perform a 64-bit CAS at a given offset.
`boolean`	`equals(Object obj)`
`int`	`hashCode()`
`boolean`	`isDirectMemory()`
`boolean`	`isPresent()`
`void`	`isPresent(boolean isPresent)` Clear and set the flag for present.
`int`	`lastDecimalPlaces()`
`void`	`lastDecimalPlaces(int lastDecimalPlaces)` Store the last number of decimal places.
`boolean`	`lenient()`
`void`	`lenient(boolean lenient)` When there is no more data to read, return zero, false and empty string.
`void`	`move(long from, long to, long length)`
`void`	`nativeRead(long address, long size)` This is an expert level method for copying raw native memory in bulk.
`void`	`nativeRead(long position, long address, long size)` expert level method for copying data to native memory.
`void`	`nativeWrite(long address, long size)` This is an expert level method for writing out data to native memory.
`void`	`nativeWrite(long address, long position, long size)` expert level method to copy data from native memory into the BytesStore
`default void`	`parse8bit(Appendable buffer, @NotNull StopCharsTester stopCharsTester)` parse text with ISO-8859-1 decoding as character terminated.
`default void`	`parse8bit(Appendable buffer, @NotNull StopCharTester stopCharTester)` parse text with ISO-8859-1 decoding as character terminated.
`default void`	`parse8bit(Bytes buffer, @NotNull StopCharsTester stopCharsTester)`
`default String`	`parse8bit(@NotNull StopCharTester stopCharTester)` parse text with ISO-8859-1 decoding as character terminated.
`default void`	`parse8bit(StringBuilder buffer, @NotNull StopCharsTester stopCharsTester)`
`default @NotNull BigDecimal`	`parseBigDecimal()`
`default @Nullable Boolean`	`parseBoolean()`
`default @Nullable Boolean`	`parseBoolean(@NotNull 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 float`	`parseFloat()` parse text as a float decimal.
`default int`	`parseInt()` parse text as an int.
`default long`	`parseLong()` parse text as a long integer.
`default long`	`parseLongDecimal()` Parse the significant digits of a decimal number.
`default void`	`parseUTF(@NotNull Appendable buffer, @NotNull StopCharsTester stopCharsTester)` Deprecated.
`default void`	`parseUTF(@NotNull Appendable buffer, @NotNull StopCharTester stopCharTester)` Deprecated.
`default @NotNull String`	`parseUTF(@NotNull StopCharTester stopCharTester)` Deprecated.
`default void`	`parseUtf8(@NotNull Appendable buffer, @NotNull StopCharsTester stopCharsTester)` parse text with UTF-8 decoding as one or two character terminated.
`default void`	`parseUtf8(@NotNull Appendable buffer, @NotNull StopCharTester stopCharTester)` parse text with UTF-8 decoding as character terminated.
`default @NotNull String`	`parseUtf8(@NotNull StopCharTester stopCharTester)` parse text with UTF-8 decoding as character terminated.
`int`	`peekUnsignedByte()`
`int`	`peekUnsignedByte(long offset)` Read an unsigned byte at an offset, or -1
`protected void`	`performRelease()`
`@NotNull Bytes<Underlying>`	`prewrite(@NotNull byte[] bytes)` Write backward in binary a byte
`@NotNull Bytes<Underlying>`	`prewrite(@NotNull BytesStore bytes)` Write backward in binary a byte
`@NotNull Bytes<Underlying>`	`prewriteByte(byte i8)` Write backward in binary a byte
`@NotNull Bytes<Underlying>`	`prewriteInt(int i)` Write backward in binary a 4 byte int
`@NotNull Bytes<Underlying>`	`prewriteLong(long l)` Write backward in binary an 8 byte long
`protected long`	`prewriteOffsetPositionMoved(long subtracting)`
`@NotNull Bytes<Underlying>`	`prewriteShort(short i)` Write backward in binary a 2 byte int
`byte`	`readByte()`
`byte`	`readByte(long offset)` Read byte at an offset
`double`	`readDouble()`
`double`	`readDouble(long offset)` Read a double at an offset
`default @NotNull Reader`	`reader()` Access these bytes as an ISO-8859-1 encoded Reader
`float`	`readFloat()`
`float`	`readFloat(long offset)` Read a float at an offset
`int`	`readInt()`
`int`	`readInt(long offset)` Read an int at an offset
`long`	`readLimit()`
`@NotNull Bytes<Underlying>`	`readLimit(long limit)`
`long`	`readLong()`
`long`	`readLong(long offset)` Read a long at an offset
`protected long`	`readOffsetPositionMoved(long adding)`
`long`	`readPosition()` The read position must be start() <= readPosition() && readPosition() <= readLimit() && readPosition < safeLimit()
`@NotNull Bytes<Underlying>`	`readPosition(long position)`
`default long`	`readRemaining()`
`short`	`readShort()`
`short`	`readShort(long offset)` Read a short at an offset
`@NotNull Bytes<Underlying>`	`readSkip(long bytesToSkip)` Skip a number of bytes by moving the readPosition.
`int`	`readUnsignedByte()`
`int`	`readUnsignedByte(long offset)` Read an unsigned byte at an offset
`byte`	`readVolatileByte(long offset)` Read a 8-bit byte from memory with a load barrier.
`int`	`readVolatileInt()`
`int`	`readVolatileInt(long offset)` Read a 32-bit int from memory with a load barrier.
`long`	`readVolatileLong()`
`long`	`readVolatileLong(long offset)` Read a 64-bit long from memory with a load barrier.
`short`	`readVolatileShort(long offset)` Read a 16-bit short from memory with a load barrier.
`long`	`realCapacity()` Returns the actual capacity that can be potentially read.
`long`	`realWriteRemaining()`
`protected int`	`safeCopySize()`
`default boolean`	`skipTo(@NotNull StopCharTester tester)` Skip text until a terminating character is reached.
`long`	`start()`
`void`	`testAndSetInt(long offset, int expected, int value)`
`@NotNull String`	`toString()`
`void`	`uncheckedReadSkipBackOne()` Read skip -1 when you are sure this is safe.
`void`	`uncheckedReadSkipOne()` Read skip 1 when you are sure this is safe.
`int`	`uncheckedReadUnsignedByte()`
`Underlying`	`underlyingObject()`
`@NotNull Bytes<Underlying>`	`write(@NotNull byte[] bytes, int offset, int length)` Write all data or fail.
`@NotNull Bytes<Underlying>`	`write(long offsetInRDO, byte[] bytes, int offset, int length)`
`void`	`write(long offsetInRDO, ByteBuffer bytes, int offset, int length)` Deprecated.
`@NotNull Bytes<Underlying>`	`write(long writeOffset, RandomDataInput bytes, long readOffset, long length)`
`@NotNull Bytes<Underlying>`	`write(@NotNull RandomDataInput bytes)` Write all data or fail.
`@NotNull Bytes<Underlying>`	`writeByte(byte i8)`
`@NotNull Bytes<Underlying>`	`writeByte(long offset, byte i)` Write an unsigned byte at an offset.
`@NotNull Bytes<Underlying>`	`writeDouble(double d)`
`@NotNull Bytes<Underlying>`	`writeDouble(long offset, double d)` Write a double at an offset.
`@NotNull Bytes<Underlying>`	`writeDoubleAndInt(double d, int i)`
`@NotNull Bytes<Underlying>`	`writeFloat(float f)`
`@NotNull Bytes<Underlying>`	`writeFloat(long offset, float d)` Write a float at an offset.
`@NotNull Bytes<Underlying>`	`writeInt(int i)`
`@NotNull Bytes<Underlying>`	`writeInt(long offset, int i)` Write an int at an offset.
`@NotNull Bytes<Underlying>`	`writeIntAdv(int i, int advance)`
`long`	`writeLimit()`
`@NotNull Bytes<Underlying>`	`writeLimit(long limit)`
`@NotNull Bytes<Underlying>`	`writeLong(long i64)` Write a long
`@NotNull Bytes<Underlying>`	`writeLong(long offset, long i)` Write a long at an offset.
`@NotNull Bytes<Underlying>`	`writeLongAdv(long i64, int advance)`
`protected long`	`writeOffsetPositionMoved(long adding)`
`protected long`	`writeOffsetPositionMoved(long adding, long advance)`
`@NotNull Bytes<Underlying>`	`writeOrderedInt(int i)`
`@NotNull Bytes<Underlying>`	`writeOrderedInt(long offset, int i)` Perform a non stalling write with a store barrier.
`@NotNull Bytes<Underlying>`	`writeOrderedLong(long i)`
`@NotNull Bytes<Underlying>`	`writeOrderedLong(long offset, long i)` Perform a non stalling write with a store barrier.
`long`	`writePosition()` The read position must be readPosition() <= writePosition() && writePosition() <= writeLimit()
`@NotNull Bytes<Underlying>`	`writePosition(long position)`
`default long`	`writeRemaining()`
`@NotNull Bytes<Underlying>`	`writeShort(long offset, short i)` Write a short at an offset.
`@NotNull Bytes<Underlying>`	`writeShort(short i16)`
`@NotNull Bytes<Underlying>`	`writeSkip(long bytesToSkip)` Skip a number of bytes by moving the writePosition.
`@NotNull Bytes<Underlying>`	`writeSome(@NotNull ByteBuffer buffer)`
`@NotNull Bytes<Underlying>`	`writeVolatileByte(long offset, byte i8)`
`@NotNull Bytes<Underlying>`	`writeVolatileInt(long offset, int i32)`
`@NotNull Bytes<Underlying>`	`writeVolatileLong(long offset, long i64)`
`@NotNull Bytes<Underlying>`	`writeVolatileShort(long offset, short i16)`

Methods inherited from class net.openhft.chronicle.core.io.AbstractReferenceCounted
assertReferencesReleased, createdHere, disableReferenceTracing, enableReferenceTracing, performReleaseInBackground, refCount, referenceId, release, releaseLast, reserve, reservedBy, reserveTransfer, threadSafetyCheck, throwExceptionIfNotReleased, throwExceptionIfReleased, tryReserve, unmonitor, warnAndReleaseIfNotReleased

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.openhft.chronicle.bytes.Bytes
allocateDirect, allocateDirect, allocateElasticDirect, allocateElasticDirect, allocateElasticOnHeap, allocateElasticOnHeap, bytesForRead, copy, copyTo, copyTo, directFrom, elasticByteBuffer, elasticByteBuffer, elasticByteBuffer, elasticHeapByteBuffer, elasticHeapByteBuffer, ensureCapacity, from, from, fromHexString, fromString, indexOf, indexOf, indexOf, indexOf, isClear, isElastic, isEqual, readBigDecimal, readBigInteger, readMarshallableLength16, readWithLength, readWrite, safeLimit, sharedMemory, toHexString, toHexString, toHexString, toString, toString, toString, unchecked, unchecked, unwrite, valueOf, wrapForRead, wrapForRead, wrapForWrite, wrapForWrite, write, writeMarshallableLength16

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

Methods inherited from interface net.openhft.chronicle.bytes.RandomDataOutput
append, append, write, write, writeBoolean, writeByte, writeInt24, writeOrderedDouble, writeOrderedFloat, writeUnsignedByte, writeUnsignedInt, writeUnsignedShort, writeUtf8, writeUtf8Limited, writeVolatileDouble, writeVolatileFloat

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

Methods inherited from interface net.openhft.chronicle.bytes.BytesIn
bytesMethodReader, bytesMethodReaderBuilder, readObject

Methods inherited from interface net.openhft.chronicle.bytes.RandomDataInput
addAndGetDouble, addAndGetFloat, addAndGetInt, addAndGetLong, compareUtf8, copyTo, copyTo, createCharToString, fastHash, findByte, parseLong, peekVolatileInt, printable, read, readBoolean, readIncompleteLong, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8Limited, readUtf8Limited, readVolatileDouble, readVolatileFloat, subBytes, toByteArray, toTemporaryDirectByteBuffer

Methods inherited from interface net.openhft.chronicle.bytes.StreamingDataInput
inputStream, parseHexLong, parseUTF, parseUtf8, parseUtf8, rawReadByte, rawReadInt, rawReadLong, read, read, read, read, read, read8bit, read8bit, read8bit, read8bit, readBoolean, readChar, readEnum, readHistogram, readIncompleteLong, readInt24, readLimitToCapacity, readPositionRemaining, readPositionUnlimited, readStopBit, readStopBitChar, readStopBitDecimal, readStopBitDouble, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8, readUTFΔ, readUTFΔ, readWithLength, readWithLength, readWithLength0, unsafeReadObject, unsafeReadObject

Methods inherited from interface net.openhft.chronicle.bytes.BytesOut
bytesMethodWriter, bytesMethodWriterBuilder, writeObject

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

Methods inherited from interface net.openhft.chronicle.bytes.StreamingDataOutput
alignBy, appendUtf8, appendUtf8, appendUtf8, appendUtf8, appendUtf8, appendUtf8, copyFrom, outputStream, rawWriteByte, rawWriteInt, rawWriteLong, unsafeWriteObject, unsafeWriteObject, write, write, write, write, write, write, write8bit, write8bit, write8bit, write8bit, writeBigDecimal, writeBigInteger, writeBoolean, writeChar, writeEnum, writeHistogram, writeInt24, writePositionRemaining, writeSome, writeStopBit, writeStopBit, writeStopBit, writeStopBitDecimal, writeUnsignedByte, writeUnsignedInt, writeUnsignedInt24, writeUnsignedShort, writeUtf8, writeUtf8, writeUTFΔ, writeWithLength

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 net.openhft.chronicle.bytes.BytesPrepender
prepend

Methods inherited from interface net.openhft.chronicle.bytes.BytesComment
comment, indent, retainsComments

Methods inherited from interface net.openhft.chronicle.core.io.ReferenceCountedTracer
onReleased, onReleased

- Field Detail
  - bytesStore
```
@NotNull
protected @NotNull BytesStore<Bytes<Underlying>,Underlying> bytesStore
```
  - readPosition
```
protected long readPosition
```
  - writePosition
```
protected long writePosition
```
  - writeLimit
```
protected long writeLimit
```
  - isPresent
```
protected boolean isPresent
```
- Method Detail
  - isDirectMemory
```
public boolean isDirectMemory()
```
    Specified by:
    
    isDirectMemory in interface BytesStore<Bytes<Underlying>,Underlying>
    
    Returns:
    
    whether it uses direct memory or not.
  - canReadDirect
```
public boolean canReadDirect(long length)
```
    Specified by:
    
    canReadDirect in interface RandomDataInput
  - move
```
public void move(long from,
                 long to,
                 long length)
          throws BufferUnderflowException
```
    Specified by:
    
    move in interface BytesStore<Bytes<Underlying>,Underlying>
    
    Throws:
    
    BufferUnderflowException
  - compact
```
@NotNull
public @NotNull Bytes<Underlying> compact()
```
    Description copied from interface: Bytes
    
    Compact these Bytes by moving the readPosition to the start.
    
    Specified by:
    
    compact in interface Bytes<Underlying>
    
    Returns:
    
    this
  - isPresent
```
public void isPresent(boolean isPresent)
```
    Description copied from interface: BytesStore
    
    Clear and set the flag for present.
    
    Specified by:
    
    isPresent in interface BytesStore<Bytes<Underlying>,Underlying>
    
    Parameters:
    
    isPresent - if there is data, or false if not.
  - isPresent
```
public boolean isPresent()
```
    Specified by:
    
    isPresent in interface BytesStore<Bytes<Underlying>,Underlying>
    
    Returns:
    
    if there is data, or false if not.
  - clear
```
@NotNull
public @NotNull Bytes<Underlying> clear()
```
    Description copied from interface: StreamingCommon
    
    Set the readPosition= writePosition = start, writeLimit = capacity
    
    Specified by:
    
    clear in interface Bytes<Underlying>
    
    Specified by:
    
    clear in interface StreamingCommon<Bytes<Underlying>>
    
    Returns:
    
    this
  - clearAndPad
```
@NotNull
public @NotNull Bytes<Underlying> clearAndPad(long length)
                                                throws BufferOverflowException
```
    Description copied from interface: BytesPrepender
    
    Clear a buffer, with a given padding to allow for prepending later. clearAndPad(0) is the same as clear()
    
    Specified by:
    
    clearAndPad in interface BytesPrepender<Bytes<Underlying>>
    
    Parameters:
    
    length - to pad
    
    Returns:
    
    this
    
    Throws:
    
    BufferOverflowException - if the length > capacity() - start()
  - readLimit
```
public long readLimit()
```
    Returns:
    
    the highest offset or position allowed for this buffer.
  - writeLimit
```
public long writeLimit()
```
  - realCapacity
```
public long realCapacity()
```
    Description copied from interface: RandomDataInput
    
    Returns the actual capacity that can be potentially read.
    
    Specified by:
    
    realCapacity in interface Bytes<Underlying>
    
    Specified by:
    
    realCapacity in interface BytesStore<Bytes<Underlying>,Underlying>
    
    Specified by:
    
    realCapacity in interface RandomDataInput
    
    Specified by:
    
    realCapacity in interface StreamingDataOutput<Bytes<Underlying>>
    
    Returns:
    
    the actual capacity available before resizing.
  - realWriteRemaining
```
public long realWriteRemaining()
```
    Specified by:
    
    realWriteRemaining in interface StreamingDataOutput<Bytes<Underlying>>
    
    Returns:
    
    writeRemaining with resize
  - canWriteDirect
```
public boolean canWriteDirect(long count)
```
    Specified by:
    
    canWriteDirect in interface StreamingDataOutput<Bytes<Underlying>>
  - capacity
```
public long capacity()
```
    Specified by:
    
    capacity in interface BytesStore<Bytes<Underlying>,Underlying>
    
    Returns:
    
    The maximum limit you can set.
  - underlyingObject
```
@Nullable
public Underlying underlyingObject()
```
    Specified by:
    
    underlyingObject in interface BytesStore<Bytes<Underlying>,Underlying>
    
    Returns:
    
    the underlying object being wrapped, if there is one, or null if not.
  - start
```
public long start()
```
    Returns:
    
    The smallest position allowed in this buffer.
  - readPosition
```
public long readPosition()
```
    The read position must be start() <= readPosition() && readPosition() <= readLimit() && readPosition < safeLimit()
    
    Returns:
    
    position to read from.
  - writePosition
```
public long writePosition()
```
    The read position must be readPosition() <= writePosition() && writePosition() <= writeLimit()
    
    Returns:
    
    position to write to.
  - compareAndSwapInt
```
public boolean compareAndSwapInt(long offset,
                                 int expected,
                                 int value)
                          throws BufferOverflowException
```
    Perform a 32-bit CAS at a given offset.
    
    Parameters:
    
    offset - to perform CAS
    
    expected - value
    
    value - to set
    
    Returns:
    
    true, if successful.
    
    Throws:
    
    BufferOverflowException
  - testAndSetInt
```
public void testAndSetInt(long offset,
                          int expected,
                          int value)
```
  - compareAndSwapLong
```
public boolean compareAndSwapLong(long offset,
                                  long expected,
                                  long value)
                           throws BufferOverflowException
```
    Perform a 64-bit CAS at a given offset.
    
    Parameters:
    
    offset - to perform CAS
    
    expected - value
    
    value - to set
    
    Returns:
    
    true, if successful.
    
    Throws:
    
    BufferOverflowException
  - append
```
@NotNull
public @NotNull AbstractBytes append(double d)
                                       throws BufferOverflowException
```
    Description copied from interface: ByteStringAppender
    
    Append a double in decimal notation
    
    Specified by:
    
    append in interface ByteStringAppender<Bytes<Underlying>>
    
    Parameters:
    
    d - to append
    
    Returns:
    
    this
    
    Throws:
    
    BufferOverflowException
  - readPosition
```
@NotNull
public @NotNull Bytes<Underlying> readPosition(long position)
                                                 throws BufferUnderflowException
```
    Throws:
    
    BufferUnderflowException
  - readLimit
```
@NotNull
public @NotNull Bytes<Underlying> readLimit(long limit)
                                              throws BufferUnderflowException
```
    Throws:
    
    BufferUnderflowException
  - writePosition
```
@NotNull
public @NotNull Bytes<Underlying> writePosition(long position)
                                                  throws BufferOverflowException
```
    Specified by:
    
    writePosition in interface StreamingDataOutput<Bytes<Underlying>>
    
    Throws:
    
    BufferOverflowException
  - readSkip
```
@NotNull
public @NotNull Bytes<Underlying> readSkip(long bytesToSkip)
                                             throws BufferUnderflowException
```
    Description copied from interface: StreamingDataInput
    
    Skip a number of bytes by moving the readPosition. Must be less than or equal to the readLimit.
    
    Parameters:
    
    bytesToSkip - bytes to skip.
    
    Returns:
    
    this
    
    Throws:
    
    BufferUnderflowException - if the offset is outside the limits of the Bytes
  - uncheckedReadSkipOne
```
public void uncheckedReadSkipOne()
```
    Description copied from interface: StreamingDataInput
    
    Read skip 1 when you are sure this is safe. Use at your own risk when you find a performance problem.
  - uncheckedReadSkipBackOne
```
public void uncheckedReadSkipBackOne()
```
    Description copied from interface: StreamingDataInput
    
    Read skip -1 when you are sure this is safe. Use at your own risk when you find a performance problem.
  - writeSkip
```
@NotNull
public @NotNull Bytes<Underlying> writeSkip(long bytesToSkip)
                                              throws BufferOverflowException
```
    Description copied from interface: StreamingDataOutput
    
    Skip a number of bytes by moving the writePosition. Must be less than or equal to the writeLimit.
    
    Specified by:
    
    writeSkip in interface StreamingDataOutput<Bytes<Underlying>>
    
    Parameters:
    
    bytesToSkip - bytes to skip.
    
    Returns:
    
    this
    
    Throws:
    
    BufferOverflowException - if the offset is outside the limits of the Bytes
  - writeLimit
```
@NotNull
public @NotNull Bytes<Underlying> writeLimit(long limit)
                                               throws BufferOverflowException
```
    Specified by:
    
    writeLimit in interface StreamingDataOutput<Bytes<Underlying>>
    
    Throws:
    
    BufferOverflowException
  - performRelease
```
protected void performRelease()
                       throws IllegalStateException
```
    Specified by:
    
    performRelease in class net.openhft.chronicle.core.io.AbstractReferenceCounted
    
    Throws:
    
    IllegalStateException
  - readUnsignedByte
```
public int readUnsignedByte()
```
    Returns:
    
    the next unsigned 8 bit value or -1;
  - readUnsignedByte
```
public int readUnsignedByte(long offset)
                     throws BufferUnderflowException
```
    Description copied from interface: RandomDataInput
    
    Read an unsigned byte at an offset
    
    Specified by:
    
    readUnsignedByte in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the unsigned byte
    
    Throws:
    
    BufferUnderflowException - if the offset is outside the limits of the Bytes
  - uncheckedReadUnsignedByte
```
public int uncheckedReadUnsignedByte()
```
    Returns:
    
    the next unsigned 8 bit value or -1;
  - readByte
```
public byte readByte()
```
  - peekUnsignedByte
```
public int peekUnsignedByte()
```
  - readShort
```
public short readShort()
                throws BufferUnderflowException
```
    Throws:
    
    BufferUnderflowException
  - readInt
```
public int readInt()
            throws BufferUnderflowException
```
    Throws:
    
    BufferUnderflowException
  - readVolatileByte
```
public byte readVolatileByte(long offset)
                      throws BufferUnderflowException
```
    Description copied from interface: RandomDataInput
    
    Read a 8-bit byte from memory with a load barrier.
    
    Specified by:
    
    readVolatileByte in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the byte value
    
    Throws:
    
    BufferUnderflowException - if the offset is outside the limits of the Bytes
  - readVolatileShort
```
public short readVolatileShort(long offset)
                        throws BufferUnderflowException
```
    Description copied from interface: RandomDataInput
    
    Read a 16-bit short from memory with a load barrier.
    
    Specified by:
    
    readVolatileShort in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the short value
    
    Throws:
    
    BufferUnderflowException - if the offset is outside the limits of the Bytes
  - readVolatileInt
```
public int readVolatileInt(long offset)
                    throws BufferUnderflowException
```
    Description copied from interface: RandomDataInput
    
    Read a 32-bit int from memory with a load barrier.
    
    Specified by:
    
    readVolatileInt in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the int value
    
    Throws:
    
    BufferUnderflowException - if the offset is outside the limits of the Bytes
  - readVolatileLong
```
public long readVolatileLong(long offset)
                      throws BufferUnderflowException
```
    Description copied from interface: RandomDataInput
    
    Read a 64-bit long from memory with a load barrier.
    
    Specified by:
    
    readVolatileLong in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the long value
    
    Throws:
    
    BufferUnderflowException - if the offset is outside the limits of the Bytes
  - readLong
```
public long readLong()
              throws BufferUnderflowException
```
    Throws:
    
    BufferUnderflowException
  - readFloat
```
public float readFloat()
                throws BufferUnderflowException
```
    Throws:
    
    BufferUnderflowException
  - readDouble
```
public double readDouble()
                  throws BufferUnderflowException
```
    Throws:
    
    BufferUnderflowException
  - readVolatileInt
```
public int readVolatileInt()
                    throws BufferUnderflowException
```
    Throws:
    
    BufferUnderflowException
  - readVolatileLong
```
public long readVolatileLong()
                      throws BufferUnderflowException
```
    Throws:
    
    BufferUnderflowException
  - readOffsetPositionMoved
```
protected long readOffsetPositionMoved(long adding)
                                throws BufferUnderflowException
```
    Throws:
    
    BufferUnderflowException
  - writeByte
```
@NotNull
public @NotNull Bytes<Underlying> writeByte(long offset,
                                                     byte i)
                                              throws BufferOverflowException
```
    Description copied from interface: RandomDataOutput
    
    Write an unsigned byte at an offset.
    
    Specified by:
    
    writeByte in interface RandomDataOutput<Bytes<Underlying>>
    
    Parameters:
    
    offset - to write to
    
    i - the value
    
    Returns:
    
    this
    
    Throws:
    
    BufferOverflowException - if the capacity was exceeded
  - writeShort
```
@NotNull
public @NotNull Bytes<Underlying> writeShort(long offset,
                                                      short i)
                                               throws BufferOverflowException
```
    Description copied from interface: RandomDataOutput
    
    Write a short at an offset.
    
    Specified by:
    
    writeShort in interface RandomDataOutput<Bytes<Underlying>>
    
    Parameters:
    
    offset - to write to
    
    i - the value
    
    Returns:
    
    this
    
    Throws:
    
    BufferOverflowException - if the capacity was exceeded
  - writeInt
```
@NotNull
public @NotNull Bytes<Underlying> writeInt(long offset,
                                                    int i)
                                             throws BufferOverflowException
```
    Description copied from interface: RandomDataOutput
    
    Write an int at an offset.
    
    Specified by:
    
    writeInt in interface RandomDataOutput<Bytes<Underlying>>
    
    Parameters:
    
    offset - to write to
    
    i - the value
    
    Returns:
    
    this
    
    Throws:
    
    BufferOverflowException - if the capacity was exceeded
  - writeOrderedInt
```
@NotNull
public @NotNull Bytes<Underlying> writeOrderedInt(long offset,
                                                           int i)
                                                    throws BufferOverflowException
```
    Description copied from interface: RandomDataOutput
    
    Perform a non stalling write with a store barrier.
    
    Specified by:
    
    writeOrderedInt in interface RandomDataOutput<Bytes<Underlying>>
    
    Parameters:
    
    offset - to write to
    
    i - value to write
    
    Returns:
    
    this
    
    Throws:
    
    BufferOverflowException - if the capacity was exceeded
  - writeLong
```
@NotNull
public @NotNull Bytes<Underlying> writeLong(long offset,
                                                     long i)
                                              throws BufferOverflowException
```
    Description copied from interface: RandomDataOutput
    
    Write a long at an offset.
    
    Specified by:
    
    writeLong in interface RandomDataOutput<Bytes<Underlying>>
    
    Parameters:
    
    offset - to write to
    
    i - the value
    
    Returns:
    
    this
    
    Throws:
    
    BufferOverflowException - if the capacity was exceeded
  - writeOrderedLong
```
@NotNull
public @NotNull Bytes<Underlying> writeOrderedLong(long offset,
                                                            long i)
                                                     throws BufferOverflowException
```
    Description copied from interface: RandomDataOutput
    
    Perform a non stalling write with a store barrier.
    
    Specified by:
    
    writeOrderedLong in interface RandomDataOutput<Bytes<Underlying>>
    
    Parameters:
    
    offset - to write to
    
    i - value to write
    
    Returns:
    
    this
    
    Throws:
    
    BufferOverflowException
  - writeFloat
```
@NotNull
public @NotNull Bytes<Underlying> writeFloat(long offset,
                                                      float d)
                                               throws BufferOverflowException
```
    Description copied from interface: RandomDataOutput
    
    Write a float at an offset.
    
    Specified by:
    
    writeFloat in interface RandomDataOutput<Bytes<Underlying>>
    
    Parameters:
    
    offset - to write to
    
    d - the value
    
    Returns:
    
    this
    
    Throws:
    
    BufferOverflowException - if the capacity was exceeded
  - writeDouble
```
@NotNull
public @NotNull Bytes<Underlying> writeDouble(long offset,
                                                       double d)
                                                throws BufferOverflowException
```
    Description copied from interface: RandomDataOutput
    
    Write a double at an offset.
    
    Specified by:
    
    writeDouble in interface RandomDataOutput<Bytes<Underlying>>
    
    Parameters:
    
    offset - to write to
    
    d - the value
    
    Returns:
    
    this
    
    Throws:
    
    BufferOverflowException - if the capacity was exceeded
  - writeVolatileByte
```
@NotNull
public @NotNull Bytes<Underlying> writeVolatileByte(long offset,
                                                             byte i8)
                                                      throws BufferOverflowException
```
    Specified by:
    
    writeVolatileByte in interface RandomDataOutput<Bytes<Underlying>>
    
    Throws:
    
    BufferOverflowException
  - writeVolatileShort
```
@NotNull
public @NotNull Bytes<Underlying> writeVolatileShort(long offset,
                                                              short i16)
                                                       throws BufferOverflowException
```
    Specified by:
    
    writeVolatileShort in interface RandomDataOutput<Bytes<Underlying>>
    
    Throws:
    
    BufferOverflowException
  - writeVolatileInt
```
@NotNull
public @NotNull Bytes<Underlying> writeVolatileInt(long offset,
                                                            int i32)
                                                     throws BufferOverflowException
```
    Specified by:
    
    writeVolatileInt in interface RandomDataOutput<Bytes<Underlying>>
    
    Throws:
    
    BufferOverflowException
  - writeVolatileLong
```
@NotNull
public @NotNull Bytes<Underlying> writeVolatileLong(long offset,
                                                             long i64)
                                                      throws BufferOverflowException
```
    Specified by:
    
    writeVolatileLong in interface RandomDataOutput<Bytes<Underlying>>
    
    Throws:
    
    BufferOverflowException
  - write
```
@NotNull
public @NotNull Bytes<Underlying> write(@NotNull
                                                 @NotNull RandomDataInput bytes)
```
    Description copied from interface: StreamingDataOutput
    
    Write all data or fail.
    
    Specified by:
    
    write in interface StreamingDataOutput<Bytes<Underlying>>
  - write
```
@NotNull
public @NotNull Bytes<Underlying> write(long offsetInRDO,
                                                 byte[] bytes,
                                                 int offset,
                                                 int length)
                                          throws BufferOverflowException
```
    Specified by:
    
    write in interface RandomDataOutput<Bytes<Underlying>>
    
    Throws:
    
    BufferOverflowException
  - write
```
@Deprecated
public void write(long offsetInRDO,
                              ByteBuffer bytes,
                              int offset,
                              int length)
                       throws BufferOverflowException
```
    Deprecated.
    
    Specified by:
    
    write in interface RandomDataOutput<Bytes<Underlying>>
    
    Throws:
    
    BufferOverflowException
  - write
```
@NotNull
public @NotNull Bytes<Underlying> write(long writeOffset,
                                                 RandomDataInput bytes,
                                                 long readOffset,
                                                 long length)
                                          throws BufferOverflowException,
                                                 BufferUnderflowException
```
    Specified by:
    
    write in interface RandomDataOutput<Bytes<Underlying>>
    
    Throws:
    
    BufferOverflowException
    
    BufferUnderflowException
  - readByte
```
public byte readByte(long offset)
              throws BufferUnderflowException
```
    Description copied from interface: RandomDataInput
    
    Read byte at an offset
    
    Specified by:
    
    readByte in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the byte
    
    Throws:
    
    BufferUnderflowException - if the offset is outside the limits of the Bytes
  - peekUnsignedByte
```
public int peekUnsignedByte(long offset)
                     throws BufferUnderflowException
```
    Description copied from interface: RandomDataInput
    
    Read an unsigned byte at an offset, or -1
    
    Specified by:
    
    peekUnsignedByte in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the unsigned byte or -1
    
    Throws:
    
    BufferUnderflowException
  - readShort
```
public short readShort(long offset)
                throws BufferUnderflowException
```
    Description copied from interface: RandomDataInput
    
    Read a short at an offset
    
    Specified by:
    
    readShort in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the short
    
    Throws:
    
    BufferUnderflowException - if the offset is outside the limits of the Bytes
  - readInt
```
public int readInt(long offset)
            throws BufferUnderflowException
```
    Description copied from interface: RandomDataInput
    
    Read an int at an offset
    
    Specified by:
    
    readInt in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the int
    
    Throws:
    
    BufferUnderflowException - if the offset is outside the limits of the Bytes
  - readLong
```
public long readLong(long offset)
              throws BufferUnderflowException
```
    Description copied from interface: RandomDataInput
    
    Read a long at an offset
    
    Specified by:
    
    readLong in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the long
    
    Throws:
    
    BufferUnderflowException - if the offset is outside the limits of the Bytes
  - readFloat
```
public float readFloat(long offset)
                throws BufferUnderflowException
```
    Description copied from interface: RandomDataInput
    
    Read a float at an offset
    
    Specified by:
    
    readFloat in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the float
    
    Throws:
    
    BufferUnderflowException - if the offset is outside the limits of the Bytes
  - readDouble
```
public double readDouble(long offset)
                  throws BufferUnderflowException
```
    Description copied from interface: RandomDataInput
    
    Read a double at an offset
    
    Specified by:
    
    readDouble in interface RandomDataInput
    
    Parameters:
    
    offset - to read
    
    Returns:
    
    the double
    
    Throws:
    
    BufferUnderflowException - if the offset is outside the limits of the Bytes
  - writeByte
```
@NotNull
public @NotNull Bytes<Underlying> writeByte(byte i8)
                                              throws BufferOverflowException
```
    Specified by:
    
    writeByte in interface StreamingDataOutput<Bytes<Underlying>>
    
    Throws:
    
    BufferOverflowException
  - prewrite
```
@NotNull
public @NotNull Bytes<Underlying> prewrite(@NotNull
                                                    @NotNull byte[] bytes)
                                             throws BufferOverflowException
```
    Description copied from interface: BytesPrepender
    
    Write backward in binary a byte
    Note: it moves the readPosition not the writePosition / readLimit
    
    Specified by:
    
    prewrite in interface BytesPrepender<Bytes<Underlying>>
    
    Parameters:
    
    bytes - to prepend to.
    
    Throws:
    
    BufferOverflowException
  - prewrite
```
@NotNull
public @NotNull Bytes<Underlying> prewrite(@NotNull
                                                    @NotNull BytesStore bytes)
                                             throws BufferOverflowException
```
    Description copied from interface: BytesPrepender
    
    Write backward in binary a byte
    Note: it moves the readPosition not the writePosition / readLimit
    
    Specified by:
    
    prewrite in interface BytesPrepender<Bytes<Underlying>>
    
    Parameters:
    
    bytes - to prepend to.
    
    Throws:
    
    BufferOverflowException
  - prewriteByte
```
@NotNull
public @NotNull Bytes<Underlying> prewriteByte(byte i8)
                                                 throws BufferOverflowException
```
    Description copied from interface: BytesPrepender
    
    Write backward in binary a byte
    Note: it moves the readPosition not the writePosition / readLimit
    
    Specified by:
    
    prewriteByte in interface BytesPrepender<Bytes<Underlying>>
    
    Parameters:
    
    i8 - byte to prepend to.
    
    Throws:
    
    BufferOverflowException
  - prewriteInt
```
@NotNull
public @NotNull Bytes<Underlying> prewriteInt(int i)
                                                throws BufferOverflowException
```
    Description copied from interface: BytesPrepender
    
    Write backward in binary a 4 byte int
    Note: it moves the readPosition not the writePosition / readLimit
    
    Specified by:
    
    prewriteInt in interface BytesPrepender<Bytes<Underlying>>
    
    Parameters:
    
    i - integer to prepend to.
    
    Throws:
    
    BufferOverflowException
  - prewriteShort
```
@NotNull
public @NotNull Bytes<Underlying> prewriteShort(short i)
                                                  throws BufferOverflowException
```
    Description copied from interface: BytesPrepender
    
    Write backward in binary a 2 byte int
    Note: it moves the readPosition not the writePosition / readLimit
    
    Specified by:
    
    prewriteShort in interface BytesPrepender<Bytes<Underlying>>
    
    Parameters:
    
    i - short to prepend to.
    
    Throws:
    
    BufferOverflowException
  - prewriteLong
```
@NotNull
public @NotNull Bytes<Underlying> prewriteLong(long l)
                                                 throws BufferOverflowException
```
    Description copied from interface: BytesPrepender
    
    Write backward in binary an 8 byte long
    Note: it moves the readPosition not the writePosition / readLimit
    
    Specified by:
    
    prewriteLong in interface BytesPrepender<Bytes<Underlying>>
    
    Parameters:
    
    l - long to prepend to.
    
    Throws:
    
    BufferOverflowException
  - writeOffsetPositionMoved
```
protected final long writeOffsetPositionMoved(long adding)
                                       throws BufferOverflowException
```
    Throws:
    
    BufferOverflowException
  - writeOffsetPositionMoved
```
protected long writeOffsetPositionMoved(long adding,
                                        long advance)
                                 throws BufferOverflowException
```
    Throws:
    
    BufferOverflowException
  - prewriteOffsetPositionMoved
```
protected long prewriteOffsetPositionMoved(long subtracting)
                                    throws BufferOverflowException
```
    Throws:
    
    BufferOverflowException
  - writeShort
```
@NotNull
public @NotNull Bytes<Underlying> writeShort(short i16)
                                               throws BufferOverflowException
```
    Specified by:
    
    writeShort in interface StreamingDataOutput<Bytes<Underlying>>
    
    Throws:
    
    BufferOverflowException
  - writeInt
```
@NotNull
public @NotNull Bytes<Underlying> writeInt(int i)
                                             throws BufferOverflowException
```
    Specified by:
    
    writeInt in interface StreamingDataOutput<Bytes<Underlying>>
    
    Throws:
    
    BufferOverflowException
  - writeIntAdv
```
@NotNull
public @NotNull Bytes<Underlying> writeIntAdv(int i,
                                                       int advance)
                                                throws BufferOverflowException
```
    Specified by:
    
    writeIntAdv in interface StreamingDataOutput<Bytes<Underlying>>
    
    Throws:
    
    BufferOverflowException
  - writeLong
```
@NotNull
public @NotNull Bytes<Underlying> writeLong(long i64)
                                              throws BufferOverflowException
```
    Description copied from interface: StreamingDataOutput
    
    Write a long
    
    Specified by:
    
    writeLong in interface StreamingDataOutput<Bytes<Underlying>>
    
    Throws:
    
    BufferOverflowException
  - writeLongAdv
```
@NotNull
public @NotNull Bytes<Underlying> writeLongAdv(long i64,
                                                        int advance)
                                                 throws BufferOverflowException
```
    Specified by:
    
    writeLongAdv in interface StreamingDataOutput<Bytes<Underlying>>
    
    Throws:
    
    BufferOverflowException
  - writeFloat
```
@NotNull
public @NotNull Bytes<Underlying> writeFloat(float f)
                                               throws BufferOverflowException
```
    Specified by:
    
    writeFloat in interface StreamingDataOutput<Bytes<Underlying>>
    
    Throws:
    
    BufferOverflowException
  - writeDouble
```
@NotNull
public @NotNull Bytes<Underlying> writeDouble(double d)
                                                throws BufferOverflowException
```
    Specified by:
    
    writeDouble in interface StreamingDataOutput<Bytes<Underlying>>
    
    Throws:
    
    BufferOverflowException
  - writeDoubleAndInt
```
@NotNull
public @NotNull Bytes<Underlying> writeDoubleAndInt(double d,
                                                             int i)
                                                      throws BufferOverflowException
```
    Specified by:
    
    writeDoubleAndInt in interface StreamingDataOutput<Bytes<Underlying>>
    
    Throws:
    
    BufferOverflowException
  - write
```
@NotNull
public @NotNull Bytes<Underlying> write(@NotNull
                                                 @NotNull byte[] bytes,
                                                 int offset,
                                                 int length)
                                          throws BufferOverflowException
```
    Description copied from interface: StreamingDataOutput
    
    Write all data or fail.
    
    Specified by:
    
    write in interface StreamingDataOutput<Bytes<Underlying>>
    
    Throws:
    
    BufferOverflowException
  - safeCopySize
```
protected int safeCopySize()
```
  - writeSome
```
@NotNull
public @NotNull Bytes<Underlying> writeSome(@NotNull
                                                     @NotNull ByteBuffer buffer)
                                              throws BufferOverflowException
```
    Specified by:
    
    writeSome in interface StreamingDataOutput<Bytes<Underlying>>
    
    Throws:
    
    BufferOverflowException
  - writeOrderedInt
```
@NotNull
public @NotNull Bytes<Underlying> writeOrderedInt(int i)
                                                    throws BufferOverflowException
```
    Specified by:
    
    writeOrderedInt in interface StreamingDataOutput<Bytes<Underlying>>
    
    Throws:
    
    BufferOverflowException
  - writeOrderedLong
```
@NotNull
public @NotNull Bytes<Underlying> writeOrderedLong(long i)
                                                     throws BufferOverflowException
```
    Specified by:
    
    writeOrderedLong in interface StreamingDataOutput<Bytes<Underlying>>
    
    Throws:
    
    BufferOverflowException
  - addressForRead
```
public long addressForRead(long offset)
                    throws BufferUnderflowException
```
    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:
    
    BufferUnderflowException - if the offset is before the start() or the after the capacity()
  - addressForWrite
```
public long addressForWrite(long offset)
                     throws UnsupportedOperationException,
                            BufferOverflowException
```
    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()
  - addressForWritePosition
```
public long addressForWritePosition()
                             throws UnsupportedOperationException,
                                    BufferOverflowException
```
    Throws:
    
    UnsupportedOperationException
    
    BufferOverflowException
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - toString
```
@NotNull
public @NotNull String toString()
```
    Specified by:
    
    toString in interface CharSequence
    
    Overrides:
    
    toString in class net.openhft.chronicle.core.io.AbstractReferenceCounted
  - nativeRead
```
public void nativeRead(long address,
                       long size)
                throws BufferUnderflowException
```
    Description copied from interface: StreamingDataInput
    
    This is an expert level method for copying raw native memory in bulk.
    
    Parameters:
    
    address - of the memory.
    
    size - in bytes.
    
    Throws:
    
    BufferUnderflowException
  - nativeWrite
```
public void nativeWrite(long address,
                        long size)
                 throws BufferOverflowException
```
    Description copied from interface: StreamingDataOutput
    
    This is an expert level method for writing out data to native memory.
    
    Specified by:
    
    nativeWrite in interface StreamingDataOutput<Bytes<Underlying>>
    
    Parameters:
    
    address - to write to.
    
    size - in bytes.
    
    Throws:
    
    BufferOverflowException
  - nativeRead
```
public void nativeRead(long position,
                       long address,
                       long size)
                throws BufferUnderflowException
```
    Description copied from interface: RandomDataInput
    
    expert level method for copying data to native memory.
    
    Specified by:
    
    nativeRead in interface RandomDataInput
    
    Parameters:
    
    position - within the ByteStore to copy.
    
    address - in native memory
    
    size - in bytes
    
    Throws:
    
    BufferUnderflowException - if the offset is outside the limits of the Bytes
  - nativeWrite
```
public void nativeWrite(long address,
                        long position,
                        long size)
                 throws BufferOverflowException
```
    Description copied from interface: RandomDataOutput
    
    expert level method to copy data from native memory into the BytesStore
    
    Specified by:
    
    nativeWrite in interface RandomDataOutput<Bytes<Underlying>>
    
    Parameters:
    
    address - in native memory to copy from
    
    position - in BytesStore to copy to
    
    size - in bytes
    
    Throws:
    
    BufferOverflowException
  - bytesStore
```
@NotNull
public @NotNull BytesStore bytesStore()
```
    Specified by:
    
    bytesStore in interface Bytes<Underlying>
    
    Specified by:
    
    bytesStore in interface BytesStore<Bytes<Underlying>,Underlying>
    
    Returns:
    
    the ByteStore this Bytes wraps.
  - bytesStore
```
protected void bytesStore(BytesStore<Bytes<Underlying>,Underlying> bytesStore)
```
  - lastDecimalPlaces
```
public int lastDecimalPlaces()
```
    Returns:
    
    the last number of decimal places for parseDouble or parseLongDecimal
  - lastDecimalPlaces
```
public void lastDecimalPlaces(int lastDecimalPlaces)
```
    Store the last number of decimal places. If
    
    Parameters:
    
    lastDecimalPlaces - set the number of decimal places if positive, otherwise 0.
  - lenient
```
public void lenient(boolean lenient)
```
    Description copied from interface: StreamingDataInput
    
    When there is no more data to read, return zero, false and empty string.
    
    Parameters:
    
    lenient - if true, return nothing rather than error.
  - lenient
```
public boolean lenient()
```
  - byteCheckSum
```
public int byteCheckSum()
                 throws net.openhft.chronicle.core.io.IORuntimeException
```
    Description copied from interface: BytesStore
    
    Return the bytes sum of the readable bytes.
    
    Specified by:
    
    byteCheckSum in interface BytesStore<Bytes<Underlying>,Underlying>
    
    Returns:
    
    unsigned byte sum.
    
    Throws:
    
    net.openhft.chronicle.core.io.IORuntimeException
  - byteCheckSum
```
public int byteCheckSum(long start,
                        long end)
```
    Specified by:
    
    byteCheckSum in interface BytesStore<Bytes<Underlying>,Underlying>
  - byteCheckSum
```
public int byteCheckSum(int start,
                        int end)
```
  - reader
```
@NotNull
public @NotNull Reader reader()
```
    Access these bytes as an ISO-8859-1 encoded Reader
    
    Returns:
    
    as a Reader
  - parseBoolean
```
@Nullable
public @Nullable Boolean parseBoolean(@NotNull
                                                @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.
  - parseBoolean
```
@Nullable
public @Nullable Boolean parseBoolean()
```
  - parseUtf8
```
@NotNull
public @NotNull String parseUtf8(@NotNull
                                          @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
public @NotNull String parseUTF(@NotNull
                                                      @NotNull StopCharTester stopCharTester)
```
    Deprecated.
  - parseUtf8
```
public void parseUtf8(@NotNull
                      @NotNull Appendable buffer,
                      @NotNull
                      @NotNull StopCharTester stopCharTester)
               throws BufferUnderflowException
```
    parse text with UTF-8 decoding as character terminated.
    
    Parameters:
    
    buffer - to populate
    
    stopCharTester - to check if the end has been reached.
    
    Throws:
    
    BufferUnderflowException
  - parseUTF
```
@Deprecated
public void parseUTF(@NotNull
                                 @NotNull Appendable buffer,
                                 @NotNull
                                 @NotNull StopCharTester stopCharTester)
                          throws BufferUnderflowException
```
    Deprecated.
    
    Throws:
    
    BufferUnderflowException
  - parseUtf8
```
public void parseUtf8(@NotNull
                      @NotNull Appendable buffer,
                      @NotNull
                      @NotNull StopCharsTester stopCharsTester)
               throws BufferUnderflowException,
                      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
    
    net.openhft.chronicle.core.io.IORuntimeException
  - parseUTF
```
@Deprecated
public void parseUTF(@NotNull
                                 @NotNull Appendable buffer,
                                 @NotNull
                                 @NotNull StopCharsTester stopCharsTester)
                          throws BufferUnderflowException,
                                 net.openhft.chronicle.core.io.IORuntimeException
```
    Deprecated.
    
    Throws:
    
    BufferUnderflowException
    
    net.openhft.chronicle.core.io.IORuntimeException
  - parse8bit
```
public void parse8bit(Appendable buffer,
                      @NotNull
                      @NotNull StopCharTester stopCharTester)
               throws BufferUnderflowException
```
    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
  - parse8bit
```
public String parse8bit(@NotNull
                        @NotNull StopCharTester stopCharTester)
                 throws BufferUnderflowException
```
    parse text with ISO-8859-1 decoding as character terminated.
    
    Parameters:
    
    stopCharTester - to check if the end has been reached.
    
    Throws:
    
    BufferUnderflowException
  - parse8bit
```
public void parse8bit(Appendable buffer,
                      @NotNull
                      @NotNull StopCharsTester stopCharsTester)
               throws BufferUnderflowException
```
    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
  - parse8bit
```
public void parse8bit(Bytes buffer,
                      @NotNull
                      @NotNull StopCharsTester stopCharsTester)
               throws BufferUnderflowException
```
    Throws:
    
    BufferUnderflowException
  - parse8bit
```
public void parse8bit(StringBuilder buffer,
                      @NotNull
                      @NotNull StopCharsTester stopCharsTester)
               throws BufferUnderflowException
```
    Throws:
    
    BufferUnderflowException
  - parseInt
```
public int parseInt()
             throws BufferUnderflowException
```
    parse text as an int. The terminating character is consumed.
    
    Returns:
    
    an int.
    
    Throws:
    
    BufferUnderflowException
  - parseLong
```
public long parseLong()
               throws BufferUnderflowException
```
    parse text as a long integer. The terminating character is consumed.
    
    Returns:
    
    a long.
    
    Throws:
    
    BufferUnderflowException
  - parseFloat
```
public float parseFloat()
                 throws BufferUnderflowException
```
    parse text as a float decimal. The terminating character is consumed.
    The number of decimal places can be retrieved with lastDecimalPlaces()
    
    Returns:
    
    a float.
    
    Throws:
    
    BufferUnderflowException
  - parseDouble
```
public 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
```
public 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
  - skipTo
```
public boolean skipTo(@NotNull
                      @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
public @NotNull BigDecimal parseBigDecimal()
```
  - readRemaining
```
public long readRemaining()
```
    Returns:
    
    How many more bytes can we read.
  - writeRemaining
```
public long writeRemaining()
```
    Returns:
    
    How many more bytes can we written.
  - addressForRead
```
public long addressForRead(long offset,
                           int buffer)
                    throws UnsupportedOperationException,
                           BufferUnderflowException
```
    Throws:
    
    UnsupportedOperationException
    
    BufferUnderflowException
  - byteOrder
```
public ByteOrder byteOrder()
```
  - compareAndSwapFloat
```
public boolean compareAndSwapFloat(long offset,
                                   float expected,
                                   float value)
                            throws BufferOverflowException
```
    Perform a 32-bit float CAS at a given offset.
    
    Parameters:
    
    offset - to perform CAS
    
    expected - value
    
    value - to set
    
    Returns:
    
    true, if successful.
    
    Throws:
    
    BufferOverflowException
  - compareAndSwapDouble
```
public boolean compareAndSwapDouble(long offset,
                                    double expected,
                                    double value)
                             throws BufferOverflowException
```
    Perform a 64-bit double CAS at a given offset.
    
    Parameters:
    
    offset - to perform CAS
    
    expected - value
    
    value - to set
    
    Returns:
    
    true, if successful.
    
    Throws:
    
    BufferOverflowException

Class AbstractBytes<Underlying>

Field Summary

Fields inherited from class net.openhft.chronicle.core.io.AbstractReferenceCounted

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

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

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

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

Method Summary

Methods inherited from class net.openhft.chronicle.core.io.AbstractReferenceCounted

Methods inherited from class java.lang.Object

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

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

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

Methods inherited from interface java.lang.CharSequence

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

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

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

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

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.core.io.ReferenceCounted

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

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

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

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

Field Detail

bytesStore

readPosition

writePosition

writeLimit

isPresent

Method Detail

isDirectMemory

canReadDirect

move

compact

isPresent

isPresent

clear

clearAndPad

readLimit

writeLimit

realCapacity

realWriteRemaining

canWriteDirect

capacity

underlyingObject

start

readPosition

writePosition

compareAndSwapInt

testAndSetInt

compareAndSwapLong

append

readPosition

readLimit

writePosition

readSkip

uncheckedReadSkipOne

uncheckedReadSkipBackOne

writeSkip

writeLimit

performRelease

readUnsignedByte

readUnsignedByte

uncheckedReadUnsignedByte

readByte

peekUnsignedByte

readShort

readInt

readVolatileByte

readVolatileShort

readVolatileInt

readVolatileLong

readLong

readFloat

readDouble

readVolatileInt

readVolatileLong

readOffsetPositionMoved