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