net.openhft.chronicle.bytes

Class GuardedNativeBytes<Underlying>

java.lang.Object

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

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

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

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

All Implemented Interfaces:

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

public class GuardedNativeBytes<Underlying>
extends NativeBytes<Underlying>

Nested Class Summary

Nested classes/interfaces inherited from class net.openhft.chronicle.bytes.NativeBytes

NativeBytes.NativeSubBytes

Field Summary

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

bytesStore, isPresent, readPosition, writeLimit, writePosition

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

DEFAULT_BYTE_BUFFER_CAPACITY, MAX_BYTE_BUFFER_CAPACITY, MAX_CAPACITY

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

charToString

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

JAVA9_STRING_CODER_LATIN, JAVA9_STRING_CODER_UTF16

Constructor Summary

Constructors

Constructor and Description
GuardedNativeBytes(@NotNull BytesStore store)

Method Summary

Modifier and Type	Method and Description
default long	addressForRead(long offset, int buffer)
default ByteOrder	byteOrder()
default boolean	compareAndSwapDouble(long offset, double expected, double value) Perform a 64-bit double CAS at a given offset.
default boolean	compareAndSwapFloat(long offset, float expected, float value) Perform a 32-bit float CAS at a given offset.
default void	parse8bit(Appendable buffer, @NotNull StopCharsTester stopCharsTester) parse text with ISO-8859-1 decoding as character terminated.
default void	parse8bit(Appendable buffer, @NotNull StopCharTester stopCharTester) parse text with ISO-8859-1 decoding as character terminated.
default void	parse8bit(Bytes buffer, @NotNull StopCharsTester stopCharsTester)
default String	parse8bit(@NotNull StopCharTester stopCharTester) parse text with ISO-8859-1 decoding as character terminated.
default void	parse8bit(StringBuilder buffer, @NotNull StopCharsTester stopCharsTester)
default @NotNull BigDecimal	parseBigDecimal()
default @Nullable Boolean	parseBoolean()
default @Nullable Boolean	parseBoolean(@NotNull StopCharTester tester) Return true or false, or null if it could not be detected as true or false.
default double	parseDouble() parse text as a double decimal.
default float	parseFloat() parse text as a float decimal.
default int	parseInt() parse text as an int.
default long	parseLong() parse text as a long integer.
default long	parseLongDecimal() Parse the significant digits of a decimal number.
default void	parseUTF(@NotNull Appendable buffer, @NotNull StopCharsTester stopCharsTester) Deprecated.
default void	parseUTF(@NotNull Appendable buffer, @NotNull StopCharTester stopCharTester) Deprecated.
default @NotNull String	parseUTF(@NotNull StopCharTester stopCharTester) Deprecated.
default void	parseUtf8(@NotNull Appendable buffer, @NotNull StopCharsTester stopCharsTester) parse text with UTF-8 decoding as one or two character terminated.
default void	parseUtf8(@NotNull Appendable buffer, @NotNull StopCharTester stopCharTester) parse text with UTF-8 decoding as character terminated.
default @NotNull String	parseUtf8(@NotNull StopCharTester stopCharTester) parse text with UTF-8 decoding as character terminated.
byte	rawReadByte()
int	rawReadInt()
Bytes<Underlying>	rawWriteByte(byte i8)
Bytes<Underlying>	rawWriteInt(int i)
byte	readByte()
double	readDouble()
default @NotNull Reader	reader() Access these bytes as an ISO-8859-1 encoded Reader
float	readFloat()
int	readInt()
long	readLong()
short	readShort()
long	readStopBit()
char	readStopBitChar()
int	readUnsignedByte()
default boolean	skipTo(@NotNull StopCharTester tester) Skip text until a terminating character is reached.
@NotNull Bytes<Underlying>	writeByte(byte i8)
@NotNull Bytes<Underlying>	writeDouble(double d)
@NotNull Bytes<Underlying>	writeFloat(float f)
@NotNull Bytes<Underlying>	writeInt(int i)
@NotNull Bytes	writeLong(long i64)
default long	writeRemaining()
@NotNull Bytes<Underlying>	writeShort(short i16)
@NotNull Bytes<Underlying>	writeStopBit(char x)
@NotNull Bytes<Underlying>	writeStopBit(long x) Write a stop bit encoded long

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

areNewGuarded, capacity, copyOf, ensureCapacity, isElastic, nativeBytes, nativeBytes, readRemaining, resetNewGuarded, setNewGuarded, wrapWithNativeBytes, write, write, write8bit, writeCheckOffset, writeOffsetPositionMoved, writeSome

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

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

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

addressForRead, addressForWrite, addressForWritePosition, append, byteCheckSum, byteCheckSum, bytesStore, canReadDirect, canWriteDirect, checkRefCount, clear, clearAndPad, compact, compareAndSwapInt, compareAndSwapLong, equals, equalsBytes, hashCode, isDirectMemory, isPresent, isPresent, lastDecimalPlaces, lastDecimalPlaces, lenient, lenient, move, nativeRead, nativeRead, nativeWrite, nativeWrite, peekUnsignedByte, peekUnsignedByte, prewrite, prewrite, prewriteByte, prewriteInt, prewriteLong, prewriteOffsetPositionMoved, prewriteShort, readByte, readDouble, readFloat, readInt, readLimit, readLimit, readLong, readOffsetPositionMoved, readPosition, readPosition, readShort, readSkip, readUnsignedByte, readVolatileByte, readVolatileInt, readVolatileInt, readVolatileLong, readVolatileShort, realWriteRemaining, refCount, release, reserve, safeCopySize, start, testAndSetInt, tryReserve, uncheckedReadSkipBackOne, uncheckedReadSkipOne, uncheckedReadUnsignedByte, underlyingObject, write, write, write, write, writeByte, writeCheckOffset0, 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 java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

bytesStore

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

allocateDirect, allocateDirect, allocateElasticDirect, allocateElasticDirect, copyTo, copyTo, elasticByteBuffer, elasticByteBuffer, elasticByteBuffer, elasticHeapByteBuffer, from, from, fromHexString, fromString, indexOf, indexOf, indexOf, indexOf, isClear, readBigDecimal, readBigInteger, readMarshallableLength16, readWithLength, readWrite, safeLimit, sharedMemory, toHexString, toHexString, toHexString, toString, toString, toString, unchecked, unchecked, unwrite, wrapForRead, wrapForRead, wrapForWrite, wrapForWrite, write, writeMarshallableLength16

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

addAndGetByteNotAtomic, addAndGetDoubleNotAtomic, addAndGetFloatNotAtomic, addAndGetIntNotAtomic, addAndGetLongNotAtomic, addAndGetShortNotAtomic, addAndGetUnsignedByteNotAtomic, addAndGetUnsignedIntNotAtomic, addAndGetUnsignedShortNotAtomic, bytesForWrite, charAt, cipher, cipher, contentEquals, empty, endsWith, inside, inside, isEmpty, length, longCheckSum, nativePointer, startsWith, startsWith, subSequence, to8bitString, toDebugString, toDebugString, wrap, wrap, wrap, writeMaxLong, zeroOut

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

append, append, write, write, writeBoolean, writeByte, writeInt24, writeOrderedDouble, writeOrderedFloat, writeUnsignedByte, writeUnsignedInt, writeUnsignedShort, writeUtf8, writeUtf8Limited, writeVolatileDouble, writeVolatileFloat

Methods inherited from interface java.lang.CharSequence

chars, codePoints

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

bytesMethodReader, bytesMethodReaderBuilder, readObject

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

addAndGetDouble, addAndGetFloat, addAndGetInt, addAndGetLong, compareUtf8, copyTo, copyTo, createCharToString, fastHash, findByte, parseLong, peekVolatileInt, printable, read, readBoolean, readIncompleteLong, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8Limited, readUtf8Limited, readVolatileDouble, readVolatileFloat, subBytes, toByteArray

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

inputStream, parseHexLong, parseUTF, parseUtf8, read, read, read, read, read8bit, read8bit, read8bit, read8bit, readBoolean, readChar, readEnum, readHistogram, readIncompleteLong, readInt24, readPositionRemaining, readPositionUnlimited, readStopBitDecimal, readStopBitDouble, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8, readUTFΔ, readUTFΔ, readWithLength, readWithLength, readWithLength0

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

bytesMethodWriter, bytesMethodWriterBuilder, writeObject

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

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

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

alignBy, appendUtf8, appendUtf8, appendUtf8, appendUtf8, copyFrom, outputStream, write, write, write, write, write8bit, write8bit, write8bit, writeBigDecimal, writeBigInteger, writeBoolean, writeChar, writeEnum, writeHistogram, writeInt24, writePositionRemaining, writeStopBit, writeStopBitDecimal, writeUnsignedByte, writeUnsignedInt, writeUnsignedInt24, writeUnsignedShort, writeUtf8, writeUtf8, writeUTFΔ, writeWithLength

Methods inherited from interface net.openhft.chronicle.core.ReferenceCounted

release, releaseAll

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

prepend

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

comment, indent, retainsComments

Constructor Detail

GuardedNativeBytes

public GuardedNativeBytes(@NotNull
                          @NotNull BytesStore store)
                   throws IllegalStateException

Throws:

IllegalStateException

Method Detail

writeByte

@NotNull
public @NotNull Bytes<Underlying> writeByte(byte i8)
                                              throws BufferOverflowException

Specified by:

writeByte in interface StreamingDataOutput<Bytes<Underlying>>

Overrides:

writeByte in class NativeBytes<Underlying>

Throws:

BufferOverflowException

rawWriteByte

public Bytes<Underlying> rawWriteByte(byte i8)
                               throws BufferOverflowException

Throws:

BufferOverflowException

rawWriteInt

public Bytes<Underlying> rawWriteInt(int i)
                              throws BufferOverflowException

Throws:

BufferOverflowException

readByte

public byte readByte()

Overrides:

readByte in class AbstractBytes<Underlying>

rawReadByte

public byte rawReadByte()

rawReadInt

public int rawReadInt()

readUnsignedByte

public int readUnsignedByte()

Overrides:

readUnsignedByte in class AbstractBytes<Underlying>

Returns:

the next unsigned 8 bit value or -1;

writeShort

@NotNull
public @NotNull Bytes<Underlying> writeShort(short i16)
                                               throws BufferOverflowException

Specified by:

writeShort in interface StreamingDataOutput<Bytes<Underlying>>

Overrides:

writeShort in class AbstractBytes<Underlying>

Throws:

BufferOverflowException

readShort

public short readShort()
                throws BufferUnderflowException

Overrides:

readShort in class AbstractBytes<Underlying>

Throws:

BufferUnderflowException

writeStopBit

@NotNull
public @NotNull Bytes<Underlying> writeStopBit(char x)
                                                 throws BufferOverflowException

Throws:

BufferOverflowException

writeStopBit

@NotNull
public @NotNull Bytes<Underlying> writeStopBit(long x)
                                                 throws BufferOverflowException

Description copied from interface: StreamingDataOutput

Write a stop bit encoded long

Parameters:

x - long to write

Returns:

this.

Throws:

BufferOverflowException

readStopBit

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

Throws:

net.openhft.chronicle.core.io.IORuntimeException

readStopBitChar

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

Throws:

net.openhft.chronicle.core.io.IORuntimeException

writeInt

@NotNull
public @NotNull Bytes<Underlying> writeInt(int i)
                                             throws BufferOverflowException

Specified by:

writeInt in interface StreamingDataOutput<Bytes<Underlying>>

Overrides:

writeInt in class AbstractBytes<Underlying>

Throws:

BufferOverflowException

readInt

public int readInt()
            throws BufferUnderflowException

Overrides:

readInt in class AbstractBytes<Underlying>

Throws:

BufferUnderflowException

writeLong

@NotNull
public @NotNull Bytes writeLong(long i64)
                                  throws BufferOverflowException

Specified by:

writeLong in interface StreamingDataOutput<Bytes<Underlying>>

Overrides:

writeLong in class NativeBytes<Underlying>

Throws:

BufferOverflowException

readLong

public long readLong()
              throws BufferUnderflowException

Overrides:

readLong in class AbstractBytes<Underlying>

Throws:

BufferUnderflowException

writeFloat

@NotNull
public @NotNull Bytes<Underlying> writeFloat(float f)
                                               throws BufferOverflowException

Specified by:

writeFloat in interface StreamingDataOutput<Bytes<Underlying>>

Overrides:

writeFloat in class AbstractBytes<Underlying>

Throws:

BufferOverflowException

readFloat

public float readFloat()
                throws BufferUnderflowException

Overrides:

readFloat in class AbstractBytes<Underlying>

Throws:

BufferUnderflowException

writeDouble

@NotNull
public @NotNull Bytes<Underlying> writeDouble(double d)
                                                throws BufferOverflowException

Specified by:

writeDouble in interface StreamingDataOutput<Bytes<Underlying>>

Overrides:

writeDouble in class AbstractBytes<Underlying>

Throws:

BufferOverflowException

readDouble

public double readDouble()
                  throws BufferUnderflowException

Overrides:

readDouble in class AbstractBytes<Underlying>

Throws:

BufferUnderflowException

reader

@NotNull
public @NotNull Reader reader()

Access these bytes as an ISO-8859-1 encoded Reader

Returns:

as a Reader

parseBoolean

@Nullable
public @Nullable Boolean parseBoolean(@NotNull
                                                @NotNull StopCharTester tester)

Return true or false, or null if it could not be detected as true or false. Case is not important

false: f, false, n, no, 0

true: t, true, y, yes, 1

Parameters:

tester - to detect the end of the text.

Returns:

true, false, or null if neither.

parseBoolean

@Nullable
public @Nullable Boolean parseBoolean()

parseUtf8

@NotNull
public @NotNull String parseUtf8(@NotNull
                                          @NotNull StopCharTester stopCharTester)

parse text with UTF-8 decoding as character terminated.

Parameters:

stopCharTester - to check if the end has been reached.

Returns:

the text as a String.

parseUTF

@NotNull
 @Deprecated
public @NotNull String parseUTF(@NotNull
                                                      @NotNull StopCharTester stopCharTester)

Deprecated.

parseUtf8

public void parseUtf8(@NotNull
                      @NotNull Appendable buffer,
                      @NotNull
                      @NotNull StopCharTester stopCharTester)
               throws BufferUnderflowException

parse text with UTF-8 decoding as character terminated.

Parameters:

buffer - to populate

stopCharTester - to check if the end has been reached.

Throws:

BufferUnderflowException

parseUTF

@Deprecated
public void parseUTF(@NotNull
                                 @NotNull Appendable buffer,
                                 @NotNull
                                 @NotNull StopCharTester stopCharTester)
                          throws BufferUnderflowException

Deprecated.

Throws:

BufferUnderflowException

parseUtf8

public void parseUtf8(@NotNull
                      @NotNull Appendable buffer,
                      @NotNull
                      @NotNull StopCharsTester stopCharsTester)
               throws BufferUnderflowException,
                      net.openhft.chronicle.core.io.IORuntimeException

parse text with UTF-8 decoding as one or two character terminated.

Parameters:

buffer - to populate

stopCharsTester - to check if the end has been reached.

Throws:

BufferUnderflowException

net.openhft.chronicle.core.io.IORuntimeException

parseUTF

@Deprecated
public void parseUTF(@NotNull
                                 @NotNull Appendable buffer,
                                 @NotNull
                                 @NotNull StopCharsTester stopCharsTester)
                          throws BufferUnderflowException,
                                 net.openhft.chronicle.core.io.IORuntimeException

Deprecated.

Throws:

BufferUnderflowException

net.openhft.chronicle.core.io.IORuntimeException

parse8bit

public void parse8bit(Appendable buffer,
                      @NotNull
                      @NotNull StopCharTester stopCharTester)
               throws BufferUnderflowException

parse text with ISO-8859-1 decoding as character terminated.

Parameters:

buffer - to populate

stopCharTester - to check if the end has been reached.

Throws:

BufferUnderflowException

parse8bit

public String parse8bit(@NotNull
                        @NotNull StopCharTester stopCharTester)
                 throws BufferUnderflowException

parse text with ISO-8859-1 decoding as character terminated.

Parameters:

stopCharTester - to check if the end has been reached.

Throws:

BufferUnderflowException

parse8bit

public void parse8bit(Appendable buffer,
                      @NotNull
                      @NotNull StopCharsTester stopCharsTester)
               throws BufferUnderflowException

parse text with ISO-8859-1 decoding as character terminated.

Parameters:

buffer - to populate

stopCharsTester - to check if the end has been reached.

Throws:

BufferUnderflowException

parse8bit

public void parse8bit(Bytes buffer,
                      @NotNull
                      @NotNull StopCharsTester stopCharsTester)
               throws BufferUnderflowException

Throws:

BufferUnderflowException

parse8bit

public void parse8bit(StringBuilder buffer,
                      @NotNull
                      @NotNull StopCharsTester stopCharsTester)
               throws BufferUnderflowException

Throws:

BufferUnderflowException

parseInt

public int parseInt()
             throws BufferUnderflowException

parse text as an int. The terminating character is consumed.

Returns:

an int.

Throws:

BufferUnderflowException

parseLong

public long parseLong()
               throws BufferUnderflowException

parse text as a long integer. The terminating character is consumed.

Returns:

a long.

Throws:

BufferUnderflowException

parseFloat

public float parseFloat()
                 throws BufferUnderflowException

parse text as a float decimal. The terminating character is consumed.

The number of decimal places can be retrieved with lastDecimalPlaces()

Returns:

a float.

Throws:

BufferUnderflowException

parseDouble

public double parseDouble()
                   throws BufferUnderflowException

parse text as a double decimal. The terminating character is consumed.

The number of decimal places can be retrieved with lastDecimalPlaces()

Returns:

a double.

Throws:

BufferUnderflowException

parseLongDecimal

public long parseLongDecimal()
                      throws BufferUnderflowException

Parse the significant digits of a decimal number.

The number of decimal places can be retrieved with lastDecimalPlaces()

Returns:

the significant digits

Throws:

BufferUnderflowException

skipTo

public boolean skipTo(@NotNull
                      @NotNull StopCharTester tester)

Skip text until a terminating character is reached.

Parameters:

tester - to stop at

Returns:

true if a terminating character was found, false if the end of the buffer was reached.

parseBigDecimal

@NotNull
public @NotNull BigDecimal parseBigDecimal()

writeRemaining

public long writeRemaining()

Returns:

How many more bytes can we written.

addressForRead

public long addressForRead(long offset,
                           int buffer)
                    throws UnsupportedOperationException,
                           BufferUnderflowException

Throws:

UnsupportedOperationException

BufferUnderflowException

byteOrder

public ByteOrder byteOrder()

compareAndSwapFloat

public boolean compareAndSwapFloat(long offset,
                                   float expected,
                                   float value)
                            throws BufferOverflowException

Perform a 32-bit float CAS at a given offset.

Parameters:

offset - to perform CAS

expected - value

value - to set

Returns:

true, if successful.

Throws:

BufferOverflowException

compareAndSwapDouble

public boolean compareAndSwapDouble(long offset,
                                    double expected,
                                    double value)
                             throws BufferOverflowException

Perform a 64-bit double CAS at a given offset.

Parameters:

offset - to perform CAS

expected - value

value - to set

Returns:

true, if successful.

Throws:

BufferOverflowException