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     */
017    package org.apache.logging.log4j.message;
018    
019    /**
020     * Creates messages. Implementations can provide different message format syntaxes.
021     *
022     * @see ParameterizedMessageFactory
023     * @see StringFormatterMessageFactory
024     */
025    public interface MessageFactory {
026    
027        /**
028         * Creates a new message based on an Object.
029         *
030         * @param message
031         *            a message object
032         * @return a new message
033         */
034        Message newMessage(Object message);
035    
036        /**
037         * Creates a new message based on a String.
038         *
039         * @param message
040         *            a message String
041         * @return a new message
042         */
043        Message newMessage(String message);
044    
045        /**
046         * Creates a new parameterized message.
047         *
048         * @param message
049         *            a message template, the kind of message template depends on the implementation.
050         * @param params
051         *            the message parameters
052         * @return a new message
053         * @see ParameterizedMessageFactory
054         * @see StringFormatterMessageFactory
055         */
056        Message newMessage(String message, Object... params);
057    }