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