net.openhft.chronicle.bytes

Class GuardedNativeBytes<U>

java.lang.Object

net.openhft.chronicle.core.io.AbstractReferenceCounted

net.openhft.chronicle.bytes.AbstractBytes<U>

net.openhft.chronicle.bytes.VanillaBytes<U>

net.openhft.chronicle.bytes.NativeBytes<U>

net.openhft.chronicle.bytes.GuardedNativeBytes<U>

Type Parameters:

U - The type of the object that this byte buffer is bound to.

All Implemented Interfaces:

Appendable, CharSequence, Comparable<CharSequence>, Byteable, Bytes<U>, BytesIn<U>, BytesOut<U>, BytesPrepender<Bytes<U>>, BytesStore<Bytes<U>,U>, ByteStringAppender<Bytes<U>>, ByteStringParser<Bytes<U>>, HexDumpBytesDescription<BytesOut<U>>, net.openhft.chronicle.bytes.internal.HasUncheckedRandomDataInput, RandomDataInput, RandomDataOutput<Bytes<U>>, DecimalAppender, StreamingCommon<Bytes<U>>, StreamingDataInput<Bytes<U>>, StreamingDataOutput<Bytes<U>>, net.openhft.chronicle.core.io.Monitorable, net.openhft.chronicle.core.io.ReferenceCounted, net.openhft.chronicle.core.io.ReferenceCountedTracer, net.openhft.chronicle.core.io.ReferenceOwner, net.openhft.chronicle.core.io.SingleThreadedChecked

public class GuardedNativeBytes<U>
extends NativeBytes<U>

This class extends the NativeBytes class and provides an additional layer of safety by tracking the raw primitives written to the byte buffer.

The purpose of this class is to facilitate the detection of inconsistencies during testing. When inconsistencies are detected, they can be corrected before the code is moved into production.

GuardedNativeBytes records the type of each primitive written into the bytes buffer (byte, short, int, long, float, double). This tracking enables validation of the consistency of data written and read, which is critical for data integrity.

Please note that while this class is very useful for ensuring data consistency during testing, it may introduce a performance overhead and thus not recommended to be used in a production environment.

Field Summary

Fields inherited from class net.openhft.chronicle.bytes.NativeBytes

capacity

Fields inherited from class net.openhft.chronicle.bytes.AbstractBytes

bytesStore, isPresent, readPosition, writeLimit

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

referenceCounted, WARN_COUNT, WARN_NS

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

DEFAULT_BYTE_BUFFER_CAPACITY, MAX_CAPACITY, MAX_HEAP_CAPACITY

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.SingleThreadedChecked

DISABLE_SINGLE_THREADED_CHECK

Constructor Summary

Constructors

Constructor and Description
GuardedNativeBytes(@NotNull BytesStore<?,?> store, long capacity) Constructs a new GuardedNativeBytes instance backed by the specified BytesStore and with the specified capacity.

Method Summary

Modifier and Type	Method and Description
protected void	bytesStore(@NotNull BytesStore<?,U> bytesStore)
byte	rawReadByte() Reads a raw byte value from the input stream.
int	rawReadInt() Reads a 32-bit integer value from the input stream without performing boundary checks.
Bytes<U>	rawWriteByte(byte i8) Writes a byte to the data stream without any additional checks or transformations.
Bytes<U>	rawWriteInt(int i) Writes an integer to the data stream without any additional checks or transformations.
byte	readByte() Reads a byte value from the input stream.
double	readDouble() Reads a 64-bit floating-point number from the input stream.
float	readFloat() Reads a 32-bit floating-point number from the input stream.
int	readInt() Reads a 32-bit integer value from the input stream.
long	readLong() Reads a 64-bit long value from the input stream.
short	readShort() Reads a 16-bit short value from the input stream.
long	readStopBit() Reads a variable-length integer encoded using the stop bit encoding.
char	readStopBitChar() Reads a variable-length character encoded using the stop bit encoding.
int	readUnsignedByte() Reads the next unsigned 8-bit value from the input stream.
@NotNull String	toHexString() Creates and returns a new String representing the contents of this Bytes object in hexadecimal form, with comments describing the meaning of the bytes.
@NotNull Bytes<U>	writeByte(byte i8) Writes a byte to the data stream.
@NotNull Bytes<U>	writeDouble(double d) Writes a double-precision floating-point number to the data stream.
@NotNull Bytes<U>	writeFloat(float f) Writes a floating-point number to the data stream.
BytesOut<U>	writeHexDumpDescription(CharSequence comment) Add comment as appropriate for the toHexString format
@NotNull Bytes<U>	writeInt(int i) Writes an integer to the data stream.
@NotNull Bytes<U>	writeLong(long i64) Writes a long integer to the data stream.
@NotNull Bytes<U>	writeShort(short i16) Writes a short integer to the data stream.
@NotNull Bytes<U>	writeStopBit(char x) Writes a stop bit encoded char to the data stream.
@NotNull Bytes<U>	writeStopBit(long x) Writes a stop bit encoded long to the data stream.

Methods inherited from class net.openhft.chronicle.bytes.NativeBytes

areNewGuarded, bytesStore, capacity, ensureCapacity, isElastic, isEqual, maxCapacityFor, nativeBytes, nativeBytes, readRemaining, resetNewGuarded, setNewGuarded, wrapWithNativeBytes, writeCheckOffset, writeOffsetPositionMoved

Methods inherited from class net.openhft.chronicle.bytes.VanillaBytes

append, append8bit, append8bit, append8bit, append8bit0, appendUtf8, appendUtf8, byteCheckSum, bytesForRead, compareTo, copy, equalBytes, findByte, isEqual, maxSize, offset, optimisedWrite, parseLong, read, read8Bit, readVolatileLong, realCapacity, toString, toString0, toTemporaryDirectByteBuffer, vanillaBytes, wrap, write, write

Methods inherited from class net.openhft.chronicle.bytes.AbstractBytes

acquireUncheckedInput, addressForRead, addressForWrite, addressForWritePosition, append, append, append, append, append, append, appendAndReturnLength, byteCheckSum, byteCheckSum, bytesStore, canReadDirect, canWriteDirect, clear, clearAndPad, compact, compareAndSwapInt, compareAndSwapLong, copyTo, decimaliser, decimaliser, equals, fpAppend0, fpAppend0, hashCode, isDirectMemory, isImmutableEmptyByteStore, lastDecimalPlaces, lastDecimalPlaces, lastNumberHadDigits, lastNumberHadDigits, length, lenient, lenient, move, nativeRead, nativeWrite, peekUnsignedByte, peekUnsignedByte, performRelease, prewrite, prewrite, prewriteByte, prewriteInt, prewriteLong, prewriteOffsetPositionMoved, prewriteShort, read, read, readByte, readCheckOffset, readDouble, readFloat, readInt, readLimit, readLimit, readLong, readOffsetPositionMoved, readPosition, readPosition, readPositionForHeader, readShort, readSkip, readUnsignedByte, readVolatileByte, readVolatileInt, readVolatileInt, readVolatileLong, readVolatileShort, safeCopySize, start, startsWith, testAndSetInt, uncheckedReadSkipBackOne, uncheckedReadSkipOne, uncheckedReadUnsignedByte, uncheckedWritePosition, underlyingObject, unmonitor, write, write, write, write, write, write8bit, write8bit, write8bit, write8bit, writeBoolean, writeByte, writeDouble, writeDoubleAndInt, writeFloat, writeInt, writeIntAdv, writeLimit, writeLimit, writeLong, writeLongAdv, writeOffsetPositionMoved, writeOrderedInt, writeOrderedInt, writeOrderedLong, writeOrderedLong, writePosition, writePosition, writeShort, writeSkip, writeSome, writeVolatileByte, writeVolatileInt, writeVolatileLong, writeVolatileShort

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

addReferenceChangeListener, assertReferencesReleased, backgroundPerformRelease, canReleaseInBackground, createdHere, disableReferenceTracing, enableReferenceTracing, refCount, referenceCountedUnmonitored, referenceId, release, releaseLast, removeReferenceChangeListener, reserve, reserveTransfer, singleThreadedCheckDisabled, singleThreadedCheckReset, 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.Byteable

address, bytesStore, lock, tryLock

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

allocateDirect, allocateDirect, allocateElasticDirect, allocateElasticDirect, allocateElasticOnHeap, allocateElasticOnHeap, bytesForWrite, copyTo, copyTo, directFrom, elasticByteBuffer, elasticByteBuffer, elasticByteBuffer, elasticHeapByteBuffer, elasticHeapByteBuffer, empty, forFieldGroup, from, from, fromDirect, fromHexString, indexOf, indexOf, isClear, readMarshallableLength16, readWithLength, readWrite, safeLimit, sharedMemory, toHexString, toHexString, toString, toString, toString, unchecked, unchecked, unwrite, valueOf, wrapForRead, wrapForRead, wrapForWrite, wrapForWrite, write, writeMarshallableLength16

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

addAndGetDouble, addAndGetDoubleNotAtomic, addAndGetFloat, addAndGetFloatNotAtomic, addAndGetInt, addAndGetIntNotAtomic, addAndGetLong, addAndGetShortNotAtomic, addAndGetUnsignedByteNotAtomic, charAt, cipher, cipher, compareAndSwapDouble, compareAndSwapFloat, contentEquals, elasticByteBuffer, endsWith, follow, forFields, from, hash, inside, inside, isEmpty, lazyNativeBytesStoreWithFixedCapacity, nativePointer, nativeStore, nativeStoreFrom, nativeStoreWithFixedCapacity, 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

canReadDirect, compareUtf8, copyTo, fastHash, parseLong, peekVolatileInt, printable, readBoolean, readIncompleteLong, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8Limited, readUtf8Limited, readVolatileDouble, readVolatileFloat, subBytes, toByteArray

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

parse8bit, parse8bit, parse8bit, parse8bit, parse8bit, parseBigDecimal, parseBoolean, parseBoolean, parseDouble, parseFlexibleLong, parseFloat, parseInt, parseLongDecimal, parseUtf8, parseUtf8, parseUtf8, reader, skipTo

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

inputStream, parseHexLong, parseUtf8, parseUtf8, rawReadLong, read, read, read, read, read8bit, read8bit, read8bit, readBigDecimal, readBigInteger, readBoolean, readChar, readEnum, readHistogram, readIncompleteLong, readInt24, readLimitToCapacity, readPositionRemaining, readPositionUnlimited, readStopBitDecimal, readStopBitDouble, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8, readUtf8, readUtf8, readWithLength, readWithLength, readWithLength0, unsafeRead, unsafeReadObject

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

bytesMethodWriter, writeObject

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

append, append, append, append, append8bit, append8bit, appendBase, appendBase16, appendBase16, appendDateMillis, appendDecimal, appendTimeMillis, writer

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

appendUtf8, appendUtf8, appendUtf8, appendUtf8, copyFrom, outputStream, rawWriteLong, unsafeWrite, unsafeWriteObject, write, write, write, write8bit, write8bit, write8bit, writeBigDecimal, writeBigInteger, writeChar, writeEnum, writeHistogram, writeInt24, writePositionForHeader, writePositionRemaining, writeStopBit, writeStopBitDecimal, writeUnsignedByte, writeUnsignedInt, writeUnsignedInt24, writeUnsignedShort, writeUtf8, writeUtf8, writeWithLength, writeWithLength

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

prepend

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

adjustHexDumpIndentation, retainedHexDumpDescription

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

singleThreadedCheckDisabled, singleThreadedCheckReset

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

onReleased

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

unmonitor

Constructor Detail

GuardedNativeBytes

public GuardedNativeBytes(@NotNull
                          @NotNull BytesStore<?,?> store,
                          long capacity)
                   throws IllegalStateException,
                          IllegalArgumentException

Constructs a new GuardedNativeBytes instance backed by the specified BytesStore and with the specified capacity.

Parameters:

store - The backing BytesStore.

capacity - The capacity of the new GuardedNativeBytes instance.

Throws:

IllegalArgumentException - If the capacity is negative or exceeds the limit of the backing store.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

Method Detail

writeHexDumpDescription

public BytesOut<U> writeHexDumpDescription(CharSequence comment)
                                    throws IllegalStateException

Description copied from interface: HexDumpBytesDescription

Add comment as appropriate for the toHexString format

Parameters:

comment - to add (or ignore)

Returns:

this

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

bytesStore

protected void bytesStore(@NotNull
                          @NotNull BytesStore<?,U> bytesStore)

Overrides:

bytesStore in class NativeBytes<U>

writeByte

@NotNull
public @NotNull Bytes<U> writeByte(byte i8)
                                     throws BufferOverflowException,
                                            IllegalStateException

Description copied from interface: StreamingDataOutput

Writes a byte to the data stream.

Specified by:

writeByte in interface StreamingDataOutput<Bytes<U>>

Overrides:

writeByte in class NativeBytes<U>

Parameters:

i8 - The byte to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

rawWriteByte

public Bytes<U> rawWriteByte(byte i8)
                      throws BufferOverflowException,
                             IllegalStateException

Description copied from interface: StreamingDataOutput

Writes a byte to the data stream without any additional checks or transformations.

Parameters:

i8 - The byte to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

rawWriteInt

public Bytes<U> rawWriteInt(int i)
                     throws BufferOverflowException,
                            IllegalStateException

Description copied from interface: StreamingDataOutput

Writes an integer to the data stream without any additional checks or transformations.

Parameters:

i - The integer to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

readByte

public byte readByte()
              throws IllegalStateException

Description copied from interface: StreamingDataInput

Reads a byte value from the input stream.

Specified by:

readByte in interface StreamingDataInput<Bytes<U>>

Overrides:

readByte in class AbstractBytes<U>

Returns:

the byte value

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

rawReadByte

public byte rawReadByte()
                 throws IllegalStateException

Description copied from interface: StreamingDataInput

Reads a raw byte value from the input stream. The main difference between this method and readByte() is that the latter might perform additional processing or checks.

Returns:

the raw byte value

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

rawReadInt

public int rawReadInt()
               throws IllegalStateException,
                      BufferUnderflowException

Description copied from interface: StreamingDataInput

Reads a 32-bit integer value from the input stream without performing boundary checks. Use this method with caution as it bypasses checks for data availability.

Returns:

the 32-bit integer value

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

BufferUnderflowException - If there's not enough data to read

IllegalStateException

readUnsignedByte

public int readUnsignedByte()
                     throws IllegalStateException

Description copied from interface: StreamingDataInput

Reads the next unsigned 8-bit value from the input stream. If there is no byte available, it returns -1.

Specified by:

readUnsignedByte in interface StreamingDataInput<Bytes<U>>

Overrides:

readUnsignedByte in class AbstractBytes<U>

Returns:

the next unsigned 8-bit value or -1

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

writeShort

@NotNull
public @NotNull Bytes<U> writeShort(short i16)
                                      throws BufferOverflowException,
                                             IllegalStateException

Description copied from interface: StreamingDataOutput

Writes a short integer to the data stream.

Specified by:

writeShort in interface StreamingDataOutput<Bytes<U>>

Overrides:

writeShort in class AbstractBytes<U>

Parameters:

i16 - The short integer to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

readShort

public short readShort()
                throws BufferUnderflowException,
                       IllegalStateException

Description copied from interface: StreamingDataInput

Reads a 16-bit short value from the input stream.

Specified by:

readShort in interface StreamingDataInput<Bytes<U>>

Overrides:

readShort in class AbstractBytes<U>

Returns:

the 16-bit short value

Throws:

BufferUnderflowException - If there's not enough data to read

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

writeStopBit

@NotNull
public @NotNull Bytes<U> writeStopBit(char x)
                                        throws BufferOverflowException,
                                               IllegalStateException

Description copied from interface: StreamingDataOutput

Writes a stop bit encoded char to the data stream. Stop bit encoding is a form of variable-length integer encoding that uses the continuation bit to indicate if there are more bytes to be processed.

Parameters:

x - The char value to be written to the data stream.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

writeStopBit

@NotNull
public @NotNull Bytes<U> writeStopBit(long x)
                                        throws BufferOverflowException,
                                               IllegalStateException

Description copied from interface: StreamingDataOutput

Writes a stop bit encoded long to the data stream. Stop bit encoding is a form of variable-length integer encoding that uses the continuation bit to indicate if there are more bytes to be processed.

Parameters:

x - The long value to be written to the data stream.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

readStopBit

public long readStopBit()
                 throws net.openhft.chronicle.core.io.IORuntimeException,
                        IllegalStateException,
                        BufferUnderflowException

Description copied from interface: StreamingDataInput

Reads a variable-length integer encoded using the stop bit encoding. This method is equivalent to calling BytesInternal.readStopBit(this).

Returns:

the decoded integer

Throws:

net.openhft.chronicle.core.io.IORuntimeException - If an I/O error occurs

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

BufferUnderflowException - If there's not enough data to read

IllegalStateException

readStopBitChar

public char readStopBitChar()
                     throws net.openhft.chronicle.core.io.IORuntimeException,
                            IllegalStateException,
                            BufferUnderflowException

Description copied from interface: StreamingDataInput

Reads a variable-length character encoded using the stop bit encoding. This method is equivalent to calling BytesInternal.readStopBitChar(this).

Returns:

the decoded character

Throws:

net.openhft.chronicle.core.io.IORuntimeException - If an I/O error occurs

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

BufferUnderflowException - If there's not enough data to read

IllegalStateException

writeInt

@NotNull
public @NotNull Bytes<U> writeInt(int i)
                                    throws BufferOverflowException,
                                           IllegalStateException

Description copied from interface: StreamingDataOutput

Writes an integer to the data stream.

Specified by:

writeInt in interface StreamingDataOutput<Bytes<U>>

Overrides:

writeInt in class AbstractBytes<U>

Parameters:

i - The integer to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

readInt

public int readInt()
            throws BufferUnderflowException,
                   IllegalStateException

Description copied from interface: StreamingDataInput

Reads a 32-bit integer value from the input stream.

Specified by:

readInt in interface StreamingDataInput<Bytes<U>>

Overrides:

readInt in class AbstractBytes<U>

Returns:

the 32-bit integer value

Throws:

BufferUnderflowException - If there's not enough data to read

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

writeLong

@NotNull
public @NotNull Bytes<U> writeLong(long i64)
                                     throws BufferOverflowException,
                                            IllegalStateException

Description copied from interface: StreamingDataOutput

Writes a long integer to the data stream.

Specified by:

writeLong in interface StreamingDataOutput<Bytes<U>>

Overrides:

writeLong in class NativeBytes<U>

Parameters:

i64 - The long integer to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

readLong

public long readLong()
              throws BufferUnderflowException,
                     IllegalStateException

Description copied from interface: StreamingDataInput

Reads a 64-bit long value from the input stream.

Specified by:

readLong in interface StreamingDataInput<Bytes<U>>

Overrides:

readLong in class AbstractBytes<U>

Returns:

the 64-bit long value

Throws:

BufferUnderflowException - If there's not enough data to read

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

writeFloat

@NotNull
public @NotNull Bytes<U> writeFloat(float f)
                                      throws BufferOverflowException,
                                             IllegalStateException

Description copied from interface: StreamingDataOutput

Writes a floating-point number to the data stream.

Specified by:

writeFloat in interface StreamingDataOutput<Bytes<U>>

Overrides:

writeFloat in class AbstractBytes<U>

Parameters:

f - The floating-point number to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

readFloat

public float readFloat()
                throws BufferUnderflowException,
                       IllegalStateException

Description copied from interface: StreamingDataInput

Reads a 32-bit floating-point number from the input stream.

Specified by:

readFloat in interface StreamingDataInput<Bytes<U>>

Overrides:

readFloat in class AbstractBytes<U>

Returns:

the float value read from the stream

Throws:

BufferUnderflowException - If there's not enough data to read

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

writeDouble

@NotNull
public @NotNull Bytes<U> writeDouble(double d)
                                       throws BufferOverflowException,
                                              IllegalStateException

Description copied from interface: StreamingDataOutput

Writes a double-precision floating-point number to the data stream.

Specified by:

writeDouble in interface StreamingDataOutput<Bytes<U>>

Overrides:

writeDouble in class AbstractBytes<U>

Parameters:

d - The double-precision floating-point number to be written.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is insufficient space in the buffer.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

readDouble

public double readDouble()
                  throws BufferUnderflowException,
                         IllegalStateException

Description copied from interface: StreamingDataInput

Reads a 64-bit floating-point number from the input stream.

Specified by:

readDouble in interface StreamingDataInput<Bytes<U>>

Overrides:

readDouble in class AbstractBytes<U>

Returns:

the double value read from the stream

Throws:

BufferUnderflowException - If there's not enough data to read

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way

IllegalStateException

toHexString

@NotNull
public @NotNull String toHexString()

Description copied from interface: Bytes

Creates and returns a new String representing the contents of this Bytes object in hexadecimal form, with comments describing the meaning of the bytes. The representation starts at the readPosition() and encodes at most 1024 bytes.

Each line of the output string contains hexadecimal representation of 16 bytes, followed by comments describing the meaning of those bytes.

For example, if the Bytes object contains bytes representing the ASCII string "VMH", the output would be similar to this:

 c3 76 6d 68                                     # vmh:
 b6 03 56 4d 48                                  # VMH
 

This is assumed to be used to print the contents on a best effort basis. If an Error occurs it will be returned in the String.

Returns:

A new hexadecimal String representing the content with comments describing the bytes.