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
019import org.apache.logging.log4j.util.PerformanceSensitive;
020
021/**
022 * Allows message parameters to be iterated over without any allocation
023 * or memory copies.
024 *
025 * @since 2.11
026 */
027@PerformanceSensitive("allocation")
028public interface ParameterVisitable {
029
030    /**
031     * Performs the given action for each parameter until all values
032     * have been processed or the action throws an exception.
033     * <p>
034     * The second parameter lets callers pass in a stateful object to be modified with the key-value pairs,
035     * so the TriConsumer implementation itself can be stateless and potentially reusable.
036     * </p>
037     *
038     * @param action The action to be performed for each key-value pair in this collection
039     * @param state the object to be passed as the third parameter to each invocation on the
040     *          specified ParameterConsumer.
041     * @param <S> type of the third parameter
042     * @since 2.11
043     */
044    <S> void forEachParameter(ParameterConsumer<S> action, S state);
045
046}