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 /** 20 * Creates messages. Implementations can provide different message format syntaxes. 21 * 22 * @see ParameterizedMessageFactory 23 * @see StringFormatterMessageFactory 24 */ 25 public interface MessageFactory { 26 27 /** 28 * Creates a new message based on an Object. 29 * 30 * @param message 31 * a message object 32 * @return a new message 33 */ 34 Message newMessage(Object message); 35 36 /** 37 * Creates a new message based on a String. 38 * 39 * @param message 40 * a message String 41 * @return a new message 42 */ 43 Message newMessage(String message); 44 45 /** 46 * Creates a new parameterized message. 47 * 48 * @param message 49 * a message template, the kind of message template depends on the implementation. 50 * @param params 51 * the message parameters 52 * @return a new message 53 * @see ParameterizedMessageFactory 54 * @see StringFormatterMessageFactory 55 */ 56 Message newMessage(String message, Object... params); 57 }