org.foxlabs.util.resource

Class MessageBundle

java.lang.Object

org.foxlabs.util.resource.MessageBundle

public final class MessageBundle
extends Object

This class is lightweight wrapper around java.util.ResourceBundle.

Author:

Fox Mulder

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(String key) Determines whether the specified message key is contained in this message bundle or its parent bundles.
boolean	equals(Object obj) Determines if this message bundle equals to the specified one.
String	format(String key, Locale locale, Object... args) Formats message for the specified key and locale.
String	format(String key, Object... args) Formats message for the specified key and default locale.
String	get(String key) Returns message for the specified key and default locale.
String	get(String key, Locale locale) Returns message for the specified key and locale.
String	getBaseName() Returns message bundle base name.
ClassLoader	getClassLoader() Returns class loader to be used for loading resources.
static MessageBundle	getInstance(String name) Returns message bundle for the specified base name and default class loader.
static MessageBundle	getInstance(String name, ClassLoader loader) Returns message bundle for the specified base name and class loader.
static MessageBundle	getInstance(String name, ClassLoader loader, MessageBundle parent) Returns message bundle for the specified base name, class loader and parent bundle.
static MessageBundle	getInstance(String name, MessageBundle parent) Returns message bundle for the specified base name, parent bundle and default class loader.
MessageBundle	getParentBundle() Returns parent message bundle.
int	hashCode() Returns a hash code value for this message bundle.
boolean	isAssignableFrom(MessageBundle bundle) Determines whether the specified message bundle is either the same or is a parent bundle of this bundle.
String	toString() Returns a string that contains base name of this message bundle and its parent bundles.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getBaseName

public String getBaseName()

Returns message bundle base name.

Returns:

Message bundle base name.

getClassLoader

public ClassLoader getClassLoader()

Returns class loader to be used for loading resources.

Returns:

Class loader to be used for loading resources.

getParentBundle

public MessageBundle getParentBundle()

Returns parent message bundle.

Returns:

Parent message bundle.

isAssignableFrom

public boolean isAssignableFrom(MessageBundle bundle)

Determines whether the specified message bundle is either the same or is a parent bundle of this bundle.

Parameters:

bundle - Message bundle to be checked.

Returns:

true if the specified message bundle is either the same or is a parent bundle of this bundle; false otherwise.

contains

public boolean contains(String key)

Determines whether the specified message key is contained in this message bundle or its parent bundles.

Parameters:

key - Message key.

Returns:

true if the specified message key is contained in this message bundle or its parent bundles; false otherwise.

get

public String get(String key)

Returns message for the specified key and default locale.

Parameters:

key - Message key.

Returns:

Message for the specified key and default locale.

Throws:

MissingResourceException - if message for the specified key is missing.

See Also:

get(String, Locale)

get

public String get(String key,
         Locale locale)

Returns message for the specified key and locale.

Parameters:

key - Message key.

locale - Desired locale.

Returns:

Message for the specified key and locale.

Throws:

MissingResourceException - if message for the specified key is missing.

format

public String format(String key,
            Object... args)

Formats message for the specified key and default locale.

Parameters:

key - Message key.

args - Message arguments.

Returns:

Formatted message for the specified key and default locale.

Throws:

MissingResourceException - if message for the specified key is missing.

See Also:

format(String, Locale, Object...)

format

public String format(String key,
            Locale locale,
            Object... args)

Formats message for the specified key and locale.

Parameters:

key - Message key.

locale - Desired locale.

args - Message arguments.

Returns:

Formatted message for the specified key and locale.

Throws:

MissingResourceException - if message for the specified key is missing.

hashCode

public int hashCode()

Returns a hash code value for this message bundle.

Overrides:

hashCode in class Object

Returns:

A hash code value for this message bundle.

equals

public boolean equals(Object obj)

Determines if this message bundle equals to the specified one.

Overrides:

equals in class Object

Returns:

true if this message bundle equals to the specified one; false otherwise.

toString

public String toString()

Returns a string that contains base name of this message bundle and its parent bundles.

Overrides:

toString in class Object

Returns:

A string that contains base name of this message bundle and its parent bundles.

getInstance

public static MessageBundle getInstance(String name)

Returns message bundle for the specified base name and default class loader.

Parameters:

name - Message bundle base name.

Returns:

Message bundle for the specified base name and default class loader.

See Also:

getInstance(String, ClassLoader, MessageBundle)

getInstance

public static MessageBundle getInstance(String name,
                        ClassLoader loader)

Returns message bundle for the specified base name and class loader.

Parameters:

name - Message bundle base name.

loader - Class loader to be used for resource loading.

Returns:

Message bundle for the specified base name and class loader.

See Also:

getInstance(String, ClassLoader, MessageBundle)

getInstance

public static MessageBundle getInstance(String name,
                        MessageBundle parent)

Returns message bundle for the specified base name, parent bundle and default class loader.

Parameters:

name - Message bundle base name.

parent - Parent message bundle.

Returns:

Message bundle for the specified base name, parent bundle and default class loader.

See Also:

getInstance(String, ClassLoader, MessageBundle)

getInstance

public static MessageBundle getInstance(String name,
                        ClassLoader loader,
                        MessageBundle parent)

Returns message bundle for the specified base name, class loader and parent bundle.

Parameters:

name - Message bundle base name.

loader - Class loader to be used for resource loading.

parent - Parent message bundle.

Returns:

Message bundle for the specified base name, class loader and parent bundle.