net.openhft.chronicle.bytes

Interface StopCharsTester

All Known Implementing Classes:

EscapingStopCharsTester

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface StopCharsTester

A functional interface that defines a strategy for identifying stop characters during a string parsing operation. This allows customization of how and where string parsing should terminate.

Method Summary

Modifier and Type	Method and Description
default @NotNull StopCharsTester	escaping() Creates a new that respects escape characters in the string parsing operation.
boolean	isStopChar(int ch, int peekNextCh) Determines whether the provided character should cause the string parsing operation to stop.

Method Detail

isStopChar

boolean isStopChar(int ch,
                   int peekNextCh)

Determines whether the provided character should cause the string parsing operation to stop. The logic for deciding this can be custom defined for different scenarios.

For safety reasons, it is advised that a byte of value 0 should either be defined as a stop character or should throw an IllegalStateException to prevent issues with null-terminated strings.

Parameters:

ch - the character to test. If this is 0, it should return true or throw an exception.

peekNextCh - the next character that would be parsed after 'ch'. It can be used for context aware stopping, like identifying escape sequences.

Returns:

true if the provided character is a stop character, false otherwise.

escaping

@NotNull
default @NotNull StopCharsTester escaping()

Creates a new that respects escape characters in the string parsing operation. This allows for more complex string parsing scenarios where certain stop characters may need to be ignored if they are escaped.

Returns:

A new that respects escape characters.