001/* 002 * Licensed to the Apache Software Foundation (ASF) under one or more 003 * contributor license agreements. See the NOTICE file distributed with 004 * this work for additional information regarding copyright ownership. 005 * The ASF licenses this file to You under the Apache license, Version 2.0 006 * (the "License"); you may not use this file except in compliance with 007 * the License. You may obtain a copy of the License at 008 * 009 * http://www.apache.org/licenses/LICENSE-2.0 010 * 011 * Unless required by applicable law or agreed to in writing, software 012 * distributed under the License is distributed on an "AS IS" BASIS, 013 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 014 * See the license for the specific language governing permissions and 015 * limitations under the license. 016 */ 017package org.apache.logging.log4j.message; 018 019/** 020 * Enables use of <code>{}</code> parameter markers in message strings. 021 * <p> 022 * Creates {@link ParameterizedMessage} instances for {@link #newMessage(String, Object...)}. 023 * </p> 024 * <p> 025 * This class is immutable. 026 * </p> 027 */ 028public final class ParameterizedMessageFactory extends AbstractMessageFactory { 029 private static final long serialVersionUID = -8970940216592525651L; 030 031 /** 032 * Constructs a message factory. 033 */ 034 public ParameterizedMessageFactory() { 035 super(); 036 } 037 038 /** 039 * Instance of ParameterizedMessageFactory. 040 */ 041 public static final ParameterizedMessageFactory INSTANCE = new ParameterizedMessageFactory(); 042 043 /** 044 * Creates {@link ParameterizedMessage} instances. 045 * 046 * @param message The message pattern. 047 * @param params The message parameters. 048 * @return The Message. 049 * 050 * @see MessageFactory#newMessage(String, Object...) 051 */ 052 @Override 053 public Message newMessage(final String message, final Object... params) { 054 return new ParameterizedMessage(message, params); 055 } 056}