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
    30      private static final long serialVersionUID = 1L;
    31
    32      /**
    33       * Instance of StringFormatterMessageFactory.
    34       */
    35      public static final ParameterizedMessageFactory INSTANCE = new ParameterizedMessageFactory();
    36
    37      /**
    38       * Creates {@link ParameterizedMessage} instances.
    39       * @param message The message pattern.
    40       * @param params The message parameters.
    41       * @return The Message.
    42       *
    43       * @see MessageFactory#newMessage(String, Object...)
    44       */
    45      @Override
    46      public Message newMessage(final String message, final Object... params) {
    47          return new ParameterizedMessage(message, params);
    48      }
    49  }