View Javadoc
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  
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   *
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)
43  public final class BundleUtilities
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      @Nonnull
54      public static String getMessage (@Nonnull final Class<?> ownerClass,
55                                       @Nonnull final String resourceName,
56                                       @Nonnull final Object ... params)
57        {
58          return getMessage(ownerClass, Locale.getDefault(), resourceName, params);
59        }
60  
61      /***********************************************************************************************************************************************************
62       * Returns a localised message.
63       *
64       * @since   3.1-ALPHA-4
65       * @param   ownerClass      the owner of the bundle
66       * @param   locale          the {@link Locale}
67       * @param   resourceName    the name of the resource inside the bundle
68       * @param   params          the parameters (used if the string in the bundle is a {@code String} format)
69       * @return                  the message
70       **********************************************************************************************************************************************************/
71        @Nonnull
72        public static String getMessage (@Nonnull final Class<?> ownerClass,
73                                         @Nonnull final Locale locale,
74                                         @Nonnull final String resourceName,
75                                         @Nonnull final Object ... params)
76        {
77          final var packageName = ownerClass.getPackage().getName();
78          final var bundle = ResourceBundle.getBundle(packageName + ".Bundle", locale);
79          final var string = bundle.getString(resourceName);
80  
81          return (params.length == 0) ? string : String.format(string, params);
82        }
83    }