Package org.hibernate.validator.resourceloading

Class AggregateResourceBundleLocator

java.lang.Object

org.hibernate.validator.resourceloading.DelegatingResourceBundleLocator

org.hibernate.validator.resourceloading.AggregateResourceBundleLocator

All Implemented Interfaces:

ResourceBundleLocator

public class AggregateResourceBundleLocator
extends DelegatingResourceBundleLocator

A ResourceBundleLocator implementation that provides access to multiple source ResourceBundles by merging them into one aggregated bundle.

Author:

Gunnar Morling

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AggregateResourceBundleLocator.AggregateBundle	Deprecated. This class should not have been part of the public API and will be removed at a later stage.

Constructor Summary

Constructors

Constructor	Description
AggregateResourceBundleLocator(List<String> bundleNames)	Creates a locator that delivers a resource bundle merged from the given list of source bundles.
AggregateResourceBundleLocator(List<String> bundleNames, boolean preloadResourceBundles, Set<Locale> localesToInitialize)	Creates a locator that delivers a resource bundle merged from the given list of source bundles.
AggregateResourceBundleLocator(List<String> bundleNames, boolean preloadResourceBundles, Set<Locale> localesToInitialize, ResourceBundleLocator delegate)	Creates a locator that delivers a resource bundle merged from the given list of source bundles.
AggregateResourceBundleLocator(List<String> bundleNames, boolean preloadResourceBundles, Set<Locale> localesToInitialize, ResourceBundleLocator delegate, ClassLoader classLoader)	Creates a locator that delivers a resource bundle merged from the given list of source bundles.
AggregateResourceBundleLocator(List<String> bundleNames, ResourceBundleLocator delegate)	Creates a locator that delivers a resource bundle merged from the given list of source bundles.
AggregateResourceBundleLocator(List<String> bundleNames, ResourceBundleLocator delegate, ClassLoader classLoader)	Creates a locator that delivers a resource bundle merged from the given list of source bundles.

Method Summary

Modifier and Type	Method	Description
ResourceBundle	getResourceBundle(Locale locale)	Returns a resource bundle for the given locale.

Methods inherited from class java.lang.Object

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

Constructor Details

AggregateResourceBundleLocator

public AggregateResourceBundleLocator(List<String> bundleNames)

Creates a locator that delivers a resource bundle merged from the given list of source bundles.

Parameters:

bundleNames - A list with source bundle names. The returned bundle will contain all entries from all source bundles. In case a key occurs in multiple source bundles, the value will be taken from the first bundle containing the key.

AggregateResourceBundleLocator

public AggregateResourceBundleLocator(List<String> bundleNames,
 ResourceBundleLocator delegate)

Creates a locator that delivers a resource bundle merged from the given list of source bundles.

Parameters:

bundleNames - A list with source bundle names. The returned bundle will contain all keys from all source bundles. In case a key occurs in multiple source bundles, the value will be taken from the first bundle containing the key.

delegate - A delegate resource bundle locator. The bundle returned by this locator will be added to the aggregate bundle after all source bundles.

AggregateResourceBundleLocator

public AggregateResourceBundleLocator(List<String> bundleNames,
 ResourceBundleLocator delegate,
 ClassLoader classLoader)

Creates a locator that delivers a resource bundle merged from the given list of source bundles.

Parameters:

bundleNames - A list with source bundle names. The returned bundle will contain all keys from all source bundles. In case a key occurs in multiple source bundles, the value will be taken from the first bundle containing the key.

delegate - A delegate resource bundle locator. The bundle returned by this locator will be added to the aggregate bundle after all source bundles.

classLoader - The classloader to use for loading the bundle.

Since:

5.2

AggregateResourceBundleLocator

@Incubating
public AggregateResourceBundleLocator(List<String> bundleNames,
 boolean preloadResourceBundles,
 Set<Locale> localesToInitialize)

Creates a locator that delivers a resource bundle merged from the given list of source bundles.

Parameters:

bundleNames - A list with source bundle names. The returned bundle will contain all entries from all source bundles. In case a key occurs in multiple source bundles, the value will be taken from the first bundle containing the key.

preloadResourceBundles - if resource bundles should be initialized when initializing the locator

localesToInitialize - The set of locales to initialize at bootstrap

Since:

6.1.1

AggregateResourceBundleLocator

@Incubating
public AggregateResourceBundleLocator(List<String> bundleNames,
 boolean preloadResourceBundles,
 Set<Locale> localesToInitialize,
 ResourceBundleLocator delegate)

Creates a locator that delivers a resource bundle merged from the given list of source bundles.

Parameters:

bundleNames - A list with source bundle names. The returned bundle will contain all keys from all source bundles. In case a key occurs in multiple source bundles, the value will be taken from the first bundle containing the key.

preloadResourceBundles - if resource bundles should be initialized when initializing the locator

localesToInitialize - The set of locales to initialize at bootstrap

delegate - A delegate resource bundle locator. The bundle returned by this locator will be added to the aggregate bundle after all source bundles.

Since:

6.1.1

AggregateResourceBundleLocator

@Incubating
public AggregateResourceBundleLocator(List<String> bundleNames,
 boolean preloadResourceBundles,
 Set<Locale> localesToInitialize,
 ResourceBundleLocator delegate,
 ClassLoader classLoader)

Creates a locator that delivers a resource bundle merged from the given list of source bundles.

Parameters:

bundleNames - A list with source bundle names. The returned bundle will contain all keys from all source bundles. In case a key occurs in multiple source bundles, the value will be taken from the first bundle containing the key.

preloadResourceBundles - if resource bundles should be initialized when initializing the locator

localesToInitialize - The set of locales to initialize at bootstrap

delegate - A delegate resource bundle locator. The bundle returned by this locator will be added to the aggregate bundle after all source bundles.

classLoader - The classloader to use for loading the bundle.

Since:

6.1.1

Method Details

getResourceBundle

public ResourceBundle getResourceBundle(Locale locale)

Description copied from interface: ResourceBundleLocator

Returns a resource bundle for the given locale.

Specified by:

getResourceBundle in interface ResourceBundleLocator

Overrides:

getResourceBundle in class DelegatingResourceBundleLocator

Parameters:

locale - A locale, for which a resource bundle shall be retrieved. Must not be null.

Returns:

A resource bundle for the given locale. May be null, if no such bundle exists.