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  import java.io.Serializable;
20  
21  /**
22   * Provides an abstract superclass for {@link MessageFactory2} implementations with default implementations (and for
23   * {@link MessageFactory} by extension).
24   * <p>
25   * This class is immutable.
26   * </p>
27   * <h4>Note to implementors</h4>
28   * <p>
29   * Subclasses can implement the {@link MessageFactory2} methods when they can most effectively build {@link Message}
30   * instances. If a subclass does not implement {@link MessageFactory2} methods, these calls are routed through
31   * {@link #newMessage(String, Object...)} in this class.
32   * </p>
33   */
34  public abstract class AbstractMessageFactory implements MessageFactory2, Serializable {
35      private static final long serialVersionUID = -1307891137684031187L;
36  
37      @Override
38      public Message newMessage(final CharSequence message) {
39          return new SimpleMessage(message);
40      }
41  
42      /*
43       * (non-Javadoc)
44       *
45       * @see org.apache.logging.log4j.message.MessageFactory#newMessage(java.lang.Object)
46       */
47      @Override
48      public Message newMessage(final Object message) {
49          return new ObjectMessage(message);
50      }
51  
52      /*
53       * (non-Javadoc)
54       *
55       * @see org.apache.logging.log4j.message.MessageFactory#newMessage(java.lang.String)
56       */
57      @Override
58      public Message newMessage(final String message) {
59          return new SimpleMessage(message);
60      }
61  
62      /**
63       * @since 2.6.1
64       */
65      @Override
66      public Message newMessage(final String message, final Object p0) {
67          return newMessage(message, new Object[] { p0 });
68      }
69  
70      /**
71       * @since 2.6.1
72       */
73      @Override
74      public Message newMessage(final String message, final Object p0, final Object p1) {
75          return newMessage(message, new Object[] { p0, p1 });
76      }
77  
78      /**
79       * @since 2.6.1
80       */
81      @Override
82      public Message newMessage(final String message, final Object p0, final Object p1, final Object p2) {
83          return newMessage(message, new Object[] { p0, p1, p2 });
84      }
85  
86      /**
87       * @since 2.6.1
88       */
89      @Override
90      public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3) {
91          return newMessage(message, new Object[] { p0, p1, p2, p3 });
92      }
93  
94      /**
95       * @since 2.6.1
96       */
97      @Override
98      public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4) {
99          return newMessage(message, new Object[] { p0, p1, p2, p3, p4 });
100     }
101 
102     /**
103      * @since 2.6.1
104      */
105     @Override
106     public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5) {
107         return newMessage(message, new Object[] { p0, p1, p2, p3, p4, p5 });
108     }
109 
110     /**
111      * @since 2.6.1
112      */
113     @Override
114     public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5,
115             final Object p6) {
116         return newMessage(message, new Object[] { p0, p1, p2, p3, p4, p5, p6 });
117     }
118 
119     /**
120      * @since 2.6.1
121      */
122     @Override
123     public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5,
124             final Object p6, final Object p7) {
125         return newMessage(message, new Object[] { p0, p1, p2, p3, p4, p5, p6, p7 });
126     }
127 
128     /**
129      * @since 2.6.1
130      */
131     @Override
132     public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5,
133             final Object p6, final Object p7, final Object p8) {
134         return newMessage(message, new Object[] { p0, p1, p2, p3, p4, p5, p6, p7, p8 });
135     }
136 
137     /**
138      * @since 2.6.1
139      */
140     @Override
141     public Message newMessage(final String message, final Object p0, final Object p1, final Object p2, final Object p3, final Object p4, final Object p5,
142             final Object p6, final Object p7, final Object p8, final Object p9) {
143         return newMessage(message, new Object[] { p0, p1, p2, p3, p4, p5, p6, p7, p8, p9 });
144     }
145 
146 }