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 {@link FormattedMessage} instances for {@link MessageFactory2} methods (and {@link MessageFactory} by
21   * extension.)
22   * 
23   * <h4>Note to implementors</h4>
24   * <p>
25   * This class implements all {@link MessageFactory2} methods.
26   * </p>
27   */
28  public class MessageFormatMessageFactory extends AbstractMessageFactory {
29      private static final long serialVersionUID = 3584821740584192453L;
30  
31      /**
32       * Constructs a message factory with default flow strings.
33       */
34      public MessageFormatMessageFactory() {
35      }
36  
37      /**
38       * Creates {@link org.apache.logging.log4j.message.StringFormattedMessage} instances.
39       * @param message The message pattern.
40       * @param params Parameters to the message.
41       * @return The Message.
42       *
43       * @see org.apache.logging.log4j.message.MessageFactory#newMessage(String, Object...)
44       */
45      @Override
46      public Message newMessage(final String message, final Object... params) {
47          return new MessageFormatMessage(message, params);
48      }
49  
50      /**
51       * @since 2.6.1
52       */
53      @Override
54      public Message newMessage(final String message, final Object p0) {
55          return new MessageFormatMessage(message, p0);
56      }
57  
58      /**
59       * @since 2.6.1
60       */
61      @Override
62      public Message newMessage(final String message, final Object p0, final Object p1) {
63          return new MessageFormatMessage(message, p0, p1);
64      }
65  
66      /**
67       * @since 2.6.1
68       */
69      @Override
70      public Message newMessage(final String message, final Object p0, final Object p1, final Object p2) {
71          return new MessageFormatMessage(message, p0, p1, p2);
72      }
73  
74      /**
75       * @since 2.6.1
76       */
77      @Override
78      public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3) {
79          return new MessageFormatMessage(message, p0, p1, p2, p3);
80      }
81  
82      /**
83       * @since 2.6.1
84       */
85      @Override
86      public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4) {
87          return new MessageFormatMessage(message, p0, p1, p2, p3, p4);
88      }
89  
90      /**
91       * @since 2.6.1
92       */
93      @Override
94      public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5) {
95          return new MessageFormatMessage(message, p0, p1, p2, p3, p4, p5);
96      }
97  
98      /**
99       * @since 2.6.1
100      */
101     @Override
102     public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5,
103             final Object p6) {
104         return new MessageFormatMessage(message, p0, p1, p2, p3, p4, p5, p6);
105     }
106 
107     /**
108      * @since 2.6.1
109      */
110     @Override
111     public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5,
112             final Object p6, final Object p7) {
113         return new MessageFormatMessage(message, p0, p1, p2, p3, p4, p5, p6, p7);
114     }
115 
116     /**
117      * @since 2.6.1
118      */
119     @Override
120     public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5,
121             final Object p6, final Object p7, final Object p8) {
122         return new MessageFormatMessage(message, p0, p1, p2, p3, p4, p5, p6, p7, p8);
123     }
124 
125     /**
126      * @since 2.6.1
127      */
128     @Override
129     public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5,
130             final Object p6, final Object p7, final Object p8, final Object p9) {
131         return new MessageFormatMessage(message, p0, p1, p2, p3, p4, p5, p6, p7, p8, p9);
132     }
133 }