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 javax.annotation.Nonnull;
  28. import java.util.Locale;
  29. import java.util.ResourceBundle;
  30. import lombok.AccessLevel;
  31. import lombok.NoArgsConstructor;

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

  58.     /***********************************************************************************************************************************************************
  59.      * Returns a localised message.
  60.      *
  61.      * @since   3.1-ALPHA-4
  62.      * @param   ownerClass      the owner of the bundle
  63.      * @param   locale          the {@link Locale}
  64.      * @param   resourceName    the name of the resource inside the bundle
  65.      * @param   params          the parameters (used if the string in the bundle is a {@code String} format)
  66.      * @return                  the message
  67.      **********************************************************************************************************************************************************/
  68.       @Nonnull
  69.       public static String getMessage (@Nonnull final Class<?> ownerClass,
  70.                                        @Nonnull final Locale locale,
  71.                                        @Nonnull final String resourceName,
  72.                                        @Nonnull final Object ... params)
  73.       {
  74.         final var packageName = ownerClass.getPackage().getName();
  75.         final var bundle = ResourceBundle.getBundle(packageName + ".Bundle", locale);
  76.         final var string = bundle.getString(resourceName);

  77.         return (params.length == 0) ? string : String.format(string, params);
  78.       }
  79.   }