net.openhft.chronicle.wire

Interface WireParser

All Superinterfaces:

Consumer<WireIn>

All Known Implementing Classes:

VanillaWireParser

public interface WireParser
extends Consumer<WireIn>

Defines the interface for parsing arbitrary field-value data from wire input.

Field Summary

Fields

Modifier and Type	Field and Description
static FieldNumberParselet	SKIP_READABLE_BYTES A predefined parselet that skips all readable bytes in the wire.

Method Summary

Modifier and Type	Method and Description
default void	accept(@NotNull WireIn wireIn) Default implementation for the Consumer's accept method.
WireParselet	getDefaultConsumer() Retrieves the default consumer of this parser.
WireParselet	lookup(CharSequence name) Searches for a WireParselet associated with a given name.
void	parseOne(@NotNull WireIn wireIn) Parses a single field-value data from the provided wire input.
@NotNull VanillaWireParser	register(String keyName, WireParselet valueInConsumer) Registers a new WireParselet for a given key name.
default @NotNull VanillaWireParser	register(WireKey key, WireParselet valueInConsumer) Registers a new WireParselet for a given key.
default @NotNull VanillaWireParser	registerOnce(WireKey key, WireParselet valueInConsumer) Attempts to register a new WireParselet for a given key.
static void	skipReadable(long ignoreMethodId, WireIn wire) Skips all readable bytes in the wire.
static @NotNull WireParser	wireParser(WireParselet defaultConsumer) Creates a new WireParser with a default consumer.
static @NotNull WireParser	wireParser(@NotNull WireParselet defaultConsumer, @NotNull FieldNumberParselet fieldNumberParselet) Creates a new WireParser with a default consumer and a custom field number parselet.

Methods inherited from interface java.util.function.Consumer

andThen

Field Detail

SKIP_READABLE_BYTES

static final FieldNumberParselet SKIP_READABLE_BYTES

A predefined parselet that skips all readable bytes in the wire.

Method Detail

wireParser

@NotNull
static @NotNull WireParser wireParser(WireParselet defaultConsumer)

Creates a new WireParser with a default consumer.

Parameters:

defaultConsumer - The default consumer that handles the wire data when no specific handler is provided.

Returns:

A new WireParser instance.

wireParser

@NotNull
static @NotNull WireParser wireParser(@NotNull
                                               @NotNull WireParselet defaultConsumer,
                                               @NotNull
                                               @NotNull FieldNumberParselet fieldNumberParselet)

Creates a new WireParser with a default consumer and a custom field number parselet.

Parameters:

defaultConsumer - The default consumer to handle the wire data when no specific handler is provided.

fieldNumberParselet - Custom field number parselet to handle field numbers in the wire data.

Returns:

A new WireParser instance.

skipReadable

static void skipReadable(long ignoreMethodId,
                         WireIn wire)

Skips all readable bytes in the wire.

Parameters:

ignoreMethodId - The method ID to ignore. (Currently unused in the method's logic)

wire - The wire input source.

getDefaultConsumer

WireParselet getDefaultConsumer()

Retrieves the default consumer of this parser.

Returns:

The default consumer.

parseOne

void parseOne(@NotNull
              @NotNull WireIn wireIn)
       throws net.openhft.chronicle.core.util.InvocationTargetRuntimeException,
              net.openhft.chronicle.core.io.InvalidMarshallableException

Parses a single field-value data from the provided wire input.

Parameters:

wireIn - The wire input source.

Throws:

net.openhft.chronicle.core.util.InvocationTargetRuntimeException - When there's a failure invoking the target action for a field.

net.openhft.chronicle.core.io.InvalidMarshallableException - When the wire data cannot be marshaled into the desired format.

accept

default void accept(@NotNull
                    @NotNull WireIn wireIn)

Default implementation for the Consumer's accept method. This method reads and processes data from the wire input, invoking the appropriate parselets for handling the data.

Specified by:

accept in interface Consumer<WireIn>

Parameters:

wireIn - The wire input source.

lookup

WireParselet lookup(CharSequence name)

Searches for a WireParselet associated with a given name.

Parameters:

name - The name to search the associated WireParselet for.

Returns:

The found WireParselet, or null if not found.

registerOnce

@NotNull
default @NotNull VanillaWireParser registerOnce(WireKey key,
                                                         WireParselet valueInConsumer)

Attempts to register a new WireParselet for a given key. If a parselet is already registered with the same key, a warning is emitted and the new registration is ignored.

Parameters:

key - The key to associate the parselet with.

valueInConsumer - The parselet to register.

Returns:

This instance for method chaining.

register

@NotNull
default @NotNull VanillaWireParser register(WireKey key,
                                                     WireParselet valueInConsumer)

Registers a new WireParselet for a given key.

Parameters:

key - The key to associate the parselet with.

valueInConsumer - The parselet to register.

Returns:

This instance for method chaining.

register

@NotNull
@NotNull VanillaWireParser register(String keyName,
                                             WireParselet valueInConsumer)

Registers a new WireParselet for a given key name.

Parameters:

keyName - The name of the key to associate the parselet with.

valueInConsumer - The parselet to register.

Returns:

This instance for method chaining.