View Javadoc
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 messages. Implementations can provide different message format syntaxes.
21   *
22   * @see ParameterizedMessageFactory
23   */
24  public interface MessageFactory2 extends MessageFactory {
25      
26      /**
27       * Creates a new message for the specified CharSequence.
28       * @param charSequence the (potentially mutable) CharSequence
29       * @return a new message for the specified CharSequence
30       */
31      Message newMessage(CharSequence charSequence);
32  
33      /**
34       * Creates a new parameterized message.
35       *
36       * @param message a message template, the kind of message template depends on the implementation.
37       * @param p0 the message parameters
38       * @return a new message
39       * @see ParameterizedMessageFactory
40       */
41      Message newMessage(String message, Object p0);
42  
43      /**
44       * Creates a new parameterized message.
45       *
46       * @param message a message template, the kind of message template depends on the implementation.
47       * @param p0 the message parameters
48       * @param p1 the message parameters
49       * @return a new message
50       * @see ParameterizedMessageFactory
51       */
52      Message newMessage(String message, Object p0, Object p1);
53  
54      /**
55       * Creates a new parameterized message.
56       *
57       * @param message a message template, the kind of message template depends on the implementation.
58       * @param p0 the message parameters
59       * @param p1 the message parameters
60       * @param p2 the message parameters
61       * @return a new message
62       * @see ParameterizedMessageFactory
63       */
64      Message newMessage(String message, Object p0, Object p1, Object p2);
65  
66      /**
67       * Creates a new parameterized message.
68       *
69       * @param message a message template, the kind of message template depends on the implementation.
70       * @param p0 the message parameters
71       * @param p1 the message parameters
72       * @param p2 the message parameters
73       * @param p3 the message parameters
74       * @return a new message
75       * @see ParameterizedMessageFactory
76       */
77      Message newMessage(String message, Object p0, Object p1, Object p2, Object p3);
78  
79      /**
80       * Creates a new parameterized message.
81       *
82       * @param message a message template, the kind of message template depends on the implementation.
83       * @param p0 the message parameters
84       * @param p1 the message parameters
85       * @param p2 the message parameters
86       * @param p3 the message parameters
87       * @param p4 the message parameters
88       * @return a new message
89       * @see ParameterizedMessageFactory
90       */
91      Message newMessage(String message, Object p0, Object p1, Object p2, Object p3, Object p4);
92  
93      /**
94       * Creates a new parameterized message.
95       *
96       * @param message a message template, the kind of message template depends on the implementation.
97       * @param p0 the message parameters
98       * @param p1 the message parameters
99       * @param p2 the message parameters
100      * @param p3 the message parameters
101      * @param p4 the message parameters
102      * @param p5 the message parameters
103      * @return a new message
104      * @see ParameterizedMessageFactory
105      */
106     Message newMessage(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5);
107 
108     /**
109      * Creates a new parameterized message.
110      *
111      * @param message a message template, the kind of message template depends on the implementation.
112      * @param p0 the message parameters
113      * @param p1 the message parameters
114      * @param p2 the message parameters
115      * @param p3 the message parameters
116      * @param p4 the message parameters
117      * @param p5 the message parameters
118      * @param p6 the message parameters
119      * @return a new message
120      * @see ParameterizedMessageFactory
121      */
122     Message newMessage(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6);
123 
124     /**
125      * Creates a new parameterized message.
126      *
127      * @param message a message template, the kind of message template depends on the implementation.
128      * @param p0 the message parameters
129      * @param p1 the message parameters
130      * @param p2 the message parameters
131      * @param p3 the message parameters
132      * @param p4 the message parameters
133      * @param p5 the message parameters
134      * @param p6 the message parameters
135      * @param p7 the message parameters
136      * @return a new message
137      * @see ParameterizedMessageFactory
138      */
139     Message newMessage(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6,
140             Object p7);
141 
142     /**
143      * Creates a new parameterized message.
144      *
145      * @param message a message template, the kind of message template depends on the implementation.
146      * @param p0 the message parameters
147      * @param p1 the message parameters
148      * @param p2 the message parameters
149      * @param p3 the message parameters
150      * @param p4 the message parameters
151      * @param p5 the message parameters
152      * @param p6 the message parameters
153      * @param p7 the message parameters
154      * @param p8 the message parameters
155      * @return a new message
156      * @see ParameterizedMessageFactory
157      */
158     Message newMessage(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6,
159             Object p7, Object p8);
160 
161     /**
162      * Creates a new parameterized message.
163      *
164      * @param message a message template, the kind of message template depends on the implementation.
165      * @param p0 the message parameters
166      * @param p1 the message parameters
167      * @param p2 the message parameters
168      * @param p3 the message parameters
169      * @param p4 the message parameters
170      * @param p5 the message parameters
171      * @param p6 the message parameters
172      * @param p7 the message parameters
173      * @param p8 the message parameters
174      * @param p9 the message parameters
175      * @return a new message
176      * @see ParameterizedMessageFactory
177      */
178     Message newMessage(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6,
179             Object p7, Object p8, Object p9);
180 }