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.util.ResourceBundle;
20  
21  /**
22   * Creates {@link org.apache.logging.log4j.message.LocalizedMessage} instances for
23   * {@link #newMessage(String, Object...)}.
24   */
25  public class LocalizedMessageFactory extends AbstractMessageFactory {
26  
27      private static final long serialVersionUID = 1L;
28  
29      // FIXME: cannot use ResourceBundle name for serialization until Java 8
30      private transient final ResourceBundle resourceBundle;
31      private final String baseName;
32  
33      public LocalizedMessageFactory(final ResourceBundle resourceBundle) {
34          this.resourceBundle = resourceBundle;
35          this.baseName = null;
36      }
37  
38  
39      public LocalizedMessageFactory(final String baseName) {
40          this.resourceBundle = null;
41          this.baseName = baseName;
42      }
43  
44  
45      /**
46       * Gets the resource bundle base name if set.
47       * 
48       * @return the resource bundle base name if set. May be null.
49       */
50      public String getBaseName() {
51          return this.baseName;
52      }
53  
54  
55      /**
56       * Gets the resource bundle if set.
57       * 
58       * @return the resource bundle if set. May be null.
59       */
60      public ResourceBundle getResourceBundle() {
61          return this.resourceBundle;
62      }
63  
64  
65      /**
66       * Creates {@link org.apache.logging.log4j.message.StringFormattedMessage} instances.
67       *
68       * @param key The key String, used as a message if the key is absent.
69       * @param params The parameters for the message at the given key.
70       * @return The Message.
71       *
72       * @see org.apache.logging.log4j.message.MessageFactory#newMessage(String, Object...)
73       */
74      @Override
75      public Message newMessage(final String key, final Object... params) {
76          if (resourceBundle == null) {
77              return new LocalizedMessage(baseName,  key, params);
78          }
79          return new LocalizedMessage(resourceBundle, key, params);
80      }
81  }