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 * Creates flow messages. Implementations can provide different message format syntaxes.
21 * @since 2.6
22 */
23 public interface FlowMessageFactory {
24
25 /**
26 * Creates a new entry message based on an existing message.
27 *
28 * @param message the original message
29 * @return the new entry message
30 */
31 EntryMessage newEntryMessage(Message message);
32
33 /**
34 * Creates a new exit message based on a return value and an existing message.
35 *
36 * @param result the return value.
37 * @param message the original message
38 * @return the new exit message
39 */
40 ExitMessage newExitMessage(Object result, Message message);
41
42 /**
43 * Creates a new exit message based on no return value and an existing entry message.
44 *
45 * @param message the original entry message
46 * @return the new exit message
47 */
48 ExitMessage newExitMessage(EntryMessage message);
49
50 /**
51 * Creates a new exit message based on a return value and an existing entry message.
52 *
53 * @param result the return value.
54 * @param message the original entry message
55 * @return the new exit message
56 */
57 ExitMessage newExitMessage(Object result, EntryMessage message);
58 }