org.jasig.portal.lang
Class Resources

java.lang.Object
  org.jasig.portal.lang.Resources

public final class Resources
extends Object

The Resources class defines a set of utility methods which translate an internationalized string to a localized string. The transformation is done with the use of standard java.util.ResourceBundle and java.text.MessageFormat classes.

Version:

$Revision: 19776 $ $Date: 2010-01-14 16:17:21 -0600 (Thu, 14 Jan 2010) $

Author:

Jan Nielsen

Method Summary

static String	getString(Class client, String name) Returns the localized value of the specified string resource.
static String	getString(Class client, String name, String[] objects) Returns the localized value of the specified string resource.

Methods inherited from class java.lang.Object

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

Method Detail

getString

public static final String getString(Class client,
                                     String name)

Returns the localized value of the specified string resource. The string resource is resolved by using the client parameter to lookup the associated ResourceBundle object and returning the string value associated with the specified name.

Parameters:

client - class to use to find the resource bundle

name - name of the string resource

Returns:

value of the string resource

Throws:

NullPointerException - if client or name is null

MissingResourceException - if the resource name is not found

getString

public static final String getString(Class client,
                                     String name,
                                     String[] objects)

Returns the localized value of the specified string resource. The string resource is resolved by using the client parameter to lookup the associated ResourceBundle object and returning the string value associated with the specified name. The MessageFormat class is used to format the localized string using the specified runtime parameters.

Parameters:

client - class to use to find the resource bundle

name - name of the string resource

objects - runtime objects to be inserted into resource

Returns:

value of the string resource

Throws:

NullPointerException - if client or name is null

MissingResourceException - if the resource name is not found