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:

Closeable, Appendable, AutoCloseable, CharSequence, Byteable<Bytes<Underlying>,Underlying>, Bytes<Underlying>, BytesPrepender<Bytes<Underlying>>, BytesStore<Bytes<Underlying>,Underlying>, ByteStringAppender<Bytes<Underlying>>, RandomDataInput, RandomDataOutput<Bytes<Underlying>>, StreamingDataInput<Bytes<Underlying>>, StreamingDataOutput<Bytes<Underlying>>, net.openhft.chronicle.core.ReferenceCounted

Direct Known Subclasses:

NativeBytes

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

Simple Bytes implementation which is not Elastic.

Field Summary

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

bytesStore, readPosition, writeLimit, writePosition

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

MAX_CAPACITY

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

charToString

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.
VanillaBytes<Underlying>	appendUtf8(char[] chars, int offset, int length)
int	byteCheckSum() Return the bytes sum of the readable bytes.
default ByteOrder	byteOrder()
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.
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.
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()
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 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 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.
void	read8Bit(char[] chars, int length)
default Reader	reader() Access these bytes as an ISO-8859-1 encoded Reader
default long	readRemaining()
long	realCapacity()
default boolean	skipTo(StopCharTester tester) Skip text until a terminating character is reached.
ByteBuffer	toTemporaryDirectByteBuffer()
static VanillaBytes<Void>	vanillaBytes()
Bytes<Underlying>	write(BytesStore bytes, long offset, long length)
void	write(long position, CharSequence str, int offset, int length)
Bytes<Underlying>	write8bit(CharSequence str, int offset, int length)
default long	writeRemaining()

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

address, bytesStore, capacity, clear, clearAndPad, compareAndSwapInt, compareAndSwapLong, equals, equalsBytes, hashCode, lastDecimalPlaces, lastDecimalPlaces, nativeRead, nativeRead, nativeWrite, nativeWrite, peekUnsignedByte, 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, readVolatileInt, readVolatileLong, refCount, release, reserve, start, toString, underlyingObject, write, write, write, write, write, writeByte, writeByte, writeDouble, writeDouble, writeFloat, writeFloat, writeInt, writeInt, writeLimit, writeLimit, writeLong, writeLong, writeOffsetPositionMoved, writeOrderedInt, writeOrderedInt, writeOrderedLong, writeOrderedLong, writePosition, writePosition, writeShort, writeShort, writeSkip, 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, elasticByteBuffer, elasticByteBuffer, elasticByteBuffer, empty, ensureCapacity, expect, expect, from, fromHexString, isClear, safeLimit, toHexString, toHexString, toHexString, toString, toString, toString, unchecked, wrapForRead, wrapForRead, wrapForRead, wrapForWrite, wrapForWrite

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

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

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

addAndGetDouble, addAndGetFloat, addAndGetInt, addAndGetLong, compareUtf8, copyTo, copyTo, createCharToString, findByte, parseLong, printable, read, readBoolean, readIncompleteLong, readUnsignedByte, readUnsignedInt, readUnsignedShort, readUtf8, readUtf8Limited, readUtf8Limited, readVolatileByte, readVolatileDouble, readVolatileFloat, readVolatileInt, readVolatileLong, readVolatileShort, subBytes, toByteArray

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

append, write, write, writeBoolean, writeByte, 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.StreamingDataInput

inputStream, parseHexLong, parseUTF, parseUtf8, parseWithLength, read, read, read, read, read8bit, read8bit, read8bit, read8bit, readBoolean, readEnum, readStopBit, readStopBitDouble, readUnsignedInt, readUnsignedShort, readUtf8, readUtf8, readUTFΔ, readUTFΔ, readWithLength

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

append, append, append, append, append, append, append8bit, append8bit, appendDateMillis, appendDecimal, appendTimeMillis, writer

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

appendUtf8, appendUtf8, appendUtf8, copyFrom, outputStream, write, write, write, write, write8bit, write8bit, write8bit, writeBoolean, writeEnum, writeStopBit, writeStopBit, writeUnsignedByte, writeUnsignedInt, writeUnsignedShort, writeUtf8, writeUTFΔ

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

close, release, releaseAll, tryReserve

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

closeQuietly, notifyClosing

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

prepend

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.

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

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
                                        BytesStore bytes,
                                        long offset,
                                        long length)
                                 throws BufferOverflowException,
                                        BufferUnderflowException,
                                        IllegalArgumentException,
                                        net.openhft.chronicle.core.io.IORuntimeException

Specified by:

write in interface StreamingDataOutput<Bytes<Underlying>>

Throws:

BufferOverflowException

BufferUnderflowException

IllegalArgumentException

net.openhft.chronicle.core.io.IORuntimeException

write8bit

public Bytes<Underlying> write8bit(@NotNull
                                   CharSequence str,
                                   int offset,
                                   int length)
                            throws BufferOverflowException,
                                   IllegalArgumentException,
                                   IndexOutOfBoundsException,
                                   net.openhft.chronicle.core.io.IORuntimeException

Specified by:

write8bit in interface StreamingDataOutput<Bytes<Underlying>>

Throws:

BufferOverflowException

IllegalArgumentException

IndexOutOfBoundsException

net.openhft.chronicle.core.io.IORuntimeException

write

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

Throws:

BufferOverflowException

IllegalArgumentException

net.openhft.chronicle.core.io.IORuntimeException

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

equalBytes

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

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 and length matched.

Throws:

BufferUnderflowException

net.openhft.chronicle.core.io.IORuntimeException

read8Bit

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

byteCheckSum

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

Description copied from interface: BytesStore

Return the bytes sum of the readable bytes.

Specified by:

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

Returns:

unsigned byte sum.

Throws:

net.openhft.chronicle.core.io.IORuntimeException

appendUtf8

public VanillaBytes<Underlying> appendUtf8(char[] chars,
                                           int offset,
                                           int length)
                                    throws BufferOverflowException,
                                           IllegalArgumentException,
                                           net.openhft.chronicle.core.io.IORuntimeException

Specified by:

appendUtf8 in interface StreamingDataOutput<Bytes<Underlying>>

Throws:

BufferOverflowException

IllegalArgumentException

net.openhft.chronicle.core.io.IORuntimeException

toTemporaryDirectByteBuffer

public ByteBuffer toTemporaryDirectByteBuffer()

Specified by:

toTemporaryDirectByteBuffer in interface RandomDataInput

reader

public Reader reader()

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

Returns:

as a Reader

parseBoolean

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.

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

@Deprecated
public String parseUTF(@NotNull
                                   StopCharTester stopCharTester)

Deprecated.

parseUtf8

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

parse text with UTF-8 decoding as character terminated.

Parameters:

buffer - to populate

stopCharTester - to check if the end has been reached.

parseUTF

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

Deprecated.

parseUtf8

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

BufferOverflowException

net.openhft.chronicle.core.io.IORuntimeException

parseUTF

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

Deprecated.

Throws:

BufferUnderflowException

BufferOverflowException

net.openhft.chronicle.core.io.IORuntimeException

parse8bit

public void parse8bit(Appendable buffer,
                      @NotNull
                      StopCharTester stopCharTester)
               throws BufferUnderflowException,
                      BufferOverflowException,
                      net.openhft.chronicle.core.io.IORuntimeException

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

BufferOverflowException

net.openhft.chronicle.core.io.IORuntimeException

parse8bit

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

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

BufferOverflowException

net.openhft.chronicle.core.io.IORuntimeException

parseLong

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

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

Returns:

a long.

Throws:

BufferUnderflowException

net.openhft.chronicle.core.io.IORuntimeException

parseDouble

public double parseDouble()
                   throws BufferUnderflowException,
                          net.openhft.chronicle.core.io.IORuntimeException

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

net.openhft.chronicle.core.io.IORuntimeException

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)
               throws net.openhft.chronicle.core.io.IORuntimeException

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.

Throws:

net.openhft.chronicle.core.io.IORuntimeException

readRemaining

public long readRemaining()

Returns:

How many more bytes can we read.

writeRemaining

public long writeRemaining()

Returns:

How many more bytes can we written.

byteOrder

public ByteOrder byteOrder()

compareAndSwapFloat

public boolean compareAndSwapFloat(long offset,
                                   float expected,
                                   float value)
                            throws BufferOverflowException,
                                   IllegalArgumentException,
                                   net.openhft.chronicle.core.io.IORuntimeException

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

IllegalArgumentException

net.openhft.chronicle.core.io.IORuntimeException

compareAndSwapDouble

public boolean compareAndSwapDouble(long offset,
                                    double expected,
                                    double value)
                             throws BufferOverflowException,
                                    IllegalArgumentException,
                                    net.openhft.chronicle.core.io.IORuntimeException

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

IllegalArgumentException

net.openhft.chronicle.core.io.IORuntimeException