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 import java.util.Formatter;
20
21 /**
22 * Enables use of {@link Formatter} strings in message strings.
23 * <p>
24 * Creates {@link StringFormattedMessage} instances for {@link #newMessage(String, Object...)}.
25 * </p>
26 * <p>
27 * This class is immutable.
28 * </p>
29 *
30 * @version $Id: StringFormatterMessageFactory.java 1435776 2013-01-20 02:30:24Z rgoers $
31 */
32 public final class StringFormatterMessageFactory extends AbstractMessageFactory {
33
34 /**
35 * Instance of StringFormatterMessageFactory.
36 */
37 public static final StringFormatterMessageFactory INSTANCE = new StringFormatterMessageFactory();
38
39 /**
40 * Creates {@link StringFormattedMessage} instances.
41 *
42 * @param message The message pattern.
43 * @param params The parameters to the message.
44 * @return The Message.
45 *
46 * @see MessageFactory#newMessage(String, Object...)
47 */
48 @Override
49 public Message newMessage(final String message, final Object... params) {
50 return new StringFormattedMessage(message, params);
51 }
52 }