net.openhft.chronicle.bytes

Interface ByteStringParser<B extends ByteStringParser<B>>

All Superinterfaces:

StreamingCommon<B>, StreamingDataInput<B>

All Known Subinterfaces:

Bytes<U>, BytesIn<U>

All Known Implementing Classes:

AbstractBytes, ChunkedMappedBytes, CommonMappedBytes, EmbeddedBytes, GuardedNativeBytes, HexDumpBytes, MappedBytes, NativeBytes, OnHeapBytes, SingleMappedBytes, SubBytes, UncheckedBytes, UncheckedNativeBytes, VanillaBytes

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

Supports parsing bytes as text. You can parse them as special or white space terminated text.

Field Summary

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

INIT, TMP

Method Summary

Modifier and Type	Method and Description
long	addressForRead(long offset) Obtain the underlying addressForRead.
default long	addressForRead(long offset, int buffer)
long	addressForWrite(long offset) Obtain the underlying addressForRead.
long	addressForWritePosition()
default ByteOrder	byteOrder()
@NotNull Bytes<?>	bytesForRead()
@NotNull Bytes<?>	bytesForWrite()
default long	capacity()
boolean	isDirectMemory()
int	lastDecimalPlaces()
void	lastDecimalPlaces(int lastDecimalPlaces) Store the last number of decimal places.
boolean	lastNumberHadDigits()
void	lastNumberHadDigits(boolean lastNumberHadDigits)
default long	lengthWritten(long startPosition) Typically this calculates the difference however for HexDumpBytes it's not as simple.
default void	parse8bit(Appendable buffer, @NotNull StopCharsTester stopCharsTester) parse text with ISO-8859-1 decoding as character terminated.
default void	parse8bit(Appendable buffer, @NotNull StopCharTester stopCharTester) parse text with ISO-8859-1 decoding as character terminated.
default void	parse8bit(Bytes<?> buffer, @NotNull StopCharsTester stopCharsTester)
default String	parse8bit(@NotNull StopCharTester stopCharTester) parse text with ISO-8859-1 decoding as character terminated.
default void	parse8bit(StringBuilder buffer, @NotNull StopCharsTester stopCharsTester)
default @NotNull BigDecimal	parseBigDecimal()
default @Nullable Boolean	parseBoolean()
default @Nullable Boolean	parseBoolean(@NotNull 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	parseFlexibleLong() Parses a long in regular or scientific format.
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	parseUtf8(@NotNull Appendable buffer, @NotNull StopCharsTester stopCharsTester) parse text with UTF-8 decoding as one or two character terminated.
default void	parseUtf8(@NotNull Appendable buffer, @NotNull StopCharTester stopCharTester) parse text with UTF-8 decoding as character terminated.
default @NotNull String	parseUtf8(@NotNull StopCharTester stopCharTester) parse text with UTF-8 decoding as character terminated.
default @NotNull Reader	reader() Access these bytes as an ISO-8859-1 encoded Reader
default long	readLimit() If the resource is closed, the returned value is unspecified.
default long	readPosition() Returns the read position.
default long	readRemaining() Returns the remaining bytes that can be read.
default long	realCapacity()
default long	realReadRemaining() If the resource is closed, the returned value is unspecified.
default long	realWriteRemaining() If the resource is closed, the returned value is unspecified.
boolean	sharedMemory()
default boolean	skipTo(@NotNull StopCharTester tester) Skip text until a terminating character is reached.
default long	start()
default long	writeLimit() Returns the write limit.
default long	writePosition() Returns the write position.
default long	writeRemaining() If the resource is closed, the returned value is unspecified.

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, unsafeReadObject

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

clear

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

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

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

referenceId, referenceName, temporary

Method Detail

reader

@NotNull
default @NotNull Reader reader()

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

Returns:

as a Reader

parseBoolean

@Nullable
default @Nullable Boolean parseBoolean(@NotNull
                                                 @NotNull StopCharTester tester)
                                          throws BufferUnderflowException,
                                                 IllegalStateException,
                                                 ArithmeticException

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.

Throws:

BufferUnderflowException

IllegalStateException

ArithmeticException

parseBoolean

@Nullable
default @Nullable Boolean parseBoolean()
                                          throws BufferUnderflowException,
                                                 IllegalStateException,
                                                 ArithmeticException

Throws:

BufferUnderflowException

IllegalStateException

ArithmeticException

parseUtf8

@NotNull
default @NotNull String parseUtf8(@NotNull
                                           @NotNull StopCharTester stopCharTester)
                                    throws IllegalStateException,
                                           ArithmeticException

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.

Throws:

IllegalStateException

ArithmeticException

parseUtf8

default void parseUtf8(@NotNull
                       @NotNull Appendable buffer,
                       @NotNull
                       @NotNull StopCharTester stopCharTester)
                throws BufferUnderflowException,
                       IllegalStateException,
                       ArithmeticException

parse text with UTF-8 decoding as character terminated.

Parameters:

buffer - to populate

stopCharTester - to check if the end has been reached.

Throws:

BufferUnderflowException

IllegalStateException

ArithmeticException

parseUtf8

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

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

IllegalStateException

parse8bit

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

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

IllegalStateException

ArithmeticException

parse8bit

default String parse8bit(@NotNull
                         @NotNull StopCharTester stopCharTester)
                  throws BufferUnderflowException,
                         IllegalStateException

parse text with ISO-8859-1 decoding as character terminated.

Parameters:

stopCharTester - to check if the end has been reached.

Throws:

BufferUnderflowException

IllegalStateException

parse8bit

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

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

IllegalStateException

ArithmeticException

parse8bit

default void parse8bit(Bytes<?> buffer,
                       @NotNull
                       @NotNull StopCharsTester stopCharsTester)
                throws BufferUnderflowException,
                       BufferOverflowException,
                       IllegalStateException,
                       ArithmeticException

Throws:

BufferUnderflowException

BufferOverflowException

IllegalStateException

ArithmeticException

parse8bit

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

Throws:

IllegalStateException

parseInt

default int parseInt()
              throws BufferUnderflowException,
                     ArithmeticException,
                     IllegalStateException

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

Returns:

an int.

Throws:

BufferUnderflowException

ArithmeticException

IllegalStateException

parseLong

default long parseLong()
                throws BufferUnderflowException,
                       IllegalStateException

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

Returns:

a long.

Throws:

BufferUnderflowException

IllegalStateException

parseFlexibleLong

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

Parses a long in regular or scientific format. In case text corresponds to a valid long value, returns it without precision errors (unlike result of parseDouble() casted to long).

Returns:

a long.

Throws:

net.openhft.chronicle.core.io.IORuntimeException - if text parses to a fractional number or to a number outside of the long's range.

BufferUnderflowException

IllegalStateException

parseFloat

default float parseFloat()
                  throws BufferUnderflowException,
                         IllegalStateException

parse text as a float decimal. The terminating character is consumed.

The number of decimal places can be retrieved with lastDecimalPlaces()

Returns:

a float or -0.0 if there were no digits present

Throws:

BufferUnderflowException

IllegalStateException

parseDouble

default double parseDouble()
                    throws BufferUnderflowException,
                           IllegalStateException

parse text as a double decimal. The terminating character is consumed.

The number of decimal places can be retrieved with lastDecimalPlaces()

Returns:

a double or -0.0 if there were no digits present

Throws:

BufferUnderflowException

IllegalStateException

parseLongDecimal

default long parseLongDecimal()
                       throws BufferUnderflowException,
                              IllegalStateException

Parse the significant digits of a decimal number.

The number of decimal places can be retrieved with lastDecimalPlaces()

Returns:

the significant digits

Throws:

BufferUnderflowException

IllegalStateException

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.

lastNumberHadDigits

boolean lastNumberHadDigits()

Returns:

the last number had digits

lastNumberHadDigits

void lastNumberHadDigits(boolean lastNumberHadDigits)

Parameters:

lastNumberHadDigits - set the last number had digits

skipTo

default boolean skipTo(@NotNull
                       @NotNull StopCharTester tester)
                throws IllegalStateException

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:

IllegalStateException

parseBigDecimal

@NotNull
default @NotNull BigDecimal parseBigDecimal()
                                              throws IllegalStateException,
                                                     ArithmeticException

Throws:

IllegalStateException

ArithmeticException

start

default long start()

Returns:

The smallest position allowed in this buffer.

capacity

default long capacity()

Returns:

the highest limit allowed for this buffer.

realCapacity

default long realCapacity()

Returns:

the limit for this buffer without resizing

readPosition

default long readPosition()

Returns the read position.

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

If the resource is closed, the returned value is unspecified.

Returns:

position to read from.

writePosition

default long writePosition()

Returns the write position.

The write position is readPosition() <= writePosition() && writePosition() <= writeLimit()

If the resource is closed, the returned value is unspecified.

Returns:

position to write to.

lengthWritten

default long lengthWritten(long startPosition)

Typically this calculates the difference however for HexDumpBytes it's not as simple.

If the resource is closed, the returned value is unspecified.

Parameters:

startPosition - to compare against

Returns:

the length from the startPosition

readRemaining

default long readRemaining()

Returns the remaining bytes that can be read.

If the resource is closed, the returned value is unspecified.

Returns:

How many more bytes can we read.

realReadRemaining

default long realReadRemaining()

If the resource is closed, the returned value is unspecified.

Returns:

how much can be safely read directly.

writeRemaining

default long writeRemaining()

If the resource is closed, the returned value is unspecified.

Returns:

How many more bytes can we written.

realWriteRemaining

default long realWriteRemaining()

If the resource is closed, the returned value is unspecified.

Returns:

writeRemaining with resize

readLimit

default long readLimit()

If the resource is closed, the returned value is unspecified.

Returns:

the highest offset or position allowed for this buffer.

writeLimit

default long writeLimit()

Returns the write limit.

If the resource is closed, the returned value is unspecified.

Returns:

the write limit

addressForRead

long addressForRead(long offset)
             throws UnsupportedOperationException,
                    BufferUnderflowException,
                    IllegalStateException

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

Parameters:

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

Returns:

the underlying addressForRead of the buffer

Throws:

UnsupportedOperationException - if the underlying buffer is on the heap

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

IllegalStateException

addressForRead

default long addressForRead(long offset,
                            int buffer)
                     throws UnsupportedOperationException,
                            BufferUnderflowException,
                            IllegalStateException

Throws:

UnsupportedOperationException

BufferUnderflowException

IllegalStateException

addressForWrite

long addressForWrite(long offset)
              throws UnsupportedOperationException,
                     BufferOverflowException,
                     IllegalStateException

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

Parameters:

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

Returns:

the underlying addressForRead of the buffer

Throws:

UnsupportedOperationException - if the underlying buffer is on the heap

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

IllegalStateException

addressForWritePosition

long addressForWritePosition()
                      throws UnsupportedOperationException,
                             BufferOverflowException,
                             IllegalStateException

Throws:

UnsupportedOperationException

BufferOverflowException

IllegalStateException

byteOrder

default ByteOrder byteOrder()

bytesForRead

@NotNull
@NotNull Bytes<?> bytesForRead()
                                 throws IllegalStateException

Returns:

the streaming bytes for reading.

Throws:

IllegalStateException

bytesForWrite

@NotNull
@NotNull Bytes<?> bytesForWrite()
                                  throws IllegalStateException

Returns:

the streaming bytes for writing.

Throws:

IllegalStateException

sharedMemory

boolean sharedMemory()

Returns:

true if these Bytes use shared memory.

isDirectMemory

boolean isDirectMemory()