net.openhft.chronicle.bytes

Interface ByteStringParser<B extends ByteStringParser<B>>

Type Parameters:

B - self type for fluent chaining

All Superinterfaces:

RandomCommon, net.openhft.chronicle.core.io.ReferenceCounted, net.openhft.chronicle.core.io.ReferenceOwner, StreamingCommon<B>, StreamingDataInput<B>

All Known Subinterfaces:

Bytes<U>, BytesIn<U>

All Known Implementing Classes:

AbstractBytes, GuardedNativeBytes, HexDumpBytes, MappedBytes, NativeBytes, OnHeapBytes, SubBytes, UncheckedBytes, UncheckedNativeBytes, VanillaBytes

public interface ByteStringParser<B extends ByteStringParser<B>>
extends StreamingDataInput<B>

Extends StreamingDataInput with helpers for parsing textual data directly from a Bytes stream. Implementations consume data from the current read position and advance it as characters or numbers are parsed.

Field Summary

Fields inherited from interface net.openhft.chronicle.core.io.ReferenceOwner

INIT, TMP

Method Summary

Modifier and Type	Method and Description
int	lastDecimalPlaces() Returns the number of decimal places in the last parsed floating-point number (from the parseDouble() or parseLongDecimal() methods).
void	lastDecimalPlaces(int lastDecimalPlaces) Sets the number of decimal places in the last parsed number.
boolean	lastNumberHadDigits() Returns whether the last parsed number had any digits.
void	lastNumberHadDigits(boolean lastNumberHadDigits) Sets whether the last parsed number had any digits.
default void	parse8bit(Appendable buffer, @NotNull StopCharsTester stopCharsTester) Parses an ISO-8859-1 encoded string from the byte string until the provided stopCharsTester detects an end condition.
default void	parse8bit(Appendable buffer, @NotNull StopCharTester stopCharTester) Parses an ISO-8859-1 encoded string from the byte string until the provided stopCharTester detects an end condition.
default void	parse8bit(Bytes<?> buffer, @NotNull StopCharsTester stopCharsTester) Parses an ISO-8859-1 encoded string from the byte string until the provided stopCharsTester detects an end condition.
default String	parse8bit(@NotNull StopCharTester stopCharTester) Parses an ISO-8859-1 encoded string from the byte string until the provided stopCharTester detects an end condition.
default void	parse8bit(StringBuilder buffer, @NotNull StopCharsTester stopCharsTester) Parses an ISO-8859-1 encoded string from the byte string until the provided stopCharsTester detects an end condition.
default @NotNull BigDecimal	parseBigDecimal() Parses text from the byte string as a BigDecimal.
default @Nullable Boolean	parseBoolean() Convenience wrapper for parseBoolean(StopCharTester) using StopCharTesters.NON_ALPHA_DIGIT.
default @Nullable Boolean	parseBoolean(@NotNull StopCharTester tester) Parses a boolean token, stopping when tester returns true.
default double	parseDouble() Parses text from the byte string as a double-precision floating-point number.
default long	parseFlexibleLong() Parses a long integer from the byte string in either standard or scientific notation.
default float	parseFloat() Parses text from the byte string as a floating-point number.
default int	parseInt() Parses text from the byte string as an integer.
default long	parseLong() Parses text from the byte string as a long integer.
default long	parseLongDecimal() Parses the significant digits of a decimal number from the byte string.
default void	parseUtf8(@NotNull Appendable buffer, @NotNull StopCharsTester stopCharsTester) Parses a UTF-8 encoded string from the byte string until the provided stopCharsTester detects an end condition.
default void	parseUtf8(@NotNull Appendable buffer, @NotNull StopCharTester stopCharTester) Parses a UTF-8 encoded string from the byte string until the provided stopCharTester detects an end condition.
default @NotNull String	parseUtf8(@NotNull StopCharTester stopCharTester) Parses a UTF-8 encoded string from the byte string until the provided stopCharTester detects an end condition.
default @NotNull Reader	reader() Creates a new Reader from the byte string, assuming the byte string is ISO-8859-1 encoded.
default boolean	skipTo(@NotNull StopCharTester tester) Advances the read position until tester.isStopChar() returns true or end of input is reached.

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

copyTo, copyTo, inputStream, lenient, lenient, parseHexLong, parseUtf8, parseUtf8, peekUnsignedByte, rawReadByte, rawReadInt, rawReadLong, read, read, read, read, read, read, read8bit, read8bit, read8bit, readBigDecimal, readBigInteger, readBoolean, readByte, readChar, readDouble, readEnum, readFloat, readHistogram, readIncompleteLong, readInt, readInt24, readLimit, readLimitToCapacity, readLong, readPosition, readPositionForHeader, readPositionRemaining, readPositionUnlimited, readShort, readSkip, readStopBit, readStopBitChar, readStopBitDecimal, readStopBitDouble, readUnsignedByte, readUnsignedInt, readUnsignedInt24, readUnsignedShort, readUtf8, readUtf8, readUtf8, readUtf8, readVolatileInt, readVolatileLong, readWithLength, readWithLength, readWithLength0, uncheckedReadSkipBackOne, uncheckedReadSkipOne, uncheckedReadUnsignedByte, unsafeRead, unsafeReadObject

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

clear

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

addressForRead, addressForRead, addressForWrite, addressForWritePosition, byteOrder, bytesForRead, bytesForWrite, capacity, isDirectMemory, lengthWritten, readLimit, readPosition, readRemaining, realCapacity, realReadRemaining, realWriteRemaining, sharedMemory, start, writeLimit, writePosition, writeRemaining

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

addReferenceChangeListener, refCount, release, releaseLast, releaseLast, removeReferenceChangeListener, reserve, reserveTransfer, tryReserve

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

referenceId, referenceName, temporary

Method Detail

reader

@NotNull
default @NotNull Reader reader()

Creates a new Reader from the byte string, assuming the byte string is ISO-8859-1 encoded.

Returns:

a new Reader instance that can be used to read the bytes as characters.

parseBoolean

@Nullable
default @Nullable Boolean parseBoolean(@NotNull
                                                 @NotNull StopCharTester tester)
                                          throws BufferUnderflowException,
                                                 ArithmeticException,
                                                 net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                 net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses a boolean token, stopping when tester returns true. The recognised tokens are case-insensitive variants of true/t/yes/y/1 and false/f/no/n/0.

Parameters:

tester - stop condition for the parse

Returns:

parsed value or null if no recognised token was found

Throws:

BufferUnderflowException

ArithmeticException

net.openhft.chronicle.core.io.ClosedIllegalStateException

net.openhft.chronicle.core.io.ThreadingIllegalStateException

parseBoolean

@Nullable
default @Nullable Boolean parseBoolean()
                                          throws BufferUnderflowException,
                                                 ArithmeticException,
                                                 net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                 net.openhft.chronicle.core.io.ThreadingIllegalStateException

Convenience wrapper for parseBoolean(StopCharTester) using StopCharTesters.NON_ALPHA_DIGIT.

Throws:

BufferUnderflowException

ArithmeticException

net.openhft.chronicle.core.io.ClosedIllegalStateException

net.openhft.chronicle.core.io.ThreadingIllegalStateException

parseUtf8

@NotNull
default @NotNull String parseUtf8(@NotNull
                                           @NotNull StopCharTester stopCharTester)
                                    throws ArithmeticException,
                                           net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                           net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses a UTF-8 encoded string from the byte string until the provided stopCharTester detects an end condition.

Parameters:

stopCharTester - a StopCharTester used to detect the end of the string.

Returns:

the parsed text as a String.

Throws:

ArithmeticException - If a numeric overflow occurs.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.

parseUtf8

default void parseUtf8(@NotNull
                       @NotNull Appendable buffer,
                       @NotNull
                       @NotNull StopCharTester stopCharTester)
                throws BufferUnderflowException,
                       ArithmeticException,
                       net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses a UTF-8 encoded string from the byte string until the provided stopCharTester detects an end condition. The parsed string is appended to the provided buffer.

Parameters:

buffer - the Appendable to append the parsed string to.

stopCharTester - a StopCharTester used to detect the end of the string.

Throws:

BufferUnderflowException - If there is insufficient data.

ArithmeticException - If a numeric overflow occurs.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.

parseUtf8

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

Parses a UTF-8 encoded string from the byte string until the provided stopCharsTester detects an end condition. The parsed string is appended to the provided buffer.

Parameters:

buffer - the Appendable to append the parsed string to.

stopCharsTester - a StopCharsTester used to detect the end of the string.

Throws:

BufferUnderflowException - If there is insufficient data.

net.openhft.chronicle.core.io.IORuntimeException - If an I/O error occurs.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.

parse8bit

default void parse8bit(Appendable buffer,
                       @NotNull
                       @NotNull StopCharTester stopCharTester)
                throws BufferUnderflowException,
                       BufferOverflowException,
                       ArithmeticException,
                       net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses an ISO-8859-1 encoded string from the byte string until the provided stopCharTester detects an end condition. The parsed string is appended to the provided buffer.

Parameters:

buffer - the Appendable to append the parsed string to.

stopCharTester - a StopCharTester used to detect the end of the string.

Throws:

BufferUnderflowException - If there is insufficient data.

BufferOverflowException - If the buffer's capacity was exceeded.

ArithmeticException - If a numeric overflow occurs.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.

parse8bit

default String parse8bit(@NotNull
                         @NotNull StopCharTester stopCharTester)
                  throws BufferUnderflowException,
                         net.openhft.chronicle.core.io.ClosedIllegalStateException,
                         net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses an ISO-8859-1 encoded string from the byte string until the provided stopCharTester detects an end condition.

Parameters:

stopCharTester - a StopCharTester used to detect the end of the string.

Returns:

the parsed text as a String.

Throws:

BufferUnderflowException - If there is insufficient data.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.

parse8bit

default void parse8bit(Appendable buffer,
                       @NotNull
                       @NotNull StopCharsTester stopCharsTester)
                throws BufferUnderflowException,
                       BufferOverflowException,
                       ArithmeticException,
                       net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses an ISO-8859-1 encoded string from the byte string until the provided stopCharsTester detects an end condition. The parsed string is appended to the provided buffer.

Parameters:

buffer - the Appendable to append the parsed string to.

stopCharsTester - a StopCharsTester used to detect the end of the string.

Throws:

BufferUnderflowException - If there is insufficient data.

BufferOverflowException - If the buffer's capacity was exceeded.

ArithmeticException - If a numeric overflow occurs.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.

parse8bit

default void parse8bit(Bytes<?> buffer,
                       @NotNull
                       @NotNull StopCharsTester stopCharsTester)
                throws BufferUnderflowException,
                       BufferOverflowException,
                       ArithmeticException,
                       net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses an ISO-8859-1 encoded string from the byte string until the provided stopCharsTester detects an end condition. The parsed string is appended to the provided buffer.

Parameters:

buffer - the Bytes object to append the parsed string to.

stopCharsTester - a StopCharsTester used to detect the end of the string.

Throws:

BufferUnderflowException - If there is insufficient data.

BufferOverflowException - If the buffer's capacity was exceeded.

ArithmeticException - If a numeric overflow occurs.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.

parse8bit

default void parse8bit(StringBuilder buffer,
                       @NotNull
                       @NotNull StopCharsTester stopCharsTester)
                throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses an ISO-8859-1 encoded string from the byte string until the provided stopCharsTester detects an end condition. The parsed string is appended to the provided buffer.

Parameters:

buffer - the StringBuilder to append the parsed string to.

stopCharsTester - a StopCharsTester used to detect the end of the string.

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.

parseInt

default int parseInt()
              throws BufferUnderflowException,
                     ArithmeticException,
                     net.openhft.chronicle.core.io.ClosedIllegalStateException,
                     net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses text from the byte string as an integer. The terminating character is consumed.

Returns:

the parsed integer.

Throws:

BufferUnderflowException - If there is insufficient data.

ArithmeticException - If a numeric overflow occurs.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.

parseLong

default long parseLong()
                throws BufferUnderflowException,
                       net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses text from the byte string as a long integer. The terminating character is consumed.

Returns:

the parsed long.

Throws:

BufferUnderflowException - If there is insufficient data.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.

parseFlexibleLong

default long parseFlexibleLong()
                        throws BufferUnderflowException,
                               net.openhft.chronicle.core.io.IORuntimeException,
                               net.openhft.chronicle.core.io.ClosedIllegalStateException,
                               net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses a long integer from the byte string in either standard or scientific notation. If the parsed value corresponds to a valid long, it returns the value without any precision errors (unlike casting the result of parseDouble() to long).

Returns:

the parsed long.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - If the parsed value corresponds to a fractional number or to a number outside the long's range.

BufferUnderflowException - If there is insufficient data.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.

parseFloat

default float parseFloat()
                  throws BufferUnderflowException,
                         net.openhft.chronicle.core.io.ClosedIllegalStateException,
                         net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses text from the byte string as a floating-point number. The terminating character is consumed. The number of decimal places can be retrieved with lastDecimalPlaces().

Returns:

the parsed float, or -0.0 if there were no digits.

Throws:

BufferUnderflowException - If there is insufficient data.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.

parseDouble

default double parseDouble()
                    throws BufferUnderflowException,
                           net.openhft.chronicle.core.io.ClosedIllegalStateException,
                           net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses text from the byte string as a double-precision floating-point number. The terminating character is consumed. The number of decimal places can be retrieved with lastDecimalPlaces().

Returns:

the parsed double, or -0.0 if there were no digits.

Throws:

BufferUnderflowException - If there is insufficient data.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.

parseLongDecimal

default long parseLongDecimal()
                       throws BufferUnderflowException,
                              net.openhft.chronicle.core.io.ClosedIllegalStateException,
                              net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses the significant digits of a decimal number from the byte string. The number of decimal places can be retrieved with lastDecimalPlaces().

Returns:

the significant digits as a long.

Throws:

BufferUnderflowException - If there is insufficient data.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.

lastDecimalPlaces

int lastDecimalPlaces()

Returns the number of decimal places in the last parsed floating-point number (from the parseDouble() or parseLongDecimal() methods).

Returns:

the number of decimal places in the last parsed number.

lastDecimalPlaces

void lastDecimalPlaces(int lastDecimalPlaces)

Sets the number of decimal places in the last parsed number. If the given value is positive, it is directly set; otherwise, the decimal place count is set to 0.

Parameters:

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

lastNumberHadDigits

boolean lastNumberHadDigits()

Returns whether the last parsed number had any digits.

Returns:

true if the last parsed number had digits, false otherwise.

lastNumberHadDigits

void lastNumberHadDigits(boolean lastNumberHadDigits)

Sets whether the last parsed number had any digits.

Parameters:

lastNumberHadDigits - the new value to set, true if the last parsed number had digits, false otherwise.

skipTo

default boolean skipTo(@NotNull
                       @NotNull StopCharTester tester)
                throws net.openhft.chronicle.core.io.ClosedIllegalStateException,
                       net.openhft.chronicle.core.io.ThreadingIllegalStateException

Advances the read position until tester.isStopChar() returns true or end of input is reached. The terminating character itself remains unread.

Throws:

net.openhft.chronicle.core.io.ClosedIllegalStateException

net.openhft.chronicle.core.io.ThreadingIllegalStateException

parseBigDecimal

@NotNull
default @NotNull BigDecimal parseBigDecimal()
                                              throws ArithmeticException,
                                                     net.openhft.chronicle.core.io.ClosedIllegalStateException,
                                                     net.openhft.chronicle.core.io.ThreadingIllegalStateException

Parses text from the byte string as a BigDecimal.

Returns:

the parsed BigDecimal.

Throws:

ArithmeticException - If a numerical overflow occurs during the operation.

net.openhft.chronicle.core.io.ClosedIllegalStateException - If the resource has been released or closed.

net.openhft.chronicle.core.io.ThreadingIllegalStateException - If this resource was accessed by multiple threads in an unsafe way.