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   * <p>
23   * This uses is the simplest possible implementation of {@link Message}, the where you give the message to the
24   * constructor argument as a String.
25   * </p>
26   * <p>
27   * Creates {@link StringFormattedMessage} instances for {@link #newMessage(String, Object...)}.
28   * </p>
29   * <p>
30   * This class is immutable.
31   * </p>
32   * 
33   * <h4>Note to implementors</h4>
34   * <p>
35   * This class implements all {@link MessageFactory2} methods.
36   * </p>
37   * 
38   * @since 2.5
39   */
40  public final class SimpleMessageFactory extends AbstractMessageFactory {
41  
42      /**
43       * Instance of StringFormatterMessageFactory.
44       */
45      public static final SimpleMessageFactory INSTANCE = new SimpleMessageFactory();
46      private static final long serialVersionUID = 4418995198790088516L;
47  
48      /**
49       * Creates {@link StringFormattedMessage} instances.
50       *
51       * @param message
52       *            The message pattern.
53       * @param params
54       *            The parameters to the message are ignored.
55       * @return The Message.
56       *
57       * @see MessageFactory#newMessage(String, Object...)
58       */
59      @Override
60      public Message newMessage(final String message, final Object... params) {
61          return new SimpleMessage(message);
62      }
63  
64      /**
65       * @since 2.6.1
66       */
67      @Override
68      public Message newMessage(final String message, final Object p0) {
69          return new SimpleMessage(message);
70      }
71  
72      /**
73       * @since 2.6.1
74       */
75      @Override
76      public Message newMessage(final String message, final Object p0, final Object p1) {
77          return new SimpleMessage(message);
78      }
79  
80      /**
81       * @since 2.6.1
82       */
83      @Override
84      public Message newMessage(final String message, final Object p0, final Object p1, final Object p2) {
85          return new SimpleMessage(message);
86      }
87  
88      /**
89       * @since 2.6.1
90       */
91      @Override
92      public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3) {
93          return new SimpleMessage(message);
94      }
95  
96      /**
97       * @since 2.6.1
98       */
99      @Override
100     public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4) {
101         return new SimpleMessage(message);
102     }
103 
104     /**
105      * @since 2.6.1
106      */
107     @Override
108     public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5) {
109         return new SimpleMessage(message);
110     }
111 
112     /**
113      * @since 2.6.1
114      */
115     @Override
116     public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5,
117             final Object p6) {
118         return new SimpleMessage(message);
119     }
120 
121     /**
122      * @since 2.6.1
123      */
124     @Override
125     public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5,
126             final Object p6, final Object p7) {
127         return new SimpleMessage(message);
128     }
129 
130     /**
131      * @since 2.6.1
132      */
133     @Override
134     public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5,
135             final Object p6, final Object p7, final Object p8) {
136         return new SimpleMessage(message);
137     }
138 
139     /**
140      * @since 2.6.1
141      */
142     @Override
143     public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5,
144             final Object p6, final Object p7, final Object p8, final Object p9) {
145         return new SimpleMessage(message);
146     }
147 }