BundleUtilities.java

  1. /*
  2.  * *********************************************************************************************************************
  3.  *
  4.  * TheseFoolishThings: Miscellaneous utilities
  5.  * http://tidalwave.it/projects/thesefoolishthings
  6.  *
  7.  * Copyright (C) 2009 - 2024 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
  12.  * the License. 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
  17.  * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the License for the
  18.  * specific language governing permissions and limitations under the License.
  19.  *
  20.  * *********************************************************************************************************************
  21.  *
  22.  * git clone https://bitbucket.org/tidalwave/thesefoolishthings-src
  23.  * git clone https://github.com/tidalwave-it/thesefoolishthings-src
  24.  *
  25.  * *********************************************************************************************************************
  26.  */
  27. package it.tidalwave.util;

  28. import javax.annotation.Nonnull;
  29. import java.util.Locale;
  30. import java.util.ResourceBundle;
  31. import lombok.AccessLevel;
  32. import lombok.NoArgsConstructor;

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

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

  82.         return (params.length == 0) ? string : String.format(string, params);
  83.       }
  84.   }