messageresources.java.svn-base

MVC开源框架

    public String getMessage(String key, Object arg0, Object arg1, Object arg2,
        Object arg3) {
        return this.getMessage((Locale) null, key, arg0, arg1, arg2, arg3);
    }

    /**
     * Returns a text message for the specified key, for the default Locale. A
     * null string result will be returned by this method if no relevant
     * message resource is found for this key or Locale, if the
     * <code>returnNull</code> property is set.  Otherwise, an appropriate
     * error message will be returned. <p> This method must be implemented by
     * a concrete subclass.
     *
     * @param locale The requested message Locale, or <code>null</code> for
     *               the system default Locale
     * @param key    The message key to look up
     */
    public abstract String getMessage(Locale locale, String key);

    /**
     * Returns a text message after parametric replacement of the specified
     * parameter placeholders.  A null string result will be returned by this
     * method if no resource bundle has been configured.
     *
     * @param locale The requested message Locale, or <code>null</code> for
     *               the system default Locale
     * @param key    The message key to look up
     * @param args   An array of replacement parameters for placeholders
     */
    public String getMessage(Locale locale, String key, Object[] args) {
        // Cache MessageFormat instances as they are accessed
        if (locale == null) {
            locale = defaultLocale;
        }

        MessageFormat format = null;
        String formatKey = messageKey(locale, key);

        synchronized (formats) {
            format = (MessageFormat) formats.get(formatKey);

            if (format == null) {
                String formatString = getMessage(locale, key);

                if (formatString == null) {
                    return returnNull ? null : ("???" + formatKey + "???");
                }

                format = new MessageFormat(escape(formatString));
                format.setLocale(locale);
                formats.put(formatKey, format);
            }
        }

        return format.format(args);
    }

    /**
     * Returns a text message after parametric replacement of the specified
     * parameter placeholders.  A null string result will never be returned by
     * this method.
     *
     * @param locale The requested message Locale, or <code>null</code> for
     *               the system default Locale
     * @param key    The message key to look up
     * @param arg0   The replacement for placeholder {0} in the message
     */
    public String getMessage(Locale locale, String key, Object arg0) {
        return this.getMessage(locale, key, new Object[] { arg0 });
    }

    /**
     * Returns a text message after parametric replacement of the specified
     * parameter placeholders.  A null string result will never be returned by
     * this method.
     *
     * @param locale The requested message Locale, or <code>null</code> for
     *               the system default Locale
     * @param key    The message key to look up
     * @param arg0   The replacement for placeholder {0} in the message
     * @param arg1   The replacement for placeholder {1} in the message
     */
    public String getMessage(Locale locale, String key, Object arg0, Object arg1) {
        return this.getMessage(locale, key, new Object[] { arg0, arg1 });
    }

    /**
     * Returns a text message after parametric replacement of the specified
     * parameter placeholders.  A null string result will never be returned by
     * this method.
     *
     * @param locale The requested message Locale, or <code>null</code> for
     *               the system default Locale
     * @param key    The message key to look up
     * @param arg0   The replacement for placeholder {0} in the message
     * @param arg1   The replacement for placeholder {1} in the message
     * @param arg2   The replacement for placeholder {2} in the message
     */
    public String getMessage(Locale locale, String key, Object arg0,
        Object arg1, Object arg2) {
        return this.getMessage(locale, key, new Object[] { arg0, arg1, arg2 });
    }

    /**
     * Returns a text message after parametric replacement of the specified
     * parameter placeholders.  A null string result will never be returned by
     * this method.
     *
     * @param locale The requested message Locale, or <code>null</code> for
     *               the system default Locale
     * @param key    The message key to look up
     * @param arg0   The replacement for placeholder {0} in the message
     * @param arg1   The replacement for placeholder {1} in the message
     * @param arg2   The replacement for placeholder {2} in the message
     * @param arg3   The replacement for placeholder {3} in the message
     */
    public String getMessage(Locale locale, String key, Object arg0,
        Object arg1, Object arg2, Object arg3) {
        return this.getMessage(locale, key,
            new Object[] { arg0, arg1, arg2, arg3 });
    }

    /**
     * Return <code>true</code> if there is a defined message for the
     * specified key in the system default locale.
     *
     * @param key The message key to look up
     */
    public boolean isPresent(String key) {
        return this.isPresent(null, key);
    }

    /**
     * Return <code>true</code> if there is a defined message for the
     * specified key in the specified Locale.
     *
     * @param locale The requested message Locale, or <code>null</code> for
     *               the system default Locale
     * @param key    The message key to look up
     */
    public boolean isPresent(Locale locale, String key) {
        String message = getMessage(locale, key);

        if (message == null) {
            return false;
        } else if (message.startsWith("???") && message.endsWith("???")) {
            return false; // FIXME - Only valid for default implementation
        } else {
            return true;
        }
    }

    // ------------------------------------------------------ Protected Methods

    /**
     * Escape any single quote characters that are included in the specified
     * message string.
     *
     * @param string The string to be escaped
     */
    protected String escape(String string) {
        if (!isEscape()) {
            return string;
        }

        if ((string == null) || (string.indexOf('\'') < 0)) {
            return string;
        }

        int n = string.length();
        StringBuffer sb = new StringBuffer(n);

        for (int i = 0; i < n; i++) {
            char ch = string.charAt(i);

            if (ch == '\'') {
                sb.append('\'');
            }

            sb.append(ch);
        }

        return sb.toString();
    }

    /**
     * Compute and return a key to be used in caching information by a Locale.
     * <strong>NOTE</strong> - The locale key for the default Locale in our
     * environment is a zero length String.
     *
     * @param locale The locale for which a key is desired
     */
    protected String localeKey(Locale locale) {
        return (locale == null) ? "" : locale.toString();
    }

    /**
     * Compute and return a key to be used in caching information by Locale
     * and message key.
     *
     * @param locale The Locale for which this format key is calculated
     * @param key    The message key for which this format key is calculated
     */
    protected String messageKey(Locale locale, String key) {
        return (localeKey(locale) + "." + key);
    }

    /**
     * Compute and return a key to be used in caching information by locale
     * key and message key.
     *
     * @param localeKey The locale key for which this cache key is calculated
     * @param key       The message key for which this cache key is
     *                  calculated
     */
    protected String messageKey(String localeKey, String key) {
        return (localeKey + "." + key);
    }

    /**
     * Create and return an instance of <code>MessageResources</code> for the
     * created by the default <code>MessageResourcesFactory</code>.
     *
     * @param config Configuration parameter for this message bundle.
     */
    public synchronized static MessageResources getMessageResources(
        String config) {
        if (defaultFactory == null) {
            defaultFactory = MessageResourcesFactory.createFactory();
        }

        return defaultFactory.createResources(config);
    }

    /**
     * Log a message to the Writer that has been configured for our use.
     *
     * @param message The message to be logged
     */
    public void log(String message) {
        log.debug(message);
    }

    /**
     * Log a message and exception to the Writer that has been configured for
     * our use.
     *
     * @param message   The message to be logged
     * @param throwable The exception to be logged
     */
    public void log(String message, Throwable throwable) {
        log.debug(message, throwable);
    }
}