| ResourceBundleUtil.java |
1 /**
2 * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3 *
4 * Permission is hereby granted, free of charge, to any person obtaining a copy
5 * of this software and associated documentation files (the "Software"), to deal
6 * in the Software without restriction, including without limitation the rights
7 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
8 * copies of the Software, and to permit persons to whom the Software is
9 * furnished to do so, subject to the following conditions:
10 *
11 * The above copyright notice and this permission notice shall be included in
12 * all copies or substantial portions of the Software.
13 *
14 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
15 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
16 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
17 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
18 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
19 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
20 * SOFTWARE.
21 */
22
23 package com.liferay.util;
24
25 import com.liferay.portal.kernel.log.Log;
26 import com.liferay.portal.kernel.log.LogFactoryUtil;
27
28 import java.text.MessageFormat;
29
30 import java.util.Locale;
31 import java.util.ResourceBundle;
32
33 /**
34 * <a href="ResourceBundleUtil.java.html"><b><i>View Source</i></b></a>
35 *
36 * <p>
37 * This class provides a convenience routine named getString() that
38 * gets the value of a ResourceBundle key, but also provides the ability
39 * to perform search & replace on tokens within the value of the key.
40 * </p>
41 *
42 * @author Neil Griffin
43 *
44 */
45 public class ResourceBundleUtil {
46
47 public static String getString(
48 ResourceBundle bundle, Locale locale, String key, Object[] args) {
49
50 String value = null;
51
52 if (bundle == null) {
53 if (_log.isErrorEnabled()) {
54 _log.error("Resource bundle is null");
55 }
56 }
57 else {
58
59 // Get the value associated with the specified key, and substitute
60 // any arguuments like {0}, {1}, {2}, etc. with the specified
61 // argument values.
62
63 value = bundle.getString(key);
64
65 if (value == null) {
66 if (_log.isWarnEnabled()) {
67 _log.warn("No value found for key " + key);
68 }
69 }
70 else {
71 if ((args != null) && (args.length > 0)) {
72 MessageFormat format = new MessageFormat(value, locale);
73
74 value = format.format(args);
75 }
76 }
77 }
78
79 if (value == null) {
80 value = key;
81 }
82
83 return value;
84 }
85
86 private static Log _log = LogFactoryUtil.getLog(ResourceBundleUtil.class);
87
88 }