net.openhft.chronicle.bytes

Interface BytesIn<Underlying>

All Superinterfaces:

StreamingDataInput<Bytes<Underlying>>

All Known Subinterfaces:

Bytes<Underlying>

All Known Implementing Classes:

AbstractBytes, CheckingMappedBytes, MappedBytes, NativeBytes, UncheckedBytes, UncheckedNativeBytes, VanillaBytes

public interface BytesIn<Underlying>
extends StreamingDataInput<Bytes<Underlying>>

Created by Peter on 20/04/2016.

Method Summary

Modifier and Type	Method and Description
long	address(long offset) Obtain the underlying address.
default ByteOrder	byteOrder()
Bytes	bytesForRead()
Bytes	bytesForWrite()
default long	capacity()
S	clear() Set the readPosition= writePosition = start, writeLimit = capacity
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.
boolean	compareAndSwapInt(long offset, int expected, int value) Perform a 32-bit CAS at a given offset.
boolean	compareAndSwapLong(long offset, long expected, long value) Perform a 64-bit CAS at a given offset.
boolean	isDirectMemory()
int	lastDecimalPlaces()
void	lastDecimalPlaces(int lastDecimalPlaces) Store the last number of decimal places.
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.
default Reader	reader() Access these bytes as an ISO-8859-1 encoded Reader
default long	readLimit()
default long	readPosition() The read position must be start() <= readPosition() && readPosition() <= readLimit() && readPosition < safeLimit()
default long	readRemaining()
boolean	sharedMemory()
default boolean	skipTo(StopCharTester tester) Skip text until a terminating character is reached.
default long	start()
default long	writeLimit()
default long	writePosition() The read position must be readPosition() <= writePosition() && writePosition() <= writeLimit()
default long	writeRemaining()

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

copyTo, copyTo, inputStream, nativeRead, parseHexLong, parseUTF, parseUtf8, peekUnsignedByte, read, read, read, read, read8bit, read8bit, read8bit, read8bit, readBoolean, readByte, readDouble, readEnum, readFloat, readInt, readLimit, readLong, readPosition, readPositionRemaining, readPositionUnlimited, readShort, readSkip, readStopBit, readStopBitDouble, readUnsignedByte, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8, readUTFΔ, readUTFΔ, readVolatileInt, readVolatileLong, readWithLength, uncheckedReadSkipBackOne, uncheckedReadSkipOne, uncheckedReadUnsignedByte

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

close, refCount, release, release, releaseAll, reserve, tryReserve

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

closeQuietly, isClosed, notifyClosing

Method Detail

reader

default Reader reader()

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

Returns:

as a Reader

parseBoolean

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

Deprecated.

parseUtf8

default 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
default void parseUTF(@NotNull
                                  Appendable buffer,
                                  @NotNull
                                  StopCharTester stopCharTester)

Deprecated.

parseUtf8

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

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

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

parse8bit

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

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

parseLong

default long parseLong()
                throws BufferUnderflowException

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

Returns:

a long.

Throws:

BufferUnderflowException

parseDouble

default 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

default 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

lastDecimalPlaces

int lastDecimalPlaces()

Returns:

the last number of decimal places for parseDouble or parseLongDecimal

lastDecimalPlaces

void lastDecimalPlaces(int lastDecimalPlaces)

Store the last number of decimal places. If

Parameters:

lastDecimalPlaces - set the number of decimal places if positive, otherwise 0.

skipTo

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

clear

@NotNull
S clear()

Set the readPosition= writePosition = start, writeLimit = capacity

Returns:

this

start

default long start()

Returns:

The smallest position allowed in this buffer.

capacity

default long capacity()

Returns:

the highest limit allowed for this buffer.

readPosition

default long readPosition()

The read position must be start() <= readPosition() && readPosition() <= readLimit() && readPosition < safeLimit()

Returns:

position to read from.

writePosition

default long writePosition()

The read position must be readPosition() <= writePosition() && writePosition() <= writeLimit()

Returns:

position to write to.

readRemaining

default long readRemaining()

Returns:

How many more bytes can we read.

writeRemaining

default long writeRemaining()

Returns:

How many more bytes can we written.

readLimit

default long readLimit()

Returns:

the highest offset or position allowed for this buffer.

writeLimit

default long writeLimit()

address

long address(long offset)
      throws UnsupportedOperationException,
             IllegalArgumentException

Obtain the underlying address. This is for expert users only.

Parameters:

offset - within this buffer. address(start()) is the actual address of the first byte.

Returns:

the underlying address of the buffer

Throws:

UnsupportedOperationException - if the underlying buffer is on the heap

IllegalArgumentException - if the offset is before the start() or the after the capacity()

byteOrder

default ByteOrder byteOrder()

bytesForRead

Bytes bytesForRead()
            throws IllegalStateException

Returns:

the streaming bytes for reading.

Throws:

IllegalStateException

bytesForWrite

Bytes bytesForWrite()
             throws IllegalStateException

Returns:

the streaming bytes for writing.

Throws:

IllegalStateException

compareAndSwapInt

boolean compareAndSwapInt(long offset,
                          int expected,
                          int value)
                   throws BufferOverflowException,
                          IllegalArgumentException

Perform a 32-bit CAS at a given offset.

Parameters:

offset - to perform CAS

expected - value

value - to set

Returns:

true, if successful.

Throws:

BufferOverflowException

IllegalArgumentException

compareAndSwapLong

boolean compareAndSwapLong(long offset,
                           long expected,
                           long value)
                    throws BufferOverflowException,
                           IllegalArgumentException

Perform a 64-bit CAS at a given offset.

Parameters:

offset - to perform CAS

expected - value

value - to set

Returns:

true, if successful.

Throws:

BufferOverflowException

IllegalArgumentException

compareAndSwapFloat

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

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

compareAndSwapDouble

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

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

sharedMemory

boolean sharedMemory()

Returns:

true if these Bytes use shared memory.

isDirectMemory

boolean isDirectMemory()