com.artima.place.info
Class Name

java.lang.Object
  |
  +--com.artima.place.info.LocalizableInfo
        |
        +--com.artima.place.info.Name

All Implemented Interfaces:

java.lang.Cloneable, Purgable, java.io.Serializable

public class Name

extends LocalizableInfo

A localizable name.

See Also:

Serialized Form

Constructor Summary

Name(java.util.Locale cachedLocale, java.lang.String cachedName)
Constructs a new Name with passed cached name for the passed locale, and no name key and resource bundle loader.

Name(ResourceBundleLoader loader, java.lang.String nameKey)
Constructs a new Name with passed resource bundle loader, name key, and no cached name.

Name(ResourceBundleLoader loader, java.lang.String nameKey, java.util.Locale cachedLocale, java.lang.String cachedName)
Constructs a new Name with passed resource bundle loader, name key, and cached name (for the passed locale).

Method Summary

java.lang.Object	clone() Clones this Name.
boolean	equals(java.lang.Object o) Compares this Name to the passed object for equality.
java.lang.String	getName() Returns a String name, suitable for presentation to users, appropriate to the default locale.
java.lang.String	getName(java.util.Locale desiredLocale) Returns a String name, suitable for presentation to users, which represents the best-fit name for the specified locale.
int	hashCode() Returns a hash code for this object.
void	purge() Purge away information about undesired locales.
void	purge(java.util.Locale preserveLocale) Purge away information about all locales except the passed locale.

Methods inherited from class com.artima.place.info.LocalizableInfo

clearCachedLocale, clearResourceBundleLoader, compareObjectsOrNull, getBestFitLocale, getBestFitLocale, getCachedLocale, getResourceBundleLoader, getSupportedLocales, hasCachedLocale, hasResourceBundleLoader, setCachedLocale, stripResourceBundleLoader, useCache

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Name

public Name(ResourceBundleLoader loader,
            java.lang.String nameKey)

Constructs a new Name with passed resource bundle loader, name key, and no cached name.

Parameters:

loader - the ResourceBundleLoader which can load ResourceBundles for this Name.

nameKey - the String key with which the String resource can be retrieved from a ResourceBundle provided by the ResourceBundleLoader

Name

public Name(ResourceBundleLoader loader,
            java.lang.String nameKey,
            java.util.Locale cachedLocale,
            java.lang.String cachedName)

Constructs a new Name with passed resource bundle loader, name key, and cached name (for the passed locale).

Parameters:

loader - the ResourceBundleLoader which can load ResourceBundles for this Name.

nameKey - the String key with which the String resource can be retrieved from a ResourceBundle provided by the ResourceBundleLoader

cachedLocale - the Locale of the name passed as cachedName.

cachedName - the name whose locale is passed as cachedLocale that should be cached by this Name.

Name

public Name(java.util.Locale cachedLocale,
            java.lang.String cachedName)

Constructs a new Name with passed cached name for the passed locale, and no name key and resource bundle loader. (Because this Name info object contains no resource bundle loader, it also requires no key with which to look up a name resource in a resource bundle.

Parameters:

cachedLocale - the Locale of the name passed as cachedName.

cachedName - the name whose locale is passed as cachedLocale that should be cached by this Name.

Method Detail

getName

public java.lang.String getName()

Returns a String name, suitable for presentation to users, appropriate to the default locale.

Returns:

a String name, suitable for presentation to users, appropriate to the default locale.

Throws:

MissingResourceException - if a codebase URL is found to be unusable. (Because URLString enforces well-formedness of all URLs used by this method, this exception probably indicates the protocol was unknown.), or if a ResourceBundle is not found at the expected codebase

getName

public java.lang.String getName(java.util.Locale desiredLocale)

Returns a String name, suitable for presentation to users, which represents the best-fit name for the specified locale.

Returns:

a String name, suitable for presentation to users, which represents the best-fit name for the specified locale.

Throws:

MissingResourceException - if a codebase URL is found to be unusable. (Because URLString enforces well-formedness of all URLs used by this method, this exception probably indicates the protocol was unknown.), or if a ResourceBundle is not found at the expected codebase

purge

public void purge()

Purge away information about undesired locales. If no cache exists, this method first fills the cache based on the default locale. If a cache currently exists, that cache will be left intact. Once a cache is in place, this method will clear the resource bundle loader.

Overrides:

purge in class LocalizableInfo

purge

public void purge(java.util.Locale preserveLocale)

Purge away information about all locales except the passed locale. This method first makes sure the cache is appropriate to the passed desired locale. Once the cache is in place, this method will clear the resource bundle loader.

Overrides:

purge in class LocalizableInfo

Parameters:

preserveLocale - a locale to preserve in this Name.

equals

public boolean equals(java.lang.Object o)

Compares this Name to the passed object for equality. To be semantically equal, the class of the passed object must be Name, the passed object's cached name must be semantically equal to this object's cached name, the passed object's name key must be semantically to this object's name key, and the equals method of Name's superclass must return true.

Overrides:

equals in class LocalizableInfo

Parameters:

An - object to compare to this Name

Returns:

true if this Name is semantically equal to the passed Name

hashCode

public int hashCode()

Returns a hash code for this object.

Overrides:

hashCode in class LocalizableInfo

Returns:

the hash code

clone

public java.lang.Object clone()

Clones this Name.

Overrides:

clone in class LocalizableInfo

Returns:

a clone of this object