001/*
002 * Licensed to the Apache Software Foundation (ASF) under one or more
003 * contributor license agreements. See the NOTICE file distributed with
004 * this work for additional information regarding copyright ownership.
005 * The ASF licenses this file to You under the Apache license, Version 2.0
006 * (the "License"); you may not use this file except in compliance with
007 * the License. You may obtain a copy of the License at
008 *
009 *      http://www.apache.org/licenses/LICENSE-2.0
010 *
011 * Unless required by applicable law or agreed to in writing, software
012 * distributed under the License is distributed on an "AS IS" BASIS,
013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
014 * See the license for the specific language governing permissions and
015 * limitations under the license.
016 */
017package org.apache.logging.log4j.message;
018
019/**
020 * An operation that accepts two input arguments and returns no result.
021 *
022 * <p>
023 * The third parameter lets callers pass in a stateful object to be modified with the key-value pairs,
024 * so the ParameterConsumer implementation itself can be stateless and potentially reusable.
025 * </p>
026 *
027 * @param <S> state data
028 * @see ReusableMessage
029 * @since 2.11
030 */
031public interface ParameterConsumer<S> {
032
033    /**
034     * Performs an operation given the specified arguments.
035     *
036     * @param parameter the parameter
037     * @param parameterIndex Index of the parameter
038     * @param state
039     */
040    void accept(Object parameter, int parameterIndex, S state);
041
042}