net.openhft.chronicle.bytes.internal

Class CommonMappedBytes

java.lang.Object

net.openhft.chronicle.core.io.AbstractReferenceCounted

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

net.openhft.chronicle.bytes.MappedBytes

net.openhft.chronicle.bytes.internal.CommonMappedBytes

All Implemented Interfaces:

Closeable, Appendable, AutoCloseable, CharSequence, Bytes<Void>, BytesIn<Void>, BytesOut<Void>, BytesPrepender<Bytes<Void>>, BytesStore<Bytes<Void>,Void>, ByteStringAppender<Bytes<Void>>, ByteStringParser<Bytes<Void>>, HexDumpBytesDescription<BytesOut<Void>>, HasUncheckedRandomDataInput, RandomDataInput, RandomDataOutput<Bytes<Void>>, DecimalAppender, StreamingCommon<Bytes<Void>>, StreamingDataInput<Bytes<Void>>, StreamingDataOutput<Bytes<Void>>, net.openhft.chronicle.core.io.ManagedCloseable, net.openhft.chronicle.core.io.QueryCloseable, net.openhft.chronicle.core.io.ReferenceCounted, net.openhft.chronicle.core.io.ReferenceCountedTracer, net.openhft.chronicle.core.io.ReferenceOwner, net.openhft.chronicle.core.io.SingleThreadedChecked, net.openhft.chronicle.core.io.Syncable

Direct Known Subclasses:

ChunkedMappedBytes, SingleMappedBytes

public abstract class CommonMappedBytes
extends MappedBytes

Bytes to wrap memory mapped data.

NOTE These Bytes are single Threaded as are all Bytes.

Field Summary

Fields

Modifier and Type	Field and Description
protected long	lastActualSize
protected MappedFile	mappedFile

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

TRACE

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	CommonMappedBytes(@NotNull MappedFile mappedFile)
protected	CommonMappedBytes(@NotNull MappedFile mappedFile, String name)

Method Summary

Modifier and Type	Method and Description
@NotNull Bytes<Void>	append8bit(@NotNull CharSequence text, int start, int end) Appends a portion of a string to this Bytes in ISO-8859-1.
@NotNull Bytes<Void>	appendUtf8(@NotNull CharSequence cs, int start, int length) Appends a UTF-8 encoded CharSequence to this output stream from a specific offset and length.
long	capacity() Provides the maximum limit that can be set for the ByteStore.
void	chunkCount(long[] chunkCount) Updates the number of chunks in the mapped file.
@NotNull Bytes<Void>	clear() Clears the content of this Bytes object and resets its state.
void	close()
BytesStore<Bytes<Void>,Void>	copy() Creates and returns a deep copy of this Bytes object, including the data between RandomCommon.readPosition() and RandomCommon.readLimit().
CommonMappedBytes	disableThreadSafetyCheck(boolean disableThreadSafetyCheck) Deprecated.
boolean	isBackingFileReadOnly() Checks if the backing file is read-only.
boolean	isClosed()
boolean	isDirectMemory() Checks if this BytesStore uses direct memory.
@NotNull MappedFile	mappedFile() Retrieves the mapped file.
protected void	performRelease()
@Nullable String	read8bit() Reads an 8-bit encoded string from the input stream.
Bytes<Void>	readLimitToCapacity() Sets the read limit of this StreamingDataInput to its capacity.
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.
boolean	readWrite() Checks if this Bytes object supports both reading and writing.
long	realCapacity() Returns the actual capacity of the ByteStore before any resizing occurs.
long	realReadRemaining() Calculates the number of bytes that can be safely read directly.
long	realWriteRemaining() Calculates the number of bytes remaining that can be written from the current write position with resizing.
void	release(net.openhft.chronicle.core.io.ReferenceOwner id)
void	releaseLast(net.openhft.chronicle.core.io.ReferenceOwner id)
void	singleThreadedCheckDisabled(boolean singleThreadedCheckDisabled)
void	singleThreadedCheckReset()
long	start()
void	throwExceptionIfClosed()
@NotNull String	toString()
void	warnAndCloseIfNotClosed()
@NotNull CommonMappedBytes	write(byte[] byteArray, int offset, int length) Writes the specified number of bytes from the given byteArray into the output stream, starting from the given offset.
@NotNull CommonMappedBytes	write(long offsetInRDO, @NotNull RandomDataInput bytes)
@NotNull CommonMappedBytes	write(@NotNull RandomDataInput bytes) Writes all available data from the specified RandomDataInput into the output stream.
@NotNull Bytes<Void>	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.
@NotNull CommonMappedBytes	write8bit(@NotNull CharSequence text, int start, int length) Writes a subsequence of a CharSequence as an 8-bit string to the data stream.
@NotNull Bytes<Void>	writePosition(long position) Sets the current write position in the data stream.
@NotNull Bytes<Void>	writeSkip(long bytesToSkip) Skips a specified number of bytes from the current write position in the data stream.
@NotNull Bytes<Void>	writeStopBit(char n) Writes a stop bit encoded char to the data stream.
@NotNull Bytes<Void>	writeStopBit(long n) Writes a stop bit encoded long to the data stream.
@NotNull Bytes<Void>	writeUtf8(@Nullable CharSequence text) Writes a UTF-8 encoded string to the data stream, similar to writeUTF, but with a few differences.
@NotNull Bytes<Void>	writeUtf8(@Nullable String text) Writes a UTF-8 encoded String to the data stream.

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

bytesForRead, bytesForWrite, mappedBytes, mappedBytes, mappedBytes, mappedBytes, mappedBytes, mappedBytes, readOnly, sharedMemory, singleMappedBytes, singleMappedBytes, singleMappedBytes, sync

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

acquireUncheckedInput, addressForRead, addressForWrite, addressForWritePosition, append, append, append, append, append, append, appendAndReturnLength, byteCheckSum, byteCheckSum, byteCheckSum, bytesStore, bytesStore, canReadDirect, canWriteDirect, clearAndPad, compact, compareAndSwapInt, compareAndSwapLong, copyTo, decimaliser, decimaliser, equals, fpAppend0, fpAppend0, hashCode, internalNumberBuffer, isElastic, isImmutableEmptyByteStore, lastDecimalPlaces, lastDecimalPlaces, lastNumberHadDigits, lastNumberHadDigits, length, lenient, lenient, move, nativeRead, nativeWrite, peekUnsignedByte, peekUnsignedByte, 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, readVolatileLong, readVolatileShort, safeCopySize, startsWith, testAndSetInt, uncheckedReadSkipBackOne, uncheckedReadSkipOne, uncheckedReadUnsignedByte, uncheckedWritePosition, underlyingObject, 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, writeShort, writeShort, 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, removeReferenceChangeListener, 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.core.io.ManagedCloseable

createdHere

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

closeQuietly, closeQuietly

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

isClosing

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

syncIfAvailable

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

allocateDirect, allocateDirect, allocateElasticDirect, allocateElasticDirect, allocateElasticOnHeap, allocateElasticOnHeap, copyTo, copyTo, directFrom, elasticByteBuffer, elasticByteBuffer, elasticByteBuffer, elasticHeapByteBuffer, elasticHeapByteBuffer, empty, ensureCapacity, forFieldGroup, from, from, fromDirect, fromHexString, indexOf, indexOf, isClear, isEqual, readMarshallableLength16, readWithLength, safeLimit, 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, equalBytes, 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, findByte, parseLong, peekVolatileInt, printable, readBoolean, readIncompleteLong, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8Limited, readUtf8Limited, readVolatileDouble, readVolatileFloat, subBytes, toByteArray, toTemporaryDirectByteBuffer

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

parse8bit, parse8bit, parse8bit, parse8bit, parse8bit, parseBigDecimal, parseBoolean, parseBoolean, parseDouble, parseFlexibleLong, parseFloat, parseInt, parseLong, 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, read, read8bit, read8bit, readBigDecimal, readBigInteger, readBoolean, readChar, readEnum, readHistogram, readIncompleteLong, readInt24, readPositionRemaining, readPositionUnlimited, 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, append, append8bit, append8bit, append8bit, append8bit, appendBase, appendBase16, appendBase16, appendDateMillis, appendDecimal, appendTimeMillis, writer

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

appendUtf8, appendUtf8, appendUtf8, appendUtf8, appendUtf8, copyFrom, outputStream, rawWriteByte, rawWriteInt, rawWriteLong, unsafeWrite, unsafeWriteObject, unsafeWriteObject, write, write, write, write, write8bit, write8bit, writeBigDecimal, writeBigInteger, writeChar, writeEnum, writeHistogram, writeInt24, writePositionForHeader, writePositionRemaining, writeSome, writeStopBit, writeStopBitDecimal, writeUnsignedByte, writeUnsignedInt, writeUnsignedInt24, writeUnsignedShort, 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.ReferenceCountedTracer

onReleased

Field Detail

mappedFile

protected final MappedFile mappedFile

lastActualSize

protected long lastActualSize

Constructor Detail

CommonMappedBytes

protected CommonMappedBytes(@NotNull
                            @NotNull MappedFile mappedFile)
                     throws net.openhft.chronicle.core.io.ClosedIllegalStateException

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException

CommonMappedBytes

protected CommonMappedBytes(@NotNull
                            @NotNull MappedFile mappedFile,
                            String name)
                     throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                            net.openhft.chronicle.core.io.ClosedIllegalStateException,
                            net.openhft.chronicle.core.io.ThreadingIllegalStateException

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException

net.openhft.chronicle.core.io.ThreadingIllegalStateException

Method Detail

singleThreadedCheckReset

public void singleThreadedCheckReset()

Specified by:

singleThreadedCheckReset in interface net.openhft.chronicle.core.io.SingleThreadedChecked

Overrides:

singleThreadedCheckReset in class net.openhft.chronicle.core.io.AbstractReferenceCounted

write

@NotNull
public @NotNull CommonMappedBytes write(byte[] byteArray,
                                                 int offset,
                                                 int length)
                                          throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                 BufferOverflowException

Description copied from interface: StreamingDataOutput

Writes the specified number of bytes from the given byteArray into the output stream, starting from the given offset. The position of the output stream is updated according to the number of bytes written.

Specified by:

write in interface StreamingDataOutput<Bytes<Void>>

Overrides:

write in class AbstractBytes<Void>

Parameters:

byteArray - the array of bytes to be written.

offset - the start index in the array from where to start writing bytes.

length - the number of bytes to write.

Returns:

The current StreamingDataOutput instance.

Throws:

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

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

write

@NotNull
public @NotNull CommonMappedBytes write(@NotNull
                                                 @NotNull RandomDataInput bytes)
                                          throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                 BufferOverflowException

Description copied from interface: StreamingDataOutput

Writes all available data from the specified RandomDataInput into the output stream. The position of this output stream is updated accordingly, but the read position of the input data is not changed. The operation will fail if there is not enough space left in the output stream.

Specified by:

write in interface StreamingDataOutput<Bytes<Void>>

Overrides:

write in class AbstractBytes<Void>

Parameters:

bytes - the RandomDataInput from which data is read.

Returns:

The current StreamingDataOutput instance.

Throws:

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

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

write

@NotNull
public @NotNull CommonMappedBytes write(long offsetInRDO,
                                                 @NotNull
                                                 @NotNull RandomDataInput bytes)
                                          throws BufferOverflowException,
                                                 net.openhft.chronicle.core.io.ClosedIllegalStateException

Throws:

BufferOverflowException

net.openhft.chronicle.core.io.ClosedIllegalStateException

mappedFile

@NotNull
public @NotNull MappedFile mappedFile()

Description copied from class: MappedBytes

Retrieves the mapped file.

Specified by:

mappedFile in class MappedBytes

Returns:

the MappedFile instance.

copy

public BytesStore<Bytes<Void>,Void> copy()
                                  throws net.openhft.chronicle.core.io.ClosedIllegalStateException

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.

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.

capacity

public long capacity()

Description copied from interface: BytesStore

Provides the maximum limit that can be set for the ByteStore.

Specified by:

capacity in interface BytesStore<Bytes<Void>,Void>

Overrides:

capacity in class AbstractBytes<Void>

Returns:

the maximum capacity of the ByteStore

readLimitToCapacity

public Bytes<Void> readLimitToCapacity()

Description copied from interface: StreamingDataInput

Sets the read limit of this StreamingDataInput to its capacity.

Returns:

this StreamingDataInput instance, for chaining

realReadRemaining

public long realReadRemaining()

Calculates the number of bytes that can be safely read directly.

If the resource is closed, the returned value is unspecified.

Returns:

The number of bytes that can be safely read directly.

realWriteRemaining

public long realWriteRemaining()

Calculates the number of bytes remaining that can be written from the current write position with resizing.

If the resource is closed, the returned value is unspecified.

Returns:

The number of bytes that can still be written with resizing.

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<Void>

Specified by:

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

Specified by:

realCapacity in interface RandomDataInput

Specified by:

realCapacity in interface StreamingDataOutput<Bytes<Void>>

Overrides:

realCapacity in class AbstractBytes<Void>

Returns:

the current capacity of the ByteStore

read8bit

@Nullable
public @Nullable String read8bit()
                                    throws net.openhft.chronicle.core.io.IORuntimeException,
                                           BufferUnderflowException,
                                           net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                           ArithmeticException

Description copied from interface: StreamingDataInput

Reads an 8-bit encoded string from the input stream.

Returns:

an 8-bit string or null if write8bit(null) was called

Throws:

net.openhft.chronicle.core.io.IORuntimeException - If an IO error occurs

BufferUnderflowException - If there's not enough data to read

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

ArithmeticException - If numeric overflow or underflow occurs

writeSkip

@NotNull
public @NotNull Bytes<Void> writeSkip(long bytesToSkip)
                                        throws BufferOverflowException,
                                               net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                               net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                               net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: StreamingDataOutput

Skips a specified number of bytes from the current write position in the data stream. This method adjusts the write position either forward or backward based on the value of bytesToSkip. The new position should not exceed the write limit.

Specified by:

writeSkip in interface StreamingDataOutput<Bytes<Void>>

Overrides:

writeSkip in class AbstractBytes<Void>

Parameters:

bytesToSkip - The number of bytes to skip. This can be a negative number to move the position backward.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If the new position calculated by the skip operation falls outside the limits of the data 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

start

public long start()

Overrides:

start in class AbstractBytes<Void>

Returns:

The smallest position allowed in this buffer.

writePosition

@NotNull
public @NotNull Bytes<Void> writePosition(long position)
                                            throws BufferOverflowException

Description copied from interface: StreamingDataOutput

Sets the current write position in the data stream. The write position indicates the point where the next write operation will begin. Calling this method does not modify the data in the stream; it only changes the position where future write operations will take place.

Specified by:

writePosition in interface StreamingDataOutput<Bytes<Void>>

Overrides:

writePosition in class AbstractBytes<Void>

Parameters:

position - The new write position. It must be a non-negative number.

Returns:

The current StreamingDataOutput instance.

Throws:

BufferOverflowException - If the specified position exceeds the limit of the data buffer.

clear

@NotNull
public @NotNull Bytes<Void> clear()
                                    throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                           net.openhft.chronicle.core.io.ClosedIllegalStateException

Description copied from interface: Bytes

Clears the content of this Bytes object and resets its state.

Specified by:

clear in interface Bytes<Void>

Specified by:

clear in interface StreamingCommon<Bytes<Void>>

Overrides:

clear in class AbstractBytes<Void>

Returns:

This Bytes object.

Throws:

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

performRelease

protected void performRelease()
                       throws net.openhft.chronicle.core.io.ClosedIllegalStateException

Overrides:

performRelease in class AbstractBytes<Void>

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException

write

@NotNull
public @NotNull Bytes<Void> write(@NotNull
                                           @NotNull RandomDataInput bytes,
                                           long offset,
                                           long length)
                                    throws BufferUnderflowException,
                                           BufferOverflowException,
                                           net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                           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.

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:

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

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.

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

append8bit

@NotNull
public @NotNull Bytes<Void> append8bit(@NotNull
                                                @NotNull CharSequence text,
                                                int start,
                                                int end)
                                         throws IllegalArgumentException,
                                                BufferOverflowException,
                                                BufferUnderflowException,
                                                IndexOutOfBoundsException,
                                                net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: ByteStringAppender

Appends a portion of a string to this Bytes in ISO-8859-1.

Parameters:

text - the CharSequence to append

start - index of the first char of cs (inclusive) to append

end - index of the last char of cs (exclusive) to append

Returns:

this

Throws:

IllegalArgumentException - If the start or end is negative or too large

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

BufferUnderflowException - If the capacity of the underlying buffer was exceeded

IndexOutOfBoundsException - If the start or the end are not valid for the CharSequence

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.

write8bit

@NotNull
public @NotNull CommonMappedBytes write8bit(@NotNull
                                                     @NotNull CharSequence text,
                                                     int start,
                                                     int length)
                                              throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                     BufferUnderflowException,
                                                     BufferOverflowException,
                                                     ArithmeticException,
                                                     IndexOutOfBoundsException,
                                                     net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: StreamingDataOutput

Writes a subsequence of a CharSequence as an 8-bit string to the data stream. If the CharSequence is an instance of String, the method delegates to the write8bit(String, int, int).

Parameters:

text - The CharSequence to be written.

start - The index of the first char in the CharSequence to write.

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

Returns:

The current StreamingDataOutput instance.

Throws:

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

BufferOverflowException - If there is insufficient space in the buffer.

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

BufferUnderflowException

ArithmeticException

IndexOutOfBoundsException

appendUtf8

@NotNull
public @NotNull Bytes<Void> appendUtf8(@NotNull
                                                @NotNull CharSequence cs,
                                                int start,
                                                int length)
                                         throws BufferOverflowException,
                                                net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                BufferUnderflowException,
                                                IndexOutOfBoundsException,
                                                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.

Parameters:

cs - The CharSequence to be appended.

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

IndexOutOfBoundsException - If the offset or length is out of bounds for the given CharSequence.

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

release

public void release(net.openhft.chronicle.core.io.ReferenceOwner id)
             throws net.openhft.chronicle.core.io.ClosedIllegalStateException

Specified by:

release in interface net.openhft.chronicle.core.io.ReferenceCounted

Overrides:

release in class net.openhft.chronicle.core.io.AbstractReferenceCounted

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException

releaseLast

public void releaseLast(net.openhft.chronicle.core.io.ReferenceOwner id)
                 throws net.openhft.chronicle.core.io.ClosedIllegalStateException

Specified by:

releaseLast in interface net.openhft.chronicle.core.io.ReferenceCounted

Overrides:

releaseLast in class net.openhft.chronicle.core.io.AbstractReferenceCounted

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException

close

public void close()

isClosed

public boolean isClosed()

warnAndCloseIfNotClosed

public void warnAndCloseIfNotClosed()

throwExceptionIfClosed

public void throwExceptionIfClosed()
                            throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                   net.openhft.chronicle.core.io.ThreadingIllegalStateException

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException

net.openhft.chronicle.core.io.ThreadingIllegalStateException

writeUtf8

@NotNull
public @NotNull Bytes<Void> writeUtf8(@Nullable
                                               @Nullable CharSequence text)
                                        throws BufferOverflowException,
                                               net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                               net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: StreamingDataOutput

Writes a UTF-8 encoded string to the data stream, similar to writeUTF, but with a few differences. Firstly, the length is stop bit encoded, meaning that the length encoding may be one byte longer for short strings, but the string's length is not limited. Secondly, the string can be null.

Parameters:

text - The string to be written. Can be null.

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

writeUtf8

@NotNull
public @NotNull Bytes<Void> writeUtf8(@Nullable
                                               @Nullable String text)
                                        throws BufferOverflowException,
                                               net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                               net.openhft.chronicle.core.io.ThreadingIllegalStateException

Description copied from interface: StreamingDataOutput

Writes a UTF-8 encoded String to the data stream. This method is functionally similar to writeUtf8(CharSequence), but it specifically accepts a String as an argument.

Parameters:

text - The string to be written. Can be null.

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

readStopBit

public long readStopBit()
                 throws net.openhft.chronicle.core.io.IORuntimeException,
                        net.openhft.chronicle.core.io.ClosedIllegalStateException,
                        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.

BufferUnderflowException - If there's not enough data to read

readStopBitChar

public char readStopBitChar()
                     throws net.openhft.chronicle.core.io.IORuntimeException,
                            net.openhft.chronicle.core.io.ClosedIllegalStateException,
                            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.

BufferUnderflowException - If there's not enough data to read

writeStopBit

@NotNull
public @NotNull Bytes<Void> writeStopBit(long n)
                                           throws BufferOverflowException,
                                                  net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                  net.openhft.chronicle.core.io.ThreadingIllegalStateException

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:

n - 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

writeStopBit

@NotNull
public @NotNull Bytes<Void> writeStopBit(char n)
                                           throws BufferOverflowException,
                                                  net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                  net.openhft.chronicle.core.io.ThreadingIllegalStateException

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:

n - 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

isBackingFileReadOnly

public boolean isBackingFileReadOnly()

Description copied from class: MappedBytes

Checks if the backing file is read-only.

Specified by:

isBackingFileReadOnly in class MappedBytes

Returns:

true if the backing file is read-only, false otherwise.

isDirectMemory

public boolean isDirectMemory()

Description copied from interface: BytesStore

Checks if this BytesStore uses direct memory.

Specified by:

isDirectMemory in interface BytesStore<Bytes<Void>,Void>

Overrides:

isDirectMemory in class AbstractBytes<Void>

Returns:

true if it uses direct memory, false otherwise

disableThreadSafetyCheck

@Deprecated
public CommonMappedBytes disableThreadSafetyCheck(boolean disableThreadSafetyCheck)

Deprecated.

Description copied from class: MappedBytes

Toggles the thread safety check for the mapped bytes. This method is deprecated and will be removed in future versions.

Specified by:

disableThreadSafetyCheck in class MappedBytes

Parameters:

disableThreadSafetyCheck - true to disable the thread safety check, false to enable it.

Returns:

the current MappedBytes instance.

singleThreadedCheckDisabled

public void singleThreadedCheckDisabled(boolean singleThreadedCheckDisabled)

Specified by:

singleThreadedCheckDisabled in interface net.openhft.chronicle.core.io.SingleThreadedChecked

Overrides:

singleThreadedCheckDisabled in class net.openhft.chronicle.core.io.AbstractReferenceCounted

toString

@NotNull
public @NotNull String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class AbstractBytes<Void>

chunkCount

public void chunkCount(long[] chunkCount)

Description copied from class: MappedBytes

Updates the number of chunks in the mapped file.

Specified by:

chunkCount in class MappedBytes

Parameters:

chunkCount - The new number of chunks.

readWrite

public boolean readWrite()

Description copied from interface: Bytes

Checks if this Bytes object supports both reading and writing.

Returns:

true if this Bytes object supports both reading and writing, false otherwise.