Package com.helger.commons.text.resourcebundle

Class ResourceBundleHelper

java.lang.Object

com.helger.commons.text.resourcebundle.ResourceBundleHelper

@Immutable
public final class ResourceBundleHelper
extends Object

Resource bundle utility methods.
Note: the UTF-8 resource bundles are only needed when using Java 1.8 or below since the default was ISO-8859-1. Since Java 9 all ResurceBundles are UTF-8 by default.

Author:

Philip Helger

Method Summary

Modifier and Type	Method	Description
static void	clearCache()	Clear the complete resource bundle cache using the default class loader!
static void	clearCache(ClassLoader aClassLoader)	Clear the complete resource bundle cache using the specified class loader!
static ResourceBundle	getResourceBundle(String sBundleName, Locale aContentLocale)
static ResourceBundle	getResourceBundle(String sBundleName, Locale aContentLocale, ClassLoader aClassLoader)
static String	getString(String sBundleName, Locale aContentLocale, String sKey)
static String	getString(String sBundleName, Locale aContentLocale, String sKey, ClassLoader aClassLoader)
static String	getString(ResourceBundle aResourceBundle, String sKey)
static ResourceBundle	getUtf8ResourceBundle(String sBundleName, Locale aContentLocale)
static ResourceBundle	getUtf8ResourceBundle(String sBundleName, Locale aContentLocale, ClassLoader aClassLoader)
static String	getUtf8String(String sBundleName, Locale aContentLocale, String sKey)
static String	getUtf8String(String sBundleName, Locale aContentLocale, String sKey, ClassLoader aClassLoader)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getResourceBundle

@Nullable
public static ResourceBundle getResourceBundle(@Nonnull
                                               String sBundleName,
                                               @Nonnull
                                               Locale aContentLocale)

getResourceBundle

@Nullable
public static ResourceBundle getResourceBundle(@Nonnull
                                               String sBundleName,
                                               @Nonnull
                                               Locale aContentLocale,
                                               @Nonnull
                                               ClassLoader aClassLoader)

getUtf8ResourceBundle

@Nullable
public static ResourceBundle getUtf8ResourceBundle(@Nonnull
                                                   String sBundleName,
                                                   @Nonnull
                                                   Locale aContentLocale)

getUtf8ResourceBundle

@Nullable
public static ResourceBundle getUtf8ResourceBundle(@Nonnull
                                                   String sBundleName,
                                                   @Nonnull
                                                   Locale aContentLocale,
                                                   @Nonnull
                                                   ClassLoader aClassLoader)

getString

@Nullable
public static String getString(@Nullable
                               ResourceBundle aResourceBundle,
                               @Nonnull @PropertyKey
                               String sKey)

getString

@Nullable
public static String getString(@Nonnull
                               String sBundleName,
                               @Nonnull
                               Locale aContentLocale,
                               @Nonnull @PropertyKey
                               String sKey)

getString

@Nullable
public static String getString(@Nonnull
                               String sBundleName,
                               @Nonnull
                               Locale aContentLocale,
                               @Nonnull @PropertyKey
                               String sKey,
                               @Nonnull
                               ClassLoader aClassLoader)

getUtf8String

@Nullable
public static String getUtf8String(@Nonnull
                                   String sBundleName,
                                   @Nonnull
                                   Locale aContentLocale,
                                   @Nonnull @PropertyKey
                                   String sKey)

getUtf8String

@Nullable
public static String getUtf8String(@Nonnull
                                   String sBundleName,
                                   @Nonnull
                                   Locale aContentLocale,
                                   @Nonnull @PropertyKey
                                   String sKey,
                                   @Nonnull
                                   ClassLoader aClassLoader)

clearCache

public static void clearCache()

Clear the complete resource bundle cache using the default class loader!

clearCache

public static void clearCache(@Nonnull
                              ClassLoader aClassLoader)

Clear the complete resource bundle cache using the specified class loader!

Parameters:

aClassLoader - The class loader to be used. May not be null.