View Javadoc
1   /*
2    * *************************************************************************************************************************************************************
3    *
4    * TheseFoolishThings: Miscellaneous utilities
5    * http://tidalwave.it/projects/thesefoolishthings
6    *
7    * Copyright (C) 2009 - 2026 by Tidalwave s.a.s. (http://tidalwave.it)
8    *
9    * *************************************************************************************************************************************************************
10   *
11   * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License.
12   * You may obtain a copy of the License at
13   *
14   *     http://www.apache.org/licenses/LICENSE-2.0
15   *
16   * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
17   * CONDITIONS OF ANY KIND, either express or implied.  See the License for the specific language governing permissions and limitations under the License.
18   *
19   * *************************************************************************************************************************************************************
20   *
21   * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
22   * git clone https://github.com/tidalwave-it/thesefoolishthings-src
23   *
24   * *************************************************************************************************************************************************************
25   */
26  package it.tidalwave.util;
27  
28  import jakarta.annotation.Nonnull;
29  import java.util.Locale;
30  import java.util.MissingResourceException;
31  import java.util.ResourceBundle;
32  import lombok.AccessLevel;
33  import lombok.NoArgsConstructor;
34  import lombok.extern.slf4j.Slf4j;
35  
36  /***************************************************************************************************************************************************************
37   *
38   * Facility class to manage resource bundles.
39   *
40   * @since   3.1-ALPHA-2
41   * @author  Fabrizio Giudici
42   *
43   **************************************************************************************************************************************************************/
44  @NoArgsConstructor(access = AccessLevel.PRIVATE) @Slf4j
45  public final class BundleUtilities
46    {
47      /***********************************************************************************************************************************************************
48       * {@return a localised message}.
49       * @param   clazz                 the owner of the bundle
50       * @param   key                   the key of the resource inside the bundle
51       * @param   params                the parameters (used if the string in the bundle is a {@code String} format)
52       **********************************************************************************************************************************************************/
53      @Nonnull
54      public static String getMessage (@Nonnull final Class<?> clazz, @Nonnull final String key, @Nonnull final Object ... params)
55        {
56          return getMessage(clazz, Locale.getDefault(), key, params);
57        }
58  
59      /***********************************************************************************************************************************************************
60       * {@return a localised message}.
61       * @since   3.1-ALPHA-4
62       * @param   clazz                 the owner of the bundle
63       * @param   locale                the {@link Locale}
64       * @param   key                   the key of the resource inside the bundle
65       * @param   params                the parameters (used if the string in the bundle is a {@code String} format)
66       **********************************************************************************************************************************************************/
67      @Nonnull
68      public static String getMessage (@Nonnull final Class<?> clazz, @Nonnull final Locale locale, @Nonnull final String key, @Nonnull final Object ... params)
69        {
70          try
71            {
72              final var moduleName = clazz.getModule().getName();
73              final var packageName = clazz.getPackage().getName();
74              final var bundleName = packageName + ".Bundle";
75              final var bundle = moduleName == null ? ResourceBundle.getBundle(bundleName, locale)
76                                                    : ResourceBundle.getBundle(bundleName, locale, clazz.getModule());
77              final var string = bundle.getString(key);
78              return params.length == 0 ? string : String.format(string, params);
79            }
80          catch (MissingResourceException e)
81            {
82              log.error("", e);
83              return "Missing resource: " + key;
84            }
85        }
86    }