net.openhft.chronicle.bytes

Interface StopCharTester

All Known Implementing Classes:

EscapingStopCharTester, StopCharTesters

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 StopCharTester

A functional interface for defining a strategy to identify stop characters during string parsing. It allows customization of the end condition for the parsing operation.

Method Summary

Modifier and Type	Method and Description
default @NotNull StopCharTester	escaping() Returns a new instance that respects escape characters.
boolean	isStopChar(int ch) Tests if the provided character should be regarded as a stop character during a string parsing operation.

Method Detail

isStopChar

boolean isStopChar(int ch)

Tests if the provided character should be regarded as a stop character during a string parsing operation. The specific logic for this determination can be defined per use case.

Note: For safety reasons, a character of value 0 should either return true (i.e., be considered a stop character) or throw an IllegalStateException. This is to prevent issues with null-terminated strings.

Parameters:

ch - the character to be tested. If ch is 0, the method should return true or throw an exception.

Returns:

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

escaping

@NotNull
default @NotNull StopCharTester escaping()

Returns a new instance that respects escape characters. This allows for parsing scenarios where certain stop characters should be ignored if they are escaped.

Returns:

a new that takes escape characters into account.