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