org.apache.wicket.resource.loader

Class ClassStringResourceLoader

java.lang.Object

org.apache.wicket.resource.loader.ComponentStringResourceLoader

org.apache.wicket.resource.loader.ClassStringResourceLoader

All Implemented Interfaces:

IStringResourceLoader

public class ClassStringResourceLoader
extends ComponentStringResourceLoader

This string resource loader attempts to find a single resource bundle that has the same name and location as the clazz provided in the constructor. If the bundle is found than strings are obtained from here. This implementation is fully aware of both locale and style values when trying to obtain the appropriate bundle.

An instance of this loader is registered with the Application by default.

Author:

Chris Turner, Juergen Donnerstag

Constructor Summary

Constructors

Constructor and Description
ClassStringResourceLoader(Class<?> clazz) Create and initialize the resource loader.

Method Summary

Methods

Modifier and Type	Method and Description
String	loadStringResource(Class<?> clazz, String key, Locale locale, String style, String variation) Get the string resource for the given combination of component class, resource key, locale and style.
String	loadStringResource(Component component, String key, Locale locale, String style, String variation) Get the string resource for the given combination of component, resource key, locale and style.

Methods inherited from class org.apache.wicket.resource.loader.ComponentStringResourceLoader

getPropertiesFactory, getResourcePath, isStopResourceSearch, isStopResourceSearch, newResourceNameIterator

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassStringResourceLoader

public ClassStringResourceLoader(Class<?> clazz)

Create and initialize the resource loader.

Parameters:

clazz - The class that this resource loader is associated with

Method Detail

loadStringResource

public String loadStringResource(Class<?> clazz,
                        String key,
                        Locale locale,
                        String style,
                        String variation)

Description copied from interface: IStringResourceLoader

Get the string resource for the given combination of component class, resource key, locale and style. The component class provided is used to allow implementation of component specific resource loading (e.g. per page or per reusable component). The key should be a String containing a lookup key into a resource bundle. The locale should contain the locale of the current operation so that the appropriate set of resources can be selected. The style allows the set of resources to select to be varied by skin/brand.

Specified by:

loadStringResource in interface IStringResourceLoader

Overrides:

loadStringResource in class ComponentStringResourceLoader

Parameters:

clazz - The class to get the string resource for

key - The key should be a String containing a lookup key into a resource bundle

locale - The locale should contain the locale of the current operation so that the appropriate set of resources can be selected

style - The style identifying the resource set to select the strings from (see Session)

variation - The components variation (of the style)

Returns:

The string resource value or null if the resource could not be loaded by this loader

See Also:

ComponentStringResourceLoader.loadStringResource(java.lang.Class, java.lang.String, java.util.Locale, java.lang.String, java.lang.String)

loadStringResource

public String loadStringResource(Component component,
                        String key,
                        Locale locale,
                        String style,
                        String variation)

Description copied from interface: IStringResourceLoader

Get the string resource for the given combination of component, resource key, locale and style. The component provided is used to allow implementation of component specific resource loading (e.g. per page or per reusable component). The key should be a String containing a lookup key into a resource bundle. The Locale and the style will be taken from the Component provided.

Specified by:

loadStringResource in interface IStringResourceLoader

Overrides:

loadStringResource in class ComponentStringResourceLoader

Parameters:

component - The component to get the string resource for

key - The key should be a String containing a lookup key into a resource bundle

locale - Will be preset with the appropriate value. You shall ignore the component's locale.

style - Will be preset with the appropriate value. You shall ignore the component's style.

variation - Will be preset with the appropriate value. You shall ignore the component's variation.

Returns:

The string resource value or null if the resource could not be loaded by this loader

See Also:

ComponentStringResourceLoader.loadStringResource(org.apache.wicket.Component, String, java.util.Locale, String, String)