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
019import org.apache.logging.log4j.status.StatusLogger;
020
021/**
022 * Specialized {@link ParameterizedMessageFactory} that creates {@link SimpleMessage} objects that do not retain a
023 * reference to the parameter object.
024 * <p>
025 * Intended for use by the {@link StatusLogger}: this logger retains a queue of recently logged messages in memory,
026 * causing memory leaks in web applications. (LOG4J2-1176)
027 * </p>
028 * <p>
029 * This class is immutable.
030 * </p>
031 */
032public final class ParameterizedNoReferenceMessageFactory extends AbstractMessageFactory {
033
034    /**
035     * Instance of ParameterizedStatusMessageFactory.
036     */
037    public static final ParameterizedNoReferenceMessageFactory INSTANCE = new ParameterizedNoReferenceMessageFactory();
038
039    private static final long serialVersionUID = 1L;
040
041    /**
042     * Creates {@link SimpleMessage} instances containing the formatted parameterized message string.
043     * 
044     * @param message The message pattern.
045     * @param params The message parameters.
046     * @return The Message.
047     *
048     * @see MessageFactory#newMessage(String, Object...)
049     */
050    @Override
051    public Message newMessage(final String message, final Object... params) {
052        if (params == null) {
053            return new SimpleMessage(message);
054        }
055        final String formatted = new ParameterizedMessage(message, params).getFormattedMessage();
056        return new SimpleMessage(formatted);
057    }
058}