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 * Creates flow messages. Implementations can provide different message format syntaxes.
021 * @since 2.6
022 */
023public interface FlowMessageFactory {
024    
025    /**
026     * Creates a new entry message based on an existing message.
027     *
028     * @param message the original message
029     * @return the new entry message
030     */
031    EntryMessage newEntryMessage(Message message);
032
033    /**
034     * Creates a new exit message based on a return value and an existing message.
035     *
036     * @param result the return value.
037     * @param message the original message
038     * @return the new exit message
039     */
040    ExitMessage newExitMessage(Object result, Message message);
041
042    /**
043     * Creates a new exit message based on no return value and an existing entry message.
044     *
045     * @param message the original entry message
046     * @return the new exit message
047     */
048    ExitMessage newExitMessage(EntryMessage message);
049
050    /**
051     * Creates a new exit message based on a return value and an existing entry message.
052     *
053     * @param result the return value.
054     * @param message the original entry message
055     * @return the new exit message
056     */
057    ExitMessage newExitMessage(Object result, EntryMessage message);
058}