com.artima.place.info
Class Description

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

All Implemented Interfaces:

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

public class Description

extends LocalizableInfo

A localizable description.

See Also:

Serialized Form

Constructor Summary

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

Description(ResourceBundleLoader loader, java.lang.String descriptionKey)
Constructs a new Description with passed resource bundle loader, description key, and no cached description.

Description(ResourceBundleLoader loader, java.lang.String descriptionKey, java.util.Locale cachedLocale, java.lang.String cachedDescription)
Constructs a new Description with passed resource bundle loader, description key, and cached description (for the passed locale).

Method Summary

java.lang.Object	clone() Clones this Name.
boolean	equals(java.lang.Object o) Compares this Description to the passed object for equality.
java.lang.String	getDescription() Returns a String description, suitable for presentation to users, appropriate to the default locale.
java.lang.String	getDescription(java.util.Locale desiredLocale) Returns a String description, suitable for presentation to users, which represents the best-fit description 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

Description

public Description(ResourceBundleLoader loader,
                   java.lang.String descriptionKey)

Constructs a new Description with passed resource bundle loader, description key, and no cached description.

Parameters:

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

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

Description

public Description(ResourceBundleLoader loader,
                   java.lang.String descriptionKey,
                   java.util.Locale cachedLocale,
                   java.lang.String cachedDescription)

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

Parameters:

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

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

cachedLocale - the Locale of the description passed as cachedDescription.

cachedDescription - the description whose locale is passed as cachedLocale that should be cached by this Description.

Description

public Description(java.util.Locale cachedLocale,
                   java.lang.String cachedDescription)

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

Parameters:

cachedLocale - the Locale of the description passed as cachedDescription.

cachedDescription - the description, whose locale is passed as cachedLocale that should be cached by this Description.

Method Detail

getDescription

public java.lang.String getDescription()

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

Returns:

a String description, 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

getDescription

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

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

Parameters:

desiredLocale - the locale for which an appropriate description is desired.

Returns:

a String description, suitable for presentation to users, appropriate to the passed desired 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 Description.

equals

public boolean equals(java.lang.Object o)

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

Overrides:

equals in class LocalizableInfo

Parameters:

An - object to compare to this Description

Returns:

true if this Description is semantically equal to the passed Description

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