org.blojsom.util.resources
Class ResourceBundleResourceManager

java.lang.Object
  extended byorg.blojsom.util.resources.ResourceBundleResourceManager
All Implemented Interfaces:
BlojsomConstants, ResourceManager

public class ResourceBundleResourceManager
extends java.lang.Object
implements BlojsomConstants, ResourceManager

ResourceBundleResourceManager

Since:
blojsom 2.13
Version:
$Id: ResourceBundleResourceManager.java,v 1.6 2006/01/04 16:59:55 czarneckid Exp $
Author:
David Czarnecki

Field Summary
 
Fields inherited from interface org.blojsom.util.BlojsomConstants
ADMINISTRATORS_IP, BLOG_ADMIN_URL_IP, BLOG_ADMINISTRATION_LOCALE_IP, BLOG_AUTHORIZATION_IP, BLOG_BASE_URL_IP, BLOG_BLACKLIST_FILE_IP, BLOG_COMMENTS_DIRECTORY_IP, BLOG_COMMENTS_ENABLED_IP, BLOG_COUNTRY_DEFAULT, BLOG_COUNTRY_IP, BLOG_DEFAULT_CATEGORY_EXCLUSION_MAPPING_IP, BLOG_DEFAULT_CATEGORY_MAPPING_IP, BLOG_DEFAULT_FETCHER, BLOG_DEFAULT_FILE_EXTENSION_IP, BLOG_DEFAULT_FLAVOR_IP, BLOG_DEFAULT_PROPERTIES, BLOG_DEPTH_IP, BLOG_DESCRIPTION_IP, BLOG_DIRECTORY_FILTER_IP, BLOG_EMAIL_ENABLED_IP, BLOG_ENTRIES_DISPLAY_DEFAULT, BLOG_ENTRIES_DISPLAY_IP, BLOG_ENTRY_META_DATA_EXTENSION_IP, BLOG_FILE_ENCODING_IP, BLOG_FILE_EXTENSIONS_IP, BLOG_HOME_IP, BLOG_LANGUAGE_DEFAULT, BLOG_LANGUAGE_IP, BLOG_NAME_IP, BLOG_OWNER, BLOG_OWNER_EMAIL, BLOG_PERMISSIONS_IP, BLOG_PINGBACKS_DIRECTORY_IP, BLOG_PINGBACKS_ENABLED_IP, BLOG_PROPERTIES_EXTENSIONS_IP, BLOG_TRACKBACK_DIRECTORY_IP, BLOG_TRACKBACKS_ENABLED_IP, BLOG_URL_IP, BLOJSOM_ALL_CATEGORIES, BLOJSOM_AUTHORIZATION_PROVIDER_IP, BLOJSOM_BLOG, BLOJSOM_BLOG_HOME_IP, BLOJSOM_BROADCASTER_IP, BLOJSOM_CATEGORIES, BLOJSOM_COMMENTS_ENABLED, BLOJSOM_CONFIGURATION_BASE_DIRECTORY_IP, BLOJSOM_CONFIGURATION_IP, BLOJSOM_DATE, BLOJSOM_DATE_ISO8601, BLOJSOM_DATE_OBJECT, BLOJSOM_DATE_UTC, BLOJSOM_DEFAULT_BROADCASTER, BLOJSOM_DEFAULT_CONFIGURATION_BASE_DIRECTORY, BLOJSOM_DEFAULT_RESOURCE_DIRECTORY, BLOJSOM_DEFAULT_RESOURCE_MANAGER, BLOJSOM_DEFAULT_TEMPLATES_DIRECTORY, BLOJSOM_DEFAULT_USER_IP, BLOJSOM_EMAIL_ENABLED, BLOJSOM_ENTRIES, BLOJSOM_FETCHER_IP, BLOJSOM_FLAVOR_CONFIGURATION_IP, BLOJSOM_INSTALLATION_DIRECTORY_IP, BLOJSOM_INSTALLED_LOCALES_IP, BLOJSOM_LAST_MODIFIED, BLOJSOM_LISTENER_CONFIGURATION_IP, BLOJSOM_PERMALINK, BLOJSOM_PERMALINK_NEXT_ENTRY, BLOJSOM_PERMALINK_PREVIOUS_ENTRY, BLOJSOM_PLUGIN_CHAIN, BLOJSOM_PLUGIN_CONFIGURATION_IP, BLOJSOM_PLUGINS, BLOJSOM_REQUESTED_CATEGORY, BLOJSOM_REQUESTED_FLAVOR, BLOJSOM_RESOURCE_DIRECTORY_IP, BLOJSOM_RESOURCE_MANAGER_BUNDLES_IP, BLOJSOM_RESOURCE_MANAGER_CONTEXT_KEY, BLOJSOM_RESOURCE_MANAGER_IP, BLOJSOM_SITE_URL, BLOJSOM_TEMPLATES_DIRECTORY_IP, BLOJSOM_USER, BLOJSOM_USERS_IP, BLOJSOM_VERSION, BLOJSOM_VERSION_NUMBER, CACHE_CONTROL_HTTP_HEADER, CATEGORY_PARAM, COMMENT_EXTENSION, DEFAULT_AUTHORIZATION_PROVIDER, DEFAULT_COMMENTS_DIRECTORY, DEFAULT_DIGEST_ALGORITHM, DEFAULT_DISPATCHER_CONFIGURATION_FILE, DEFAULT_ENTRY_EXTENSION, DEFAULT_FLAVOR_CONFIGURATION_FILE, DEFAULT_FLAVOR_HTML, DEFAULT_METADATA_EXTENSION, DEFAULT_PERMISSIONS_CONFIGURATION_FILE, DEFAULT_PINGBACKS_DIRECTORY, DEFAULT_PLUGIN_CONFIGURATION_FILE, DEFAULT_PROPERTIES_EXTENSIONS, DEFAULT_TRACKBACK_DIRECTORY, DESCRIPTION_KEY, DIGEST_ALGORITHM, FLAVOR_PARAM, HTTP_ETAG, HTTP_LASTMODIFIED, INFINITE_BLOG_DEPTH, ISO_8601_DATE_FORMAT, LINE_SEPARATOR, LINEAR_NAVIGATION_ENABLED_IP, MAX_HASHABLE_LENGTH, NAME_KEY, NO_CACHE_HTTP_HEADER_VALUE, OVERRIDE_LASTMODIFIED_PARAM, PAGE_PARAM, PAGE_PARAM_ARCHIVE, PERMALINK_PARAM, PINGBACK_EXTENSION, PLUGINS_PARAM, PRAGMA_HTTP_HEADER, PREFERRED_SYNDICATION_FLAVOR, RECURSIVE_CATEGORIES, REDIRECT_TO_PARAM, RFC_822_DATE_FORMAT, SHORT_ISO_8601_DATE_FORMAT, TRACKBACK_EXTENSION, USE_ENCRYPTED_PASSWORDS, UTC_DATE_FORMAT, UTF8, WHITESPACE, XMLRPC_ENABLED_IP
 
Constructor Summary
ResourceBundleResourceManager()
          Default constructor;
 
Method Summary
 java.lang.String format(java.lang.String pattern, java.lang.Object[] arguments)
          Wrapper for MessageFormat.format(String, Object[])
 java.lang.String getString(java.lang.String resourceID, java.lang.String resource, java.lang.String fallback)
          Retrieve a string from a given resource bundle for the default locale.
 java.lang.String getString(java.lang.String resourceID, java.lang.String resource, java.lang.String fallback, java.util.Locale locale)
          Retrieve a string from a given resource bundle for the particular language and country locale.
 java.lang.String getString(java.lang.String resourceID, java.lang.String resource, java.lang.String fallback, java.lang.String language)
          Retrieve a string from a given resource bundle for the particular language and country locale.
 java.lang.String getString(java.lang.String resourceID, java.lang.String resource, java.lang.String fallback, java.lang.String language, java.lang.String country)
          Retrieve a string from a given resource bundle for the particular language and country locale.
 void init(BlojsomConfiguration blojsomConfiguration)
          Initialize the resource bundle manager.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ResourceBundleResourceManager

public ResourceBundleResourceManager()
Default constructor;

Method Detail

init

public void init(BlojsomConfiguration blojsomConfiguration)
          throws BlojsomException
Initialize the resource bundle manager.

Resource bundles to pre-load are specified in a comma-separated list under the key blojsom-resource-manager-bundles.

Specified by:
init in interface ResourceManager
Parameters:
blojsomConfiguration - Blojsom configuration information
Throws:
BlojsomException

getString

public java.lang.String getString(java.lang.String resourceID,
                                  java.lang.String resource,
                                  java.lang.String fallback)
Retrieve a string from a given resource bundle for the default locale.

Specified by:
getString in interface ResourceManager
Parameters:
resourceID - Resource ID to retrieve from the resource bundle
resource - Full-qualified resource bundle from which to retrieve the resource ID
fallback - Fallback string to use if the given resource ID cannot be found
Returns:
resourceID from resource bundle resource or fallback if the given resource ID cannot be found

getString

public java.lang.String getString(java.lang.String resourceID,
                                  java.lang.String resource,
                                  java.lang.String fallback,
                                  java.lang.String language)
Retrieve a string from a given resource bundle for the particular language and country locale.

Specified by:
getString in interface ResourceManager
Parameters:
resourceID - Resource ID to retrieve from the resource bundle
resource - Full-qualified resource bundle from which to retrieve the resource ID
fallback - Fallback string to use if the given resource ID cannot be found
language - Language code
Returns:
resourceID from resource bundle resource or fallback if the given resource ID cannot be found

getString

public java.lang.String getString(java.lang.String resourceID,
                                  java.lang.String resource,
                                  java.lang.String fallback,
                                  java.lang.String language,
                                  java.lang.String country)
Retrieve a string from a given resource bundle for the particular language and country locale.

Specified by:
getString in interface ResourceManager
Parameters:
resourceID - Resource ID to retrieve from the resource bundle
resource - Full-qualified resource bundle from which to retrieve the resource ID
fallback - Fallback string to use if the given resource ID cannot be found
language - Language code
country - Country code
Returns:
resourceID from resource bundle resource or fallback if the given resource ID cannot be found

getString

public java.lang.String getString(java.lang.String resourceID,
                                  java.lang.String resource,
                                  java.lang.String fallback,
                                  java.util.Locale locale)
Retrieve a string from a given resource bundle for the particular language and country locale.

Specified by:
getString in interface ResourceManager
Parameters:
resourceID - Resource ID to retrieve from the resource bundle
resource - Full-qualified resource bundle from which to retrieve the resource ID
fallback - Fallback string to use if the given resource ID cannot be found
locale - Locale object to use when retrieving the resource bundle
Returns:
resourceID from resource bundle resource or fallback if the given resource ID cannot be found

format

public java.lang.String format(java.lang.String pattern,
                               java.lang.Object[] arguments)
Wrapper for MessageFormat.format(String, Object[])

Specified by:
format in interface ResourceManager
Parameters:
pattern - Pattern
arguments - Arguments to apply to pattern
Returns:
String where MessageFormat.format(String, Object[]) has been applied or null if there is an error applying the arguments to the pattern
Since:
blojsom 2.21