org.apache.logging.log4j.message

Interface ParameterVisitable

All Known Implementing Classes:

MutableLogEvent, ReusableObjectMessage, ReusableParameterizedMessage, ReusableSimpleMessage, RingBufferLogEvent

public interface ParameterVisitable

Allows message parameters to be iterated over without any allocation or memory copies.

Since:

2.11

Method Summary

Modifier and Type	Method and Description
<S> void	forEachParameter(ParameterConsumer<S> action, S state) Performs the given action for each parameter until all values have been processed or the action throws an exception.

Method Detail

forEachParameter

<S> void forEachParameter(ParameterConsumer<S> action,
                          S state)

Performs the given action for each parameter until all values have been processed or the action throws an exception.

The second parameter lets callers pass in a stateful object to be modified with the key-value pairs, so the TriConsumer implementation itself can be stateless and potentially reusable.

Type Parameters:

S - type of the third parameter

Parameters:

action - The action to be performed for each key-value pair in this collection

state - the object to be passed as the third parameter to each invocation on the specified ParameterConsumer.

Since:

2.11