BundleUtilities.java

  1. /*
  2.  * *************************************************************************************************************************************************************
  3.  *
  4.  * TheseFoolishThings: Miscellaneous utilities
  5.  * http://tidalwave.it/projects/thesefoolishthings
  6.  *
  7.  * Copyright (C) 2009 - 2025 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. import jakarta.annotation.Nonnull;
  28. import java.util.Locale;
  29. import java.util.MissingResourceException;
  30. import java.util.ResourceBundle;
  31. import lombok.AccessLevel;
  32. import lombok.NoArgsConstructor;
  33. import lombok.extern.slf4j.Slf4j;

  34. /***************************************************************************************************************************************************************
  35.  *
  36.  * Facility class to manage resource bundles.
  37.  *
  38.  * @since   3.1-ALPHA-2
  39.  * @author  Fabrizio Giudici
  40.  *
  41.  **************************************************************************************************************************************************************/
  42. @NoArgsConstructor(access = AccessLevel.PRIVATE) @Slf4j
  43. public final class BundleUtilities
  44.   {
  45.     /***********************************************************************************************************************************************************
  46.      * {@return a localised message}.
  47.      * @param   clazz                 the owner of the bundle
  48.      * @param   key                   the key of the resource inside the bundle
  49.      * @param   params                the parameters (used if the string in the bundle is a {@code String} format)
  50.      **********************************************************************************************************************************************************/
  51.     @Nonnull
  52.     public static String getMessage (@Nonnull final Class<?> clazz, @Nonnull final String key, @Nonnull final Object ... params)
  53.       {
  54.         return getMessage(clazz, Locale.getDefault(), key, params);
  55.       }

  56.     /***********************************************************************************************************************************************************
  57.      * {@return a localised message}.
  58.      * @since   3.1-ALPHA-4
  59.      * @param   clazz                 the owner of the bundle
  60.      * @param   locale                the {@link Locale}
  61.      * @param   key                   the key of the resource inside the bundle
  62.      * @param   params                the parameters (used if the string in the bundle is a {@code String} format)
  63.      **********************************************************************************************************************************************************/
  64.     @Nonnull
  65.     public static String getMessage (@Nonnull final Class<?> clazz, @Nonnull final Locale locale, @Nonnull final String key, @Nonnull final Object ... params)
  66.       {
  67.         try
  68.           {
  69.             final var moduleName = clazz.getModule().getName();
  70.             final var packageName = clazz.getPackage().getName();
  71.             final var bundleName = packageName + ".Bundle";
  72.             final var bundle = moduleName == null ? ResourceBundle.getBundle(bundleName, locale)
  73.                                                   : ResourceBundle.getBundle(bundleName, locale, clazz.getModule());
  74.             final var string = bundle.getString(key);
  75.             return params.length == 0 ? string : String.format(string, params);
  76.           }
  77.         catch (MissingResourceException e)
  78.           {
  79.             log.error("", e);
  80.             return "Missing resource: " + key;
  81.           }
  82.       }
  83.   }