org.hippoecm.hst.resourcebundle

Class ResourceBundleUtils

java.lang.Object

org.hippoecm.hst.resourcebundle.ResourceBundleUtils

public class ResourceBundleUtils
extends Object

ResourceBundleUtils

Utility to get resource bundle from either HST ResourceBundleRegistry or Java Standard Resource Bundles or from Repository stored resource bundle files. In case of repository stored resource bundles, the bundle nodes must be of type nt:file containing jcr:content that contain Java Standard Resource Bundle files.

Field Summary

Fields

Modifier and Type	Field and Description
static String	PROPERTIES_SUFFIX
static int	PROPERTIES_SUFFIX_LENGTH

Method Summary

Modifier and Type	Method and Description
static ResourceBundle	getBundle(javax.servlet.http.HttpServletRequest servletRequest, String basename, Locale locale) Deprecated. since HST 2.30.00 (CMS 10.0) Use getBundle(String, java.util.Locale) instead since servletRequest is unused
static ResourceBundle	getBundle(javax.servlet.http.HttpServletRequest servletRequest, String basename, Locale locale, boolean fallbackToJavaResourceBundle) Deprecated. since HST 2.30.00 (CMS 10.0) Use getBundle(String, java.util.Locale, boolean) instead since servletRequest is unused
static ResourceBundle	getBundle(javax.jcr.Session session, String baseJcrAbsFilePath, Locale locale)
static ResourceBundle	getBundle(String basename, Locale locale) Returns resource bundle based on the specified basename and locale.
static ResourceBundle	getBundle(String basename, Locale locale, boolean fallbackToJavaResourceBundle) Returns resource bundle based on the specified basename and locale.
static List<Locale>	localeLookupList(Locale locale)

Methods inherited from class java.lang.Object

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

Field Detail

PROPERTIES_SUFFIX

public static final String PROPERTIES_SUFFIX

See Also:

Constant Field Values

PROPERTIES_SUFFIX_LENGTH

public static final int PROPERTIES_SUFFIX_LENGTH

Method Detail

getBundle

@Deprecated
public static ResourceBundle getBundle(javax.servlet.http.HttpServletRequest servletRequest,
                                                   String basename,
                                                   Locale locale)

Deprecated. since HST 2.30.00 (CMS 10.0) Use getBundle(String, java.util.Locale) instead since servletRequest is unused

Returns resource bundle based on the specified basename and locale. If the locale is null, then the default locale (Locale.getDefault()) is used. If the specific resource bundle is not found from the HST ResourceBundleRegistry, then it looks up Java standard resource bundles. It may throw java.util.MissingResourceException if a resource is not found when Java standard resource bundle resources are looked up.

Parameters:

servletRequest -

basename -

locale -

Returns:

Throws:

NullPointerException - - if baseName is null

MissingResourceException - - if no Java standard resource bundle for the specified base name can be found

getBundle

public static ResourceBundle getBundle(String basename,
                                       Locale locale)

Returns resource bundle based on the specified basename and locale. If the locale is null, then the default locale (Locale.getDefault()) is used. If the specific resource bundle is not found from the HST ResourceBundleRegistry, then it looks up Java standard resource bundles. It may throw java.util.MissingResourceException if a resource is not found when Java standard resource bundle resources are looked up.

Parameters:

basename -

locale -

Returns:

Throws:

NullPointerException - - if baseName is null

MissingResourceException - - if no Java standard resource bundle for the specified base name can be found

getBundle

@Deprecated
public static ResourceBundle getBundle(javax.servlet.http.HttpServletRequest servletRequest,
                                                   String basename,
                                                   Locale locale,
                                                   boolean fallbackToJavaResourceBundle)

Deprecated. since HST 2.30.00 (CMS 10.0) Use getBundle(String, java.util.Locale, boolean) instead since servletRequest is unused

Returns resource bundle based on the specified basename and locale. If the locale is null, then the default locale (Locale.getDefault()) is used. If the specific resource bundle is not found from the HST ResourceBundleRegistry, then it looks up Java standard resource bundles when the fallbackToJavaResourceBundle is true. It may throw java.util.MissingResourceException if a resource is not found when Java standard resource bundle resources are looked up.

Parameters:

servletRequest -

basename -

locale -

fallbackToJavaResourceBundle -

Throws:

NullPointerException - - if baseName is null

MissingResourceException - - if no Java standard resource bundle for the specified base name can be found

getBundle

public static ResourceBundle getBundle(String basename,
                                       Locale locale,
                                       boolean fallbackToJavaResourceBundle)

Returns resource bundle based on the specified basename and locale. If the locale is null, then the default locale (Locale.getDefault()) is used. If the specific resource bundle is not found from the HST ResourceBundleRegistry, then it looks up Java standard resource bundles when the fallbackToJavaResourceBundle is true. It may throw java.util.MissingResourceException if a resource is not found when Java standard resource bundle resources are looked up.

Parameters:

basename -

locale -

fallbackToJavaResourceBundle -

Throws:

NullPointerException - - if baseName is null

MissingResourceException - - if no Java standard resource bundle for the specified base name can be found

getBundle

public static ResourceBundle getBundle(javax.jcr.Session session,
                                       String baseJcrAbsFilePath,
                                       Locale locale)

Parameters:

session - the jcr session to build the resource bundles with

baseJcrAbsFilePath - the absolute jcr path to the base resource bundle, which must be a path starting with a / and ending with .properties and most point to a jcr node of type nt:file

locale - the Locale to get the resource bundle for. If null the base resource bundle is returned

Returns:

the repository based ResourceBundle for baseJcrAbsFilePath and locale

Throws:

IllegalArgumentException - if no resource bundle for the specified baseJcrAbsFilePath can be found or in case baseJcrAbsFilePath is null

IllegalStateException - in case an exception occurs

localeLookupList

public static List<Locale> localeLookupList(Locale locale)

Returns:

list of locales with most specific locale first