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   * Factory for the simplest possible implementation of Message, the Message String given as the constructor argument.
21   * <p>
22   * Creates {@link StringFormattedMessage} instances for
23   * {@link #newMessage(String, Object...)}.
24   * </p>
25   * <p>
26   * This class is immutable.
27   * </p>
28   * @since 2.5
29   */
30  public final class SimpleMessageFactory extends AbstractMessageFactory {
31  
32      /**
33       * Instance of StringFormatterMessageFactory.
34       */
35      public static final SimpleMessageFactory INSTANCE = new SimpleMessageFactory();
36      private static final long serialVersionUID = 4418995198790088516L;
37  
38      /**
39       * Creates {@link StringFormattedMessage} instances.
40       *
41       * @param message
42       *            The message pattern.
43       * @param params
44       *            The parameters to the message.
45       * @return The Message.
46       *
47       * @see MessageFactory#newMessage(String, Object...)
48       */
49      @Override
50      public Message newMessage(final String message, final Object... params) {
51          return new SimpleMessage(message);
52      }
53  }