net.openhft.lang.io

Interface ByteStringParser

All Superinterfaces:

BytesCommon

All Known Subinterfaces:

Bytes, IByteBufferBytes

All Known Implementing Classes:

AbstractBytes, BoundsCheckingDirectBytes, BoundsCheckingNativeBytes, ByteBufferBytes, CheckedBytes, DirectByteBufferBytes, DirectBytes, MappedNativeBytes, MultiStoreBytes, NativeBytes, VanillaMappedBytes, WrappedBytes

public interface ByteStringParser
extends BytesCommon

Author:

peter.lawrey

Method Summary

Modifier and Type	Method and Description
CharSequence	asString() Dump the contents of Bytes as a CharSequence
void	asString(Appendable appendable) Dump the contents of this Bytes as text in the Appendable.
Boolean	parseBoolean(StopCharTester tester) Return true or false, or null if it could not be detected as true or false.
MutableDecimal	parseDecimal(MutableDecimal decimal)
double	parseDouble()
<E extends Enum<E>> E	parseEnum(Class<E> eClass, StopCharTester tester)
long	parseLong()
long	parseLong(int base)
String	parseUtf8(StopCharTester tester)
void	parseUtf8(StringBuilder builder, StopCharTester tester) Populate a StringBuilder with the UTF encoded text until the end.
int	readUnsignedByteOrThrow()
boolean	selfTerminating()
void	selfTerminating(boolean selfTerminate) If set to true, the end of the Bytes will be the end of any consuming String, double or long.
boolean	skipTo(StopCharTester tester) Wind from this positionAddr to the end of the field
boolean	stepBackAndSkipTo(StopCharTester tester) Make sure we just read a stop character

Methods inherited from interface net.openhft.lang.io.BytesCommon

alignPositionAddr, byteOrder, capacity, checkEndOfBuffer, clear, finish, flip, inputStream, isFinished, limit, limit, load, objectSerializer, outputStream, position, position, remaining, slice, slice, sliceAsByteBuffer, toDebugString, toDebugString, toHexString, toString

Method Detail

selfTerminating

void selfTerminating(boolean selfTerminate)

If set to true, the end of the Bytes will be the end of any consuming String, double or long. If false, incomplete reads will throw a BufferUnderflowException

Parameters:

selfTerminate - if true, the end of the Buffer is silent.

selfTerminating

boolean selfTerminating()

Returns:

if this Bytes self terminates.

readUnsignedByteOrThrow

int readUnsignedByteOrThrow()
                     throws BufferUnderflowException

Returns:

the next unsigned byte or -1 if selfTerminating and the end is reached.

Throws:

BufferUnderflowException - if the end is reached and selfTerminating is false.

parseBoolean

Boolean parseBoolean(@NotNull
                     StopCharTester tester)
              throws BufferUnderflowException

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

parseUtf8

void parseUtf8(@NotNull
               StringBuilder builder,
               @NotNull
               StopCharTester tester)
        throws BufferUnderflowException

Populate a StringBuilder with the UTF encoded text until the end.

Parameters:

builder - to zeroOut and append to.

tester - to detect when to stop.

Throws:

BufferUnderflowException

parseUtf8

@NotNull
String parseUtf8(@NotNull
                          StopCharTester tester)
                   throws BufferUnderflowException

Throws:

BufferUnderflowException

parseEnum

@Nullable
<E extends Enum<E>> E parseEnum(@NotNull
                                          Class<E> eClass,
                                          @NotNull
                                          StopCharTester tester)
                                   throws BufferUnderflowException

Throws:

BufferUnderflowException

parseDecimal

@NotNull
MutableDecimal parseDecimal(@NotNull
                                     MutableDecimal decimal)
                              throws BufferUnderflowException

Throws:

BufferUnderflowException

parseLong

long parseLong()
        throws BufferUnderflowException

Returns:

the next long, stopping at the first invalid character

Throws:

BufferUnderflowException

parseLong

long parseLong(int base)
        throws BufferUnderflowException

Parameters:

base - to use.

Returns:

the next long, stopping at the first invalid character

Throws:

BufferUnderflowException

parseDouble

double parseDouble()
            throws BufferUnderflowException

Throws:

BufferUnderflowException

stepBackAndSkipTo

boolean stepBackAndSkipTo(@NotNull
                          StopCharTester tester)

Make sure we just read a stop character

Parameters:

tester - to stop at

Returns:

true if we stopped at a stop character, false if we ran out of data.

skipTo

boolean skipTo(@NotNull
               StopCharTester tester)

Wind from this positionAddr to the end of the field

Parameters:

tester - to stop at

Returns:

true if we stopped at a stop character, false if we ran out of data.

asString

void asString(Appendable appendable)

Dump the contents of this Bytes as text in the Appendable.

Parameters:

appendable - to append to

asString

CharSequence asString()

Dump the contents of Bytes as a CharSequence

Returns:

the CharSequence for these Bytes.