net.openhft.chronicle.bytes

Class VanillaBytes<Underlying>

java.lang.Object

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

net.openhft.chronicle.bytes.VanillaBytes<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>>, StreamingDataInput<Bytes<Underlying>>, StreamingDataOutput<Bytes<Underlying>>, net.openhft.chronicle.core.ReferenceCounted

Direct Known Subclasses:

NativeBytes, SubBytes

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

Simple Bytes implementation which is not Elastic.

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
VanillaBytes(BytesStore bytesStore)
VanillaBytes(BytesStore bytesStore, long writePosition, long writeLimit)

Method Summary

Modifier and Type	Method and Description
VanillaBytes	append(CharSequence str, int start, int end) Append a portion of a String to the Bytes in UTF-8.
Bytes<Underlying>	append8bit(CharSequence cs) Append a String to the Bytes in ISO-8859-1
Bytes<Underlying>	append8bit(String cs)
protected Bytes<Underlying>	append8bit0(CharSequence cs)
Bytes<Underlying>	appendUtf8(char[] chars, int offset, int length)
VanillaBytes	appendUtf8(CharSequence str)
int	byteCheckSum(int start, int end)
Bytes<Underlying>	bytesForRead() Creates a slice of the current Bytes based on its position() and limit().
void	bytesStore(BytesStore<Bytes<Underlying>,Underlying> byteStore, long offset, long length) This setter for a data type which points to an underlying ByteStore.
int	compareTo(CharSequence cs)
BytesStore<Bytes<Underlying>,Underlying>	copy()
boolean	equalBytes(BytesStore bytesStore, long length) Check if a portion of a BytesStore matches this one.
boolean	isElastic()
boolean	isEqual(String s)
long	maxSize()
long	offset()
protected void	optimisedWrite(RandomDataInput bytes, long offset, long length)
default void	parse8bit(Appendable buffer, StopCharsTester stopCharsTester) parse text with ISO-8859-1 decoding as character terminated.
default void	parse8bit(Appendable buffer, StopCharTester stopCharTester) parse text with ISO-8859-1 decoding as character terminated.
default void	parse8bit(Bytes buffer, StopCharsTester stopCharsTester)
default String	parse8bit(StopCharTester stopCharTester) parse text with ISO-8859-1 decoding as character terminated.
default void	parse8bit(StringBuilder buffer, StopCharsTester stopCharsTester)
default BigDecimal	parseBigDecimal()
default Boolean	parseBoolean()
default Boolean	parseBoolean(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(Appendable buffer, StopCharsTester stopCharsTester) Deprecated.
default void	parseUTF(Appendable buffer, StopCharTester stopCharTester) Deprecated.
default String	parseUTF(StopCharTester stopCharTester) Deprecated.
default void	parseUtf8(Appendable buffer, StopCharsTester stopCharsTester) parse text with UTF-8 decoding as one or two character terminated.
default void	parseUtf8(Appendable buffer, StopCharTester stopCharTester) parse text with UTF-8 decoding as character terminated.
default String	parseUtf8(StopCharTester stopCharTester) parse text with UTF-8 decoding as character terminated.
int	read(byte[] bytes)
void	read8Bit(char[] chars, int length)
default Reader	reader() Access these bytes as an ISO-8859-1 encoded Reader
long	readVolatileLong(long offset) Read a 64-bit long from memory with a load barrier.
long	realCapacity()
default boolean	skipTo(StopCharTester tester) Skip text until a terminating character is reached.
String	toString()
protected String	toString0()
ByteBuffer	toTemporaryDirectByteBuffer()
static VanillaBytes<Void>	vanillaBytes()
void	write(long position, CharSequence str, int offset, int length)
Bytes<Underlying>	write(RandomDataInput bytes, long offset, long length) Write all data or fail.

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

addressForRead, addressForWrite, byteCheckSum, byteCheckSum, bytesStore, capacity, 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, readByte, readDouble, readDouble, readFloat, readFloat, readInt, readInt, readLimit, readLimit, readLong, readLong, readOffsetPositionMoved, readPosition, readPosition, readShort, readShort, readSkip, readUnsignedByte, readUnsignedByte, readVolatileByte, readVolatileInt, readVolatileInt, readVolatileLong, readVolatileShort, refCount, release, reserve, safeCopySize, start, testAndSetInt, tryReserve, uncheckedReadSkipBackOne, uncheckedReadSkipOne, uncheckedReadUnsignedByte, underlyingObject, write, write, write, write, writeByte, writeByte, writeCheckOffset0, 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 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, ensureCapacity, 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, 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, readEnum, readHistogram, readInt24, readPositionRemaining, readPositionUnlimited, readStopBit, readStopBitChar, 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, append, 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, write, write, write8bit, write8bit, write8bit, write8bit, writeBigDecimal, writeBigInteger, writeBoolean, writeEnum, writeHistogram, writeInt24, writePositionRemaining, writeSome, writeStopBit, writeStopBit, writeStopBit, writeStopBitDecimal, writeUnsignedByte, writeUnsignedInt, writeUnsignedInt24, writeUnsignedShort, writeUtf8, writeUtf8, writeUTFΔ, writeWithLength

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

prepend

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

comment, indent, retainsComments

Constructor Detail

VanillaBytes

public VanillaBytes(@NotNull
                    BytesStore bytesStore)
             throws IllegalStateException

Throws:

IllegalStateException

VanillaBytes

public VanillaBytes(@NotNull
                    BytesStore bytesStore,
                    long writePosition,
                    long writeLimit)
             throws IllegalStateException

Throws:

IllegalStateException

Method Detail

vanillaBytes

@NotNull
public static VanillaBytes<Void> vanillaBytes()

Returns:

a non elastic bytes.

readVolatileLong

public long readVolatileLong(long offset)
                      throws BufferUnderflowException

Description copied from interface: RandomDataInput

Read a 64-bit long from memory with a load barrier.

Specified by:

readVolatileLong in interface RandomDataInput

Overrides:

readVolatileLong in class AbstractBytes<Underlying>

Parameters:

offset - to read

Returns:

the long value

Throws:

BufferUnderflowException - if the offset is outside the limits of the Bytes

bytesStore

public void bytesStore(@NotNull
                       BytesStore<Bytes<Underlying>,Underlying> byteStore,
                       long offset,
                       long length)
                throws IllegalStateException,
                       BufferOverflowException,
                       BufferUnderflowException

Description copied from interface: Byteable

This setter for a data type which points to an underlying ByteStore.

Specified by:

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

Parameters:

byteStore - the fix point ByteStore

offset - the offset within the ByteStore

length - the length in the ByteStore

Throws:

IllegalStateException

BufferOverflowException

BufferUnderflowException

offset

public long offset()

Specified by:

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

maxSize

public long maxSize()

Specified by:

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

Returns:

the maximum size in byte for this reference.

isElastic

public boolean isElastic()

Specified by:

isElastic in interface Bytes<Underlying>

Returns:

can the Bytes resize when more data is written than it's realCapacity()

bytesForRead

@NotNull
public Bytes<Underlying> bytesForRead()
                                        throws IllegalStateException

Description copied from interface: Bytes

Creates a slice of the current Bytes based on its position() and limit(). As a sub-section of a Bytes it cannot be elastic.

Specified by:

bytesForRead in interface Bytes<Underlying>

Specified by:

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

Returns:

a slice of the existing Bytes where the start is moved to the position and the current limit determines the capacity.

Throws:

IllegalStateException - if the underlying BytesStore has been released

isEqual

public boolean isEqual(@Nullable
                       String s)

Specified by:

isEqual in interface Bytes<Underlying>

realCapacity

public long realCapacity()

Specified by:

realCapacity in interface Bytes<Underlying>

Specified by:

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

Specified by:

realCapacity in interface RandomDataInput

Specified by:

realCapacity in interface StreamingDataOutput<Bytes<Underlying>>

Overrides:

realCapacity in class AbstractBytes<Underlying>

Returns:

if isElastic, this can be much lower than the virtual capacity().

copy

@NotNull
public BytesStore<Bytes<Underlying>,Underlying> copy()

Specified by:

copy in interface Bytes<Underlying>

Specified by:

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

Returns:

a copy of this Bytes from position() to limit().

write

@NotNull
public Bytes<Underlying> write(@NotNull
                                        RandomDataInput bytes,
                                        long offset,
                                        long length)
                                 throws BufferOverflowException,
                                        BufferUnderflowException,
                                        IllegalArgumentException

Description copied from interface: StreamingDataOutput

Write all data or fail.

Specified by:

write in interface StreamingDataOutput<Bytes<Underlying>>

Throws:

BufferOverflowException

BufferUnderflowException

IllegalArgumentException

optimisedWrite

protected void optimisedWrite(@NotNull
                              RandomDataInput bytes,
                              long offset,
                              long length)

write

public void write(long position,
                  @NotNull
                  CharSequence str,
                  int offset,
                  int length)
           throws BufferOverflowException,
                  IllegalArgumentException

Throws:

BufferOverflowException

IllegalArgumentException

append

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

Description copied from interface: ByteStringAppender

Append a portion of a String to the Bytes in UTF-8.

Specified by:

append in interface Appendable

Specified by:

append in interface ByteStringAppender<Bytes<Underlying>>

Parameters:

str - to copy

start - index of the first char inclusive

end - index of the last char exclusive.

Returns:

this

Throws:

IndexOutOfBoundsException

appendUtf8

@NotNull
public VanillaBytes appendUtf8(CharSequence str)
                                 throws BufferOverflowException

Specified by:

appendUtf8 in interface StreamingDataOutput<Bytes<Underlying>>

Throws:

BufferOverflowException

append8bit

@NotNull
public Bytes<Underlying> append8bit(@NotNull
                                             CharSequence cs)
                                      throws BufferOverflowException,
                                             BufferUnderflowException,
                                             IndexOutOfBoundsException

Description copied from interface: ByteStringAppender

Append a String to the Bytes in ISO-8859-1

Specified by:

append8bit in interface ByteStringAppender<Bytes<Underlying>>

Parameters:

cs - to write

Returns:

this

Throws:

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

BufferUnderflowException - if the capacity of the underlying buffer was exceeded

IndexOutOfBoundsException

append8bit

@NotNull
public Bytes<Underlying> append8bit(@NotNull
                                             String cs)
                                      throws BufferOverflowException,
                                             BufferUnderflowException,
                                             IndexOutOfBoundsException

Specified by:

append8bit in interface ByteStringAppender<Bytes<Underlying>>

Throws:

BufferOverflowException

BufferUnderflowException

IndexOutOfBoundsException

toString

@NotNull
public String toString()

Specified by:

toString in interface CharSequence

Overrides:

toString in class AbstractBytes<Underlying>

toString0

@NotNull
protected String toString0()

append8bit0

@NotNull
protected Bytes<Underlying> append8bit0(@NotNull
                                                 CharSequence cs)
                                          throws BufferOverflowException,
                                                 IndexOutOfBoundsException

Throws:

BufferOverflowException

IndexOutOfBoundsException

equalBytes

public boolean equalBytes(BytesStore bytesStore,
                          long length)
                   throws BufferUnderflowException

Description copied from interface: BytesStore

Check if a portion of a BytesStore matches this one.

Specified by:

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

Parameters:

bytesStore - to match against

length - to match.

Returns:

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

Throws:

BufferUnderflowException

read8Bit

public void read8Bit(char[] chars,
                     int length)

byteCheckSum

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

Overrides:

byteCheckSum in class AbstractBytes<Underlying>

Throws:

net.openhft.chronicle.core.io.IORuntimeException

appendUtf8

@NotNull
public Bytes<Underlying> appendUtf8(char[] chars,
                                             int offset,
                                             int length)
                                      throws BufferOverflowException,
                                             IllegalArgumentException

Specified by:

appendUtf8 in interface StreamingDataOutput<Bytes<Underlying>>

Throws:

BufferOverflowException

IllegalArgumentException

toTemporaryDirectByteBuffer

public ByteBuffer toTemporaryDirectByteBuffer()
                                       throws IllegalArgumentException

Specified by:

toTemporaryDirectByteBuffer in interface RandomDataInput

Throws:

IllegalArgumentException

read

public int read(@NotNull
                byte[] bytes)

Specified by:

read in interface StreamingDataInput<Bytes<Underlying>>

compareTo

public int compareTo(@NotNull
                     CharSequence cs)

Specified by:

compareTo in interface Comparable<CharSequence>

reader

@NotNull
public Reader reader()

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

Returns:

as a Reader

parseBoolean

@Nullable
public Boolean parseBoolean(@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 Boolean parseBoolean()

parseUtf8

@NotNull
public String parseUtf8(@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 String parseUTF(@NotNull
                                             StopCharTester stopCharTester)

Deprecated.

parseUtf8

public void parseUtf8(@NotNull
                      Appendable buffer,
                      @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
                                 Appendable buffer,
                                 @NotNull
                                 StopCharTester stopCharTester)
                          throws BufferUnderflowException

Deprecated.

Throws:

BufferUnderflowException

parseUtf8

public void parseUtf8(@NotNull
                      Appendable buffer,
                      @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
                                 Appendable buffer,
                                 @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
                      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
                        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
                      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
                      StopCharsTester stopCharsTester)
               throws BufferUnderflowException

Throws:

BufferUnderflowException

parse8bit

public void parse8bit(StringBuilder buffer,
                      @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
                      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 BigDecimal parseBigDecimal()