View Javadoc

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   * @version $Id: MessageFactory.java 1451117 2013-02-28 06:57:37Z sdeboy $
25   */
26  public interface MessageFactory {
27  
28      /**
29       * Creates a new message based on an Object.
30       *
31       * @param message
32       *            a message object
33       * @return a new message
34       */
35      Message newMessage(Object message);
36  
37      /**
38       * Creates a new message based on a String.
39       *
40       * @param message
41       *            a message String
42       * @return a new message
43       */
44      Message newMessage(String message);
45  
46      /**
47       * Creates a new parameterized message.
48       *
49       * @param message
50       *            a message template, the kind of message template depends on the implementation.
51       * @param params
52       *            the message parameters
53       * @return a new message
54       * @see ParameterizedMessageFactory
55       * @see StringFormatterMessageFactory
56       */
57      Message newMessage(String message, Object... params);
58  }