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   * Enables use of <code>{}</code> parameter markers in message strings.
21   * <p>
22   * Creates {@link ParameterizedMessage} instances for {@link #newMessage(String, Object...)}.
23   * </p>
24   * <p>
25   * This class is immutable.
26   * </p>
27   */
28  public final class ParameterizedMessageFactory extends AbstractMessageFactory {
29      private static final long serialVersionUID = -8970940216592525651L;
30  
31      /**
32       * Constructs a message factory.
33       */
34      public ParameterizedMessageFactory() {
35          super();
36      }
37  
38      /**
39       * Instance of ParameterizedMessageFactory.
40       */
41      public static final ParameterizedMessageFactory INSTANCE = new ParameterizedMessageFactory();
42  
43      /**
44       * Creates {@link ParameterizedMessage} instances.
45       *
46       * @param message The message pattern.
47       * @param params The message parameters.
48       * @return The Message.
49       *
50       * @see MessageFactory#newMessage(String, Object...)
51       */
52      @Override
53      public Message newMessage(final String message, final Object... params) {
54          return new ParameterizedMessage(message, params);
55      }
56  }