1   /**
2    * Copyright (c) 2000-2009 Liferay, Inc. All rights reserved.
3    *
4    *
5    *
6    *
7    * The contents of this file are subject to the terms of the Liferay Enterprise
8    * Subscription License ("License"). You may not use this file except in
9    * compliance with the License. You can obtain a copy of the License by
10   * contacting Liferay, Inc. See the License for the specific language governing
11   * permissions and limitations under the License, including but not limited to
12   * distribution rights 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 gets the
38   * value of a ResourceBundle key, but also provides the ability to perform
39   * search & replace on tokens within the value of the key.
40   * </p>
41   *
42   * @author Neil Griffin
43   */
44  public class ResourceBundleUtil {
45  
46      public static String getString(
47          ResourceBundle bundle, Locale locale, String key, Object[] args) {
48  
49          String value = null;
50  
51          if (bundle == null) {
52              if (_log.isErrorEnabled()) {
53                  _log.error("Resource bundle is null");
54              }
55          }
56          else {
57  
58              // Get the value associated with the specified key, and substitute
59              // any arguuments like {0}, {1}, {2}, etc. with the specified
60              // argument values.
61  
62              value = bundle.getString(key);
63  
64              if (value == null) {
65                  if (_log.isWarnEnabled()) {
66                      _log.warn("No value found for key " + key);
67                  }
68              }
69              else {
70                  if ((args != null) && (args.length > 0)) {
71                      MessageFormat format = new MessageFormat(value, locale);
72  
73                      value = format.format(args);
74                  }
75              }
76          }
77  
78          if (value == null) {
79              value = key;
80          }
81  
82          return value;
83      }
84  
85      private static Log _log = LogFactoryUtil.getLog(ResourceBundleUtil.class);
86  
87  }