net.openhft.chronicle.bytes

Interface BytesIn<Underlying>

All Superinterfaces:

RandomDataInput, StreamingCommon<Bytes<Underlying>>, StreamingDataInput<Bytes<Underlying>>

All Known Subinterfaces:

Bytes<Underlying>

All Known Implementing Classes:

AbstractBytes, GuardedNativeBytes, HexDumpBytes, MappedBytes, NativeBytes, NativeBytes.NativeSubBytes, SubBytes, UncheckedBytes, UncheckedNativeBytes, VanillaBytes

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

Field Summary

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

charToString

Method Summary

Modifier and Type	Method and Description
default MethodReader	bytesMethodReader(Object... objects) Reads messages from this tails as methods.
default BytesMethodReaderBuilder	bytesMethodReaderBuilder()
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 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.
default Reader	reader() Access these bytes as an ISO-8859-1 encoded Reader
<T extends ReadBytesMarshallable> T	readMarshallableLength16(Class<T> tClass, T object)
default <T> T	readObject(Class<T> componentType)
default boolean	skipTo(StopCharTester tester) Skip text until a terminating character is reached.

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

addAndGetDouble, addAndGetFloat, addAndGetInt, addAndGetLong, canReadDirect, compareUtf8, copyTo, copyTo, createCharToString, fastHash, findByte, nativeRead, parseLong, peekUnsignedByte, peekVolatileInt, printable, read, readBoolean, readByte, readDouble, readFloat, readIncompleteLong, readInt, readLong, readShort, readUnsignedByte, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8Limited, readUtf8Limited, readVolatileByte, readVolatileDouble, readVolatileFloat, readVolatileInt, readVolatileLong, readVolatileShort, realCapacity, subBytes, toByteArray, toTemporaryDirectByteBuffer

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

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

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

clear

Method Detail

bytesMethodReader

@NotNull
default MethodReader bytesMethodReader(Object... objects)

Reads messages from this tails as methods. It returns a BooleanSupplier which returns

Parameters:

objects - which implement the methods serialized to the file.

Returns:

a reader which will read one Excerpt at a time

bytesMethodReaderBuilder

@NotNull
default BytesMethodReaderBuilder bytesMethodReaderBuilder()

readMarshallableLength16

<T extends ReadBytesMarshallable> T readMarshallableLength16(Class<T> tClass,
                                                             T object)

readObject

default <T> T readObject(Class<T> componentType)

reader

@NotNull
default Reader reader()

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

Returns:

as a Reader

parseBoolean

@Nullable
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.

parseBoolean

@Nullable
default Boolean parseBoolean()

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

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

Deprecated.

parseUtf8

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

Deprecated.

Throws:

BufferUnderflowException

parseUtf8

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

default 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

default 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

default 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

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

Throws:

BufferUnderflowException

parse8bit

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

Throws:

BufferUnderflowException

parseInt

default int parseInt()
              throws BufferUnderflowException

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

Returns:

an int.

Throws:

BufferUnderflowException

parseLong

default long parseLong()
                throws BufferUnderflowException

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

Returns:

a long.

Throws:

BufferUnderflowException

parseFloat

default 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

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.

parseBigDecimal

@NotNull
default BigDecimal parseBigDecimal()