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 /**
20 * An operation that accepts two input arguments and returns no result.
21 *
22 * <p>
23 * The third parameter lets callers pass in a stateful object to be modified with the key-value pairs,
24 * so the ParameterConsumer implementation itself can be stateless and potentially reusable.
25 * </p>
26 *
27 * @param <S> state data
28 * @see ReusableMessage
29 * @since 2.11
30 */
31 public interface ParameterConsumer<S> {
32
33 /**
34 * Performs an operation given the specified arguments.
35 *
36 * @param parameter the parameter
37 * @param parameterIndex Index of the parameter
38 * @param state
39 */
40 void accept(Object parameter, int parameterIndex, S state);
41
42 }