net.openhft.chronicle.bytes

Class VanillaBytes<U>

java.lang.Object

net.openhft.chronicle.core.io.AbstractReferenceCounted

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

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

Type Parameters:

U - the type of the underlying object representation

All Implemented Interfaces:

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

Direct Known Subclasses:

EmbeddedBytes, NativeBytes, OnHeapBytes, SubBytes

public class VanillaBytes<U>
extends AbstractBytes<U>
implements Byteable<Bytes<U>,U>, Comparable<CharSequence>

A simple Bytes implementation that is non-elastic. It does not support dynamic resizing. This class provides functionality to work with a sequence of bytes, offering various read and write operations.

Field Summary

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

bytesStore, DISABLE_THREAD_SAFETY, 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.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.SingleThreadedChecked

DISABLE_SINGLE_THREADED_CHECK

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	VanillaBytes(@NotNull BytesStore bytesStore) Constructor for creating an instance of VanillaBytes with the given BytesStore, using its write position and write limit.
protected	VanillaBytes(@NotNull BytesStore bytesStore, long writePosition, long writeLimit) Constructor for creating an instance of VanillaBytes with the given BytesStore, write position, and write limit.

Method Summary

Modifier and Type	Method and Description
@NotNull VanillaBytes	append(@NotNull CharSequence str, int start, int end) Appends a portion of a string to the Bytes in UTF-8.
@NotNull Bytes<U>	append8bit(@NotNull BytesStore bs) Appends the ISO-8859-1 representation of the specified BytesStore.
@NotNull Bytes<U>	append8bit(@NotNull CharSequence cs) Appends a String to the Bytes in ISO-8859-1.
@NotNull Bytes<U>	append8bit(@NotNull String cs) Appends the ISO-8859-1 representation of the specified String.
protected @NotNull Bytes<U>	append8bit0(@NotNull CharSequence cs)
@NotNull Bytes<U>	appendUtf8(char[] chars, int offset, int length) Appends a UTF-8 encoded CharSequence to this output stream from a specific offset and length.
@NotNull VanillaBytes	appendUtf8(@NotNull CharSequence str) Appends a UTF-8 encoded CharSequence to this output stream.
int	byteCheckSum(int start, int end) Returns the bytes sum between the specified indexes; start (inclusive) and end (exclusive).
@NotNull Bytes<U>	bytesForRead() Creates and returns a new slice of this Bytes object with its start position set to the current read position and its capacity determined by the current limit.
void	bytesStore(@NotNull BytesStore<Bytes<U>,U> byteStore, long offset, long length) Sets the reference to a data type that points to the underlying ByteStore.
int	compareTo(@NotNull CharSequence cs)
@NotNull BytesStore<Bytes<U>,U>	copy() Creates and returns a deep copy of this Bytes object, including the data between RandomCommon.readPosition() and RandomCommon.readLimit().
boolean	equalBytes(@NotNull BytesStore bytesStore, long length) Returns if a portion of a specified BytesStore matches this BytesStore.
long	findByte(byte stopByte) Finds the first occurrence of the specified byte in this byte sequence.
boolean	isElastic() Checks if this Bytes object is elastic, meaning it can dynamically resize when more data is written than its current Bytes.realCapacity().
boolean	isEqual(@Nullable String other) Compares the contents of this Bytes object with the provided other string for equality.
long	maxSize() Returns the maximum size in bytes that this reference can point to.
long	offset() Returns the offset within the ByteStore to which this object currently points.
protected void	optimisedWrite(@NotNull RandomDataInput bytes, long offset, long length)
long	parseLong() Parses text from the byte string as a long integer.
int	read(byte[] bytes) Reads the input stream into the provided byte array.
void	read8Bit(char[] chars, int length)
long	readVolatileLong(long offset) Reads a volatile 64-bit long value from a specified offset.
long	realCapacity() Returns the actual capacity of the ByteStore before any resizing occurs.
@NotNull String	toString()
protected @NotNull String	toString0()
ByteBuffer	toTemporaryDirectByteBuffer() Converts the byte sequence into a direct byte buffer.
static @NotNull VanillaBytes<Void>	vanillaBytes() Factory method for creating an instance of VanillaBytes with no initial ByteStore.
static <U> VanillaBytes<U>	wrap(BytesStore<?,U> bytesStore) Factory method for creating an instance of VanillaBytes that wraps the provided BytesStore.
@NotNull Bytes<U>	write(@NotNull BytesStore bytes, long offset, long length) Writes the specified number of bytes from the provided BytesStore into the output stream, starting from the given read offset.
void	write(long position, @NotNull CharSequence str, int offset, int length)
@NotNull Bytes<U>	write(@NotNull RandomDataInput bytes, long offset, long length) Writes the specified number of bytes from the provided RandomDataInput object into the output stream, starting from the given read offset.

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

acquireUncheckedInput, addressForRead, addressForWrite, addressForWritePosition, append, append, append, append, append, append, appendAndReturnLength, byteCheckSum, byteCheckSum, bytesStore, bytesStore, canReadDirect, canWriteDirect, capacity, clear, clearAndPad, compact, compareAndSwapInt, compareAndSwapLong, copyTo, decimaliser, decimaliser, equals, fpAppend0, fpAppend0, hashCode, internalNumberBuffer, 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, readByte, readCheckOffset, readDouble, readDouble, readFloat, readFloat, readInt, readInt, readLimit, readLimit, readLong, readLong, readOffsetPositionMoved, readPosition, readPosition, readPositionForHeader, readShort, readShort, readSkip, readUnsignedByte, readUnsignedByte, readVolatileByte, readVolatileInt, readVolatileInt, readVolatileLong, readVolatileShort, safeCopySize, start, startsWith, testAndSetInt, uncheckedReadSkipBackOne, uncheckedReadSkipOne, uncheckedReadUnsignedByte, uncheckedWritePosition, underlyingObject, write, write, write, write, write, write, write8bit, write8bit, write8bit, write8bit, writeBoolean, writeByte, writeByte, writeCheckOffset, writeDouble, writeDouble, writeDoubleAndInt, writeFloat, writeFloat, writeInt, writeInt, writeIntAdv, writeLimit, writeLimit, writeLong, writeLong, writeLongAdv, writeOffsetPositionMoved, writeOffsetPositionMoved, writeOrderedInt, writeOrderedInt, writeOrderedLong, writeOrderedLong, writePosition, writePosition, writeShort, writeShort, writeSkip, writeSome, writeVolatileByte, writeVolatileInt, writeVolatileLong, writeVolatileShort

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

addReferenceChangeListener, assertReferencesReleased, backgroundPerformRelease, canReleaseInBackground, clearUsedByThread, createdHere, disableReferenceTracing, enableReferenceTracing, refCount, referenceCountedUnmonitored, referenceId, release, releaseLast, removeReferenceChangeListener, reserve, reservedBy, 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, ensureCapacity, forFieldGroup, from, from, fromDirect, fromHexString, indexOf, indexOf, isClear, 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

addAndGetDouble, addAndGetDoubleNotAtomic, addAndGetFloat, addAndGetFloatNotAtomic, addAndGetInt, addAndGetIntNotAtomic, addAndGetLong, addAndGetShortNotAtomic, addAndGetUnsignedByteNotAtomic, charAt, cipher, cipher, compareAndSwapDouble, compareAndSwapFloat, contentEquals, elasticByteBuffer, endsWith, follow, forFields, from, hash, inside, inside, isEmpty, isEqual, 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, createCharToString, 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, rawReadByte, rawReadInt, rawReadLong, read, read, read, read, read8bit, read8bit, read8bit, readBigDecimal, readBigInteger, readBoolean, readChar, readEnum, readHistogram, readIncompleteLong, readInt24, readLimitToCapacity, readPositionRemaining, readPositionUnlimited, readStopBit, readStopBitChar, readStopBitDecimal, readStopBitDouble, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8, readUtf8, readUtf8, readWithLength, readWithLength, readWithLength0, unsafeRead, unsafeReadObject, 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, rawWriteByte, rawWriteInt, rawWriteLong, unsafeWrite, unsafeWriteObject, unsafeWriteObject, write, write, write, write8bit, write8bit, write8bit, writeBigDecimal, writeBigInteger, writeChar, writeEnum, writeHistogram, writeInt24, writePositionForHeader, writePositionRemaining, writeSome, writeStopBit, writeStopBit, writeStopBit, writeStopBitDecimal, writeUnsignedByte, writeUnsignedInt, writeUnsignedInt24, writeUnsignedShort, writeUtf8, writeUtf8, writeWithLength

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

prepend

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

adjustHexDumpIndentation, retainedHexDumpDescription, writeHexDumpDescription

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

singleThreadedCheckDisabled, singleThreadedCheckReset

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

onReleased

Constructor Detail

VanillaBytes

protected VanillaBytes(@NotNull
                       @NotNull BytesStore bytesStore)
                throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       IllegalArgumentException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Constructor for creating an instance of VanillaBytes with the given BytesStore, using its write position and write limit.

Parameters:

bytesStore - the BytesStore to be wrapped by the VanillaBytes.

Throws:

IllegalArgumentException - If the write limit of bytesStore is negative.

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

VanillaBytes

protected VanillaBytes(@NotNull
                       @NotNull BytesStore bytesStore,
                       long writePosition,
                       long writeLimit)
                throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       IllegalArgumentException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Constructor for creating an instance of VanillaBytes with the given BytesStore, write position, and write limit.

Parameters:

bytesStore - the BytesStore to be wrapped by the VanillaBytes.

writePosition - the position at which the next write will occur.

writeLimit - the maximum limit up to which writing can occur.

Throws:

IllegalArgumentException - If the write limit is negative.

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

Method Detail

wrap

public static <U> VanillaBytes<U> wrap(BytesStore<?,U> bytesStore)
                                throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Factory method for creating an instance of VanillaBytes that wraps the provided BytesStore.

Parameters:

bytesStore - the BytesStore to be wrapped by the VanillaBytes.

Returns:

a new instance of VanillaBytes that wraps the given BytesStore.

Throws:

IllegalArgumentException - If the write limit is negative.

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

vanillaBytes

@NotNull
public static @NotNull VanillaBytes<Void> vanillaBytes()

Factory method for creating an instance of VanillaBytes with no initial ByteStore. This can be used in scenarios where the ByteStore is to be replaced or provided at a later point.

Returns:

a new instance of VanillaBytes with no ByteStore.

readVolatileLong

public long readVolatileLong(long offset)
                      throws BufferUnderflowException,
                             net.openhft.chronicle.core.io.ClosedIllegalStateException,
                             net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: RandomDataInput

Reads a volatile 64-bit long value from a specified offset. This operation includes a memory barrier that prevents reordering of instructions before and after it.

Specified by:

readVolatileLong in interface RandomDataInput

Overrides:

readVolatileLong in class AbstractBytes<U>

Parameters:

offset - the location from where the long value is read.

Returns:

the volatile long value.

Throws:

BufferUnderflowException - If the offset is beyond the limits of the byte source.

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

bytesStore

public void bytesStore(@NotNull
                       @NotNull BytesStore<Bytes<U>,U> byteStore,
                       long offset,
                       long length)
                throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       IllegalArgumentException,
                       BufferUnderflowException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: Byteable

Sets the reference to a data type that points to the underlying ByteStore.

Specified by:

bytesStore in interface Byteable<Bytes<U>,U>

Parameters:

byteStore - the fixed-point ByteStore

offset - the offset within the ByteStore, indicating the starting point of the memory section

length - the length of the memory section within the ByteStore

Throws:

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

IllegalArgumentException - If the provided arguments are invalid

BufferUnderflowException - If the new memory section starts before the start of the ByteStore

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

offset

public long offset()

Description copied from interface: Byteable

Returns the offset within the ByteStore to which this object currently points.

Specified by:

offset in interface Byteable<Bytes<U>,U>

Returns:

the offset within the ByteStore (not the physical memory address)

maxSize

public long maxSize()

Description copied from interface: Byteable

Returns the maximum size in bytes that this reference can point to.

Specified by:

maxSize in interface Byteable<Bytes<U>,U>

Returns:

the maximum size in bytes for this reference

isElastic

public boolean isElastic()

Description copied from interface: Bytes

Checks if this Bytes object is elastic, meaning it can dynamically resize when more data is written than its current Bytes.realCapacity().

Elastic Bytes objects can automatically grow to accommodate additional data, whereas non-elastic ones have a fixed capacity.

Specified by:

isElastic in interface Bytes<U>

Overrides:

isElastic in class AbstractBytes<U>

Returns:

true if this Bytes object is elastic; false otherwise.

bytesForRead

@NotNull
public @NotNull Bytes<U> bytesForRead()
                                        throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                               net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: Bytes

Creates and returns a new slice of this Bytes object with its start position set to the current read position and its capacity determined by the current limit.

Note that the slice is a subsection of this Bytes object and will not be elastic regardless of the elasticity of the parent Bytes object.

Specified by:

bytesForRead in interface Bytes<U>

Specified by:

bytesForRead in interface BytesStore<Bytes<U>,U>

Returns:

A new slice of this Bytes object.

Throws:

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

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

isEqual

public boolean isEqual(@Nullable
                       @Nullable String other)

Description copied from interface: Bytes

Compares the contents of this Bytes object with the provided other string for equality.

This method returns true if the contents of this Bytes object is equal to the contents of the other string. Otherwise, it returns false.

Specified by:

isEqual in interface Bytes<U>

Parameters:

other - The string to compare with the contents of this Bytes object, can be null.

Returns:

true if the contents of this Bytes object equals the contents of the provided other string; false otherwise.

realCapacity

public long realCapacity()

Description copied from interface: BytesStore

Returns the actual capacity of the ByteStore before any resizing occurs.

Specified by:

realCapacity in interface Bytes<U>

Specified by:

realCapacity in interface BytesStore<Bytes<U>,U>

Specified by:

realCapacity in interface RandomDataInput

Specified by:

realCapacity in interface StreamingDataOutput<Bytes<U>>

Overrides:

realCapacity in class AbstractBytes<U>

Returns:

the current capacity of the ByteStore

findByte

public long findByte(byte stopByte)
              throws net.openhft.chronicle.core.io.ClosedIllegalStateException

Description copied from interface: RandomDataInput

Finds the first occurrence of the specified byte in this byte sequence.

Specified by:

findByte in interface RandomDataInput

Parameters:

stopByte - the byte to be searched for.

Returns:

the index of the first occurrence of the byte, or -1 if the byte is not found.

Throws:

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

parseLong

public long parseLong()
               throws BufferUnderflowException,
                      net.openhft.chronicle.core.io.ClosedIllegalStateException

Description copied from interface: ByteStringParser

Parses text from the byte string as a long integer. The terminating character is consumed.

Specified by:

parseLong in interface ByteStringParser<Bytes<U>>

Returns:

the parsed long.

Throws:

BufferUnderflowException - If there is insufficient data.

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

copy

@NotNull
public @NotNull BytesStore<Bytes<U>,U> copy()
                                              throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                     net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: Bytes

Creates and returns a deep copy of this Bytes object, including the data between RandomCommon.readPosition() and RandomCommon.readLimit().

The copy will have its own separate storage and state, and modifications to the copy will not affect the original Bytes object, and vice versa.

Specified by:

copy in interface Bytes<U>

Specified by:

copy in interface BytesStore<Bytes<U>,U>

Returns:

A new Bytes object that is a copy of this object.

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

write

@NotNull
public @NotNull Bytes<U> write(@NotNull
                                        @NotNull RandomDataInput bytes,
                                        long offset,
                                        long length)
                                 throws BufferOverflowException,
                                        BufferUnderflowException,
                                        net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                        IllegalArgumentException,
                                        net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: StreamingDataOutput

Writes the specified number of bytes from the provided RandomDataInput object into the output stream, starting from the given read offset. The position of this output stream is updated accordingly, but the read position of the input data is not changed.

Specified by:

write in interface StreamingDataOutput<Bytes<U>>

Parameters:

bytes - the RandomDataInput from which data is read.

offset - the offset at which reading from the RandomDataInput starts.

length - the number of bytes to write.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is not enough space left in the output stream.

BufferUnderflowException - If there is not enough data available in the input.

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

IllegalArgumentException - If the readOffset or length are invalid.

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

optimisedWrite

protected void optimisedWrite(@NotNull
                              @NotNull RandomDataInput bytes,
                              long offset,
                              long length)
                       throws BufferOverflowException,
                              BufferUnderflowException,
                              net.openhft.chronicle.core.io.ClosedIllegalStateException,
                              IllegalArgumentException,
                              net.openhft.chronicle.core.io.ThreadingIllegalStateException

Throws:

BufferOverflowException

BufferUnderflowException

net.openhft.chronicle.core.io.ClosedIllegalStateException

IllegalArgumentException

net.openhft.chronicle.core.io.ThreadingIllegalStateException

write

public void write(long position,
                  @NotNull
                  @NotNull CharSequence str,
                  int offset,
                  int length)
           throws BufferOverflowException,
                  IllegalArgumentException,
                  ArithmeticException,
                  net.openhft.chronicle.core.io.ClosedIllegalStateException,
                  BufferUnderflowException,
                  net.openhft.chronicle.core.io.ThreadingIllegalStateException

Throws:

BufferOverflowException

IllegalArgumentException

ArithmeticException

net.openhft.chronicle.core.io.ClosedIllegalStateException

BufferUnderflowException

net.openhft.chronicle.core.io.ThreadingIllegalStateException

append

@NotNull
public @NotNull VanillaBytes append(@NotNull
                                             @NotNull CharSequence str,
                                             int start,
                                             int end)
                                      throws IndexOutOfBoundsException

Description copied from interface: ByteStringAppender

Appends a portion of a string to the Bytes in UTF-8.

Specified by:

append in interface Appendable

Specified by:

append in interface ByteStringAppender<Bytes<U>>

Parameters:

str - the CharacterSequence to append

start - index of the first char inclusive

end - index of the last char exclusive

Returns:

this

Throws:

IndexOutOfBoundsException - If the specified indexes are out of range

appendUtf8

@NotNull
public @NotNull VanillaBytes appendUtf8(@NotNull
                                                 @NotNull CharSequence str)
                                          throws BufferOverflowException

Description copied from interface: StreamingDataOutput

Appends a UTF-8 encoded CharSequence to this output stream.

Specified by:

appendUtf8 in interface StreamingDataOutput<Bytes<U>>

Parameters:

str - The CharSequence to be appended.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is not enough space left in the output stream.

append8bit

@NotNull
public @NotNull Bytes<U> append8bit(@NotNull
                                             @NotNull CharSequence cs)
                                      throws BufferOverflowException,
                                             BufferUnderflowException,
                                             IndexOutOfBoundsException,
                                             net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                             net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: ByteStringAppender

Appends a String to the Bytes in ISO-8859-1.

Specified by:

append8bit in interface ByteStringAppender<Bytes<U>>

Parameters:

cs - the CharSequence to append

Returns:

this

Throws:

BufferOverflowException - If the string is too large to write in the capacity available

BufferUnderflowException - If the capacity of the underlying buffer was exceeded

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

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

IndexOutOfBoundsException

append8bit

@NotNull
public @NotNull Bytes<U> append8bit(@NotNull
                                             @NotNull BytesStore bs)
                                      throws BufferOverflowException,
                                             BufferUnderflowException,
                                             net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                             net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: ByteStringAppender

Appends the ISO-8859-1 representation of the specified BytesStore.

Specified by:

append8bit in interface ByteStringAppender<Bytes<U>>

Parameters:

bs - the BytesStore to append

Returns:

this

Throws:

BufferOverflowException - If the BytesStore is too large to write in the capacity available

BufferUnderflowException - If the capacity of the underlying buffer was exceeded

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.

write

@NotNull
public @NotNull Bytes<U> write(@NotNull
                                        @NotNull BytesStore bytes,
                                        long offset,
                                        long length)
                                 throws BufferOverflowException,
                                        BufferUnderflowException,
                                        net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                        IllegalArgumentException,
                                        net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: StreamingDataOutput

Writes the specified number of bytes from the provided BytesStore into the output stream, starting from the given read offset. It ensures that the output stream has enough capacity to accommodate the incoming bytes. The position of this output stream is updated accordingly, but the read position of the input data is not changed.

Specified by:

write in interface StreamingDataOutput<Bytes<U>>

Parameters:

bytes - the BytesStore from which data is read.

offset - the offset at which reading from the BytesStore starts.

length - the number of bytes to write.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is not enough space left in the output stream.

BufferUnderflowException - If there is not enough data available in the input.

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

IllegalArgumentException - If the readOffset or length are invalid.

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

append8bit

@NotNull
public @NotNull Bytes<U> append8bit(@NotNull
                                             @NotNull String cs)
                                      throws BufferOverflowException,
                                             net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                             net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: ByteStringAppender

Appends the ISO-8859-1 representation of the specified String.

Specified by:

append8bit in interface ByteStringAppender<Bytes<U>>

Parameters:

cs - the String to append

Returns:

this

Throws:

BufferOverflowException - If the string is too large to write in the capacity available

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.

toString

@NotNull
public @NotNull String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class AbstractBytes<U>

toString0

@NotNull
protected @NotNull String toString0()
                                      throws net.openhft.chronicle.core.io.ClosedIllegalStateException

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException

append8bit0

@NotNull
protected @NotNull Bytes<U> append8bit0(@NotNull
                                                 @NotNull CharSequence cs)
                                          throws BufferOverflowException,
                                                 net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                 net.openhft.chronicle.core.io.ThreadingIllegalStateException

Throws:

BufferOverflowException

net.openhft.chronicle.core.io.ClosedIllegalStateException

net.openhft.chronicle.core.io.ThreadingIllegalStateException

equalBytes

public boolean equalBytes(@NotNull
                          @NotNull BytesStore bytesStore,
                          long length)
                   throws BufferUnderflowException,
                          net.openhft.chronicle.core.io.ClosedIllegalStateException

Description copied from interface: BytesStore

Returns if a portion of a specified BytesStore matches this BytesStore.

Specified by:

equalBytes in interface BytesStore<Bytes<U>,U>

Parameters:

bytesStore - the BytesStore to match against

length - the length to match

Returns:

true if the bytes up to min(length, this.length(), bytesStore.length()) matched.

Throws:

BufferUnderflowException - If there's not enough data to be moved

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

read8Bit

public void read8Bit(char[] chars,
                     int length)
              throws BufferUnderflowException,
                     net.openhft.chronicle.core.io.ClosedIllegalStateException

Throws:

BufferUnderflowException

net.openhft.chronicle.core.io.ClosedIllegalStateException

byteCheckSum

public int byteCheckSum(int start,
                        int end)
                 throws net.openhft.chronicle.core.io.IORuntimeException,
                        BufferUnderflowException

Description copied from class: AbstractBytes

Returns the bytes sum between the specified indexes; start (inclusive) and end (exclusive).

Overrides:

byteCheckSum in class AbstractBytes<U>

Parameters:

start - the index of the first byte to sum

end - the index of the last byte to sum

Returns:

unsigned bytes sum

Throws:

BufferUnderflowException - If the specified indexes are outside the limits of the BytesStore

net.openhft.chronicle.core.io.IORuntimeException

appendUtf8

@NotNull
public @NotNull Bytes<U> appendUtf8(char[] chars,
                                             int offset,
                                             int length)
                                      throws BufferOverflowException,
                                             net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                             BufferUnderflowException,
                                             IllegalArgumentException,
                                             net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: StreamingDataOutput

Appends a UTF-8 encoded CharSequence to this output stream from a specific offset and length.

Specified by:

appendUtf8 in interface StreamingDataOutput<Bytes<U>>

Parameters:

chars - The CharSequence to be appended.

offset - The offset from which to start writing the CharSequence.

length - The number of characters from the CharSequence to write.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If there is not enough space left in the output stream.

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

BufferUnderflowException - If there is not enough data available in the input CharSequence.

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

IllegalArgumentException

toTemporaryDirectByteBuffer

public ByteBuffer toTemporaryDirectByteBuffer()
                                       throws IllegalArgumentException,
                                              ArithmeticException,
                                              net.openhft.chronicle.core.io.ClosedIllegalStateException

Description copied from interface: RandomDataInput

Converts the byte sequence into a direct byte buffer.

Specified by:

toTemporaryDirectByteBuffer in interface RandomDataInput

Returns:

a direct ByteBuffer containing the data of this byte sequence.

Throws:

IllegalArgumentException - If the byte sequence cannot be converted into a ByteBuffer.

ArithmeticException - If the calculated size of the ByteBuffer is invalid.

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

read

public int read(byte[] bytes)
         throws BufferUnderflowException,
                net.openhft.chronicle.core.io.ClosedIllegalStateException,
                net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: StreamingDataInput

Reads the input stream into the provided byte array.

Specified by:

read in interface StreamingDataInput<Bytes<U>>

Parameters:

bytes - the byte array to fill with the read data

Returns:

the number of bytes read, or -1 if the end of the stream is reached

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

compareTo

public int compareTo(@NotNull
                     @NotNull CharSequence cs)

Specified by:

compareTo in interface Comparable<CharSequence>