1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one or more
3 * contributor license agreements. See the NOTICE file distributed with
4 * this work for additional information regarding copyright ownership.
5 * The ASF licenses this file to You under the Apache license, Version 2.0
6 * (the "License"); you may not use this file except in compliance with
7 * the License. You may obtain a copy of the License at
8 *
9 * http://www.apache.org/licenses/LICENSE-2.0
10 *
11 * Unless required by applicable law or agreed to in writing, software
12 * distributed under the License is distributed on an "AS IS" BASIS,
13 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 * See the license for the specific language governing permissions and
15 * limitations under the license.
16 */
17 package org.apache.logging.log4j.message;
18
19 import org.apache.logging.log4j.util.PerformanceSensitive;
20
21 /**
22 * Allows message parameters to be iterated over without any allocation
23 * or memory copies.
24 *
25 * @since 2.11
26 */
27 @PerformanceSensitive("allocation")
28 public interface ParameterVisitable {
29
30 /**
31 * Performs the given action for each parameter until all values
32 * have been processed or the action throws an exception.
33 * <p>
34 * The second parameter lets callers pass in a stateful object to be modified with the key-value pairs,
35 * so the TriConsumer implementation itself can be stateless and potentially reusable.
36 * </p>
37 *
38 * @param action The action to be performed for each key-value pair in this collection
39 * @param state the object to be passed as the third parameter to each invocation on the
40 * specified ParameterConsumer.
41 * @param <S> type of the third parameter
42 * @since 2.11
43 */
44 <S> void forEachParameter(ParameterConsumer<S> action, S state);
45
46 }