The message manager assumes that the locale remains constant for
* the duration of its operation. If the locale were to change during the
* operation of the client, a call to {@link #setLocale} should be made to
* inform the message manager of the new locale (which will clear the
* message bundle cache).
*/
public class MessageManager
{
/** The name of the global resource bundle (which other bundles revert
* to if they can't locate a message within themselves). It must be
* named global.properties and live at the top of the
* bundle hierarchy. */
public static const GLOBAL_BUNDLE :String = "global";
/**
* Constructs a message manager with the supplied resource prefix and
* the default locale. The prefix will be prepended to the path of all
* resource bundles prior to their resolution. For example, if a
* prefix of rsrc.messages was provided and a message
* bundle with the name game.chess was later requested,
* the message manager would attempt to load a resource bundle with
* the path rsrc.messages.game.chess and would eventually
* search for a file in the classpath with the path
* rsrc/messages/game/chess.properties.
*
*
See the documentation for {@link * ResourceBundle#getBundle(String,Locale,ClassLoader)} for a more * detailed explanation of how resource bundle paths are resolved. */ public function MessageManager () { // // use the default locale // _locale = Locale.getCurrent(sysMgr); // load up the global bundle _global = getBundle(GLOBAL_BUNDLE); } // /** // * Get the locale that is being used to translate messages. // * This may be useful if using standard translations, for example // * new SimpleDateFormat("EEEE", getLocale()) to get the name of a weekday // * that matches the language being used for all other client translations. // */ // public function getLocale () :Locale // { // return _locale; // } // // /** // * Sets the locale to the specified locale. Subsequent message bundles // * fetched via the message manager will use the new locale. The // * message bundle cache will also be cleared. // */ // public function setLocale (locale :Locale) :void // { // _locale = locale; // _cache.clear(); // } /** * Fetches the message bundle for the specified path. If no bundle can * be located with the specified path, a special bundle is returned * that returns the untranslated message identifiers instead of an * associated translation. This is done so that error code to handle a * failed bundle load need not be replicated wherever bundles are * used. Instead an error will be logged and the requesting service * can continue to function in an impaired state. */ public function getBundle (path :String) :MessageBundle { // first look in the cache var bundle :MessageBundle = (_cache.get(path) as MessageBundle); if (bundle != null) { return bundle; } // if it's not cached, we'll need to resolve it var rbundle :ResourceBundle = null; try { rbundle = ResourceBundle.getResourceBundle(path); } catch (mre :Error) { Log.getLog(this).warning("Unable to resolve resource bundle " + "[path=" + path + "]."); } // if the resource bundle contains a special resource, we'll // interpret that as a derivation of MessageBundle to instantiate // for handling that class if (rbundle != null) { var mbclass :String = null; try { mbclass = rbundle.getString(MBUNDLE_CLASS_KEY); if (!StringUtil.isBlank(mbclass)) { try { var clazz :Class = ClassUtil.getClassByName(mbclass); bundle = new clazz(); } catch (ee :Error) { Log.getLog(this).warning( "Failure instantiating custom message bundle " + "[mbclass=" + mbclass + ", error=" + ee + "]."); } } } catch (eee :Error) { // nada } } // if there was no custom class, or we failed to instantiate the // custom class, use a standard message bundle if (bundle == null) { bundle = new MessageBundle(); } // initialize our message bundle, cache it and return it (if we // couldn't resolve the bundle, the message bundle will cope with // it's null resource bundle) bundle.init(this, path, rbundle, _global); _cache.put(path, bundle); return bundle; } // /** The locale for which we're obtaining message bundles. */ // protected var _locale :Locale; /** A cache of instantiated message bundles. */ protected var _cache :HashMap = new HashMap(); /** Our top-level message bundle, from which others obtain messages if * they can't find them within themselves. */ protected var _global :MessageBundle; /** A key that can contain the classname of a custom message bundle * class to be used to handle messages for a particular bundle. */ protected static const MBUNDLE_CLASS_KEY :String = "msgbundle_class"; } }