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