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 org.apache.logging.log4j.status.StatusLogger; 20 21 /** 22 * Specialized {@link ParameterizedMessageFactory} that creates {@link SimpleMessage} objects that do not retain a 23 * reference to the parameter object. 24 * <p> 25 * Intended for use by the {@link StatusLogger}: this logger retains a queue of recently logged messages in memory, 26 * causing memory leaks in web applications. (LOG4J2-1176) 27 * </p> 28 * <p> 29 * This class is immutable. 30 * </p> 31 */ 32 public final class ParameterizedNoReferenceMessageFactory extends AbstractMessageFactory { 33 34 /** 35 * Instance of ParameterizedStatusMessageFactory. 36 */ 37 public static final ParameterizedNoReferenceMessageFactory INSTANCE = new ParameterizedNoReferenceMessageFactory(); 38 39 private static final long serialVersionUID = 1L; 40 41 /** 42 * Creates {@link SimpleMessage} instances containing the formatted parameterized message string. 43 * 44 * @param message The message pattern. 45 * @param params The message parameters. 46 * @return The Message. 47 * 48 * @see MessageFactory#newMessage(String, Object...) 49 */ 50 @Override 51 public Message newMessage(final String message, final Object... params) { 52 if (params == null) { 53 return new SimpleMessage(message); 54 } 55 final String formatted = new ParameterizedMessage(message, params).getFormattedMessage(); 56 return new SimpleMessage(formatted); 57 } 58 }