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