summaryrefslogtreecommitdiffstats
path: root/pki/base/common/src/com/netscape/certsrv/base/MessageFormatter.java
blob: 16324fb91add878e3c0309fbed21ab7b6a800346 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
// --- BEGIN COPYRIGHT BLOCK ---
// This program is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; version 2 of the License.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
//
// (C) 2007 Red Hat, Inc.
// All rights reserved.
// --- END COPYRIGHT BLOCK ---
package com.netscape.certsrv.base;


import java.lang.reflect.Method;
import java.text.MessageFormat;
import java.util.Date;
import java.util.Locale;
import java.util.MissingResourceException;
import java.util.ResourceBundle;


/**
 * Factors out common function of formatting internatinalized 
 * messages taking arguments and using  java.util.ResourceBundle 
 * and java.text.MessageFormat mechanism.
 * <P>
 *
 * @version $Revision$, $Date$
 * @see java.text.MessageFormat
 * @see java.util.ResourceBundle
 */
public class MessageFormatter {

    private static final Class[] toStringSignature = { Locale.class };

    /**
     * Retrieves the localized string.
     *
     * @param locale end user locale
     * @param resourceBundleBaseName resource bundle class name
     * @param formatString format string
     * @return localized string
     */
    public static String getLocalizedString(
        Locale locale, String resourceBundleBaseName,
        String formatString) {
        return getLocalizedString(locale, resourceBundleBaseName, 
                formatString, null);
    }

    /**
     * Retrieves the localized string.
     *
     * @param locale end user locale
     * @param resourceBundleBaseName resource bundle class name
     * @param formatString format string
     * @param params parameters to be substituted
     * @return localized string
     */
    public static String getLocalizedString(
        Locale locale, String resourceBundleBaseName,
        String formatString, Object params) {
        Object o[] = new Object[1];

        o[0] = params;
        return getLocalizedString(locale, resourceBundleBaseName, 
                formatString, o);
    }

    /**
     * Retrieves the localized string.
     *
     * @param locale end user locale
     * @param resourceBundleBaseName resource bundle class name
     * @param formatString format string
     * @param params parameters to be substituted
     * @return localized string
     */
    public static String getLocalizedString(
        Locale locale, String resourceBundleBaseName,
        String formatString, Object[] params) {

        String localizedFormat = null;

        try {
            try {
                // if you are worried about the efficiency of the
                // following line, dont worry. ResourceBundle has
                // an internal cache. So resource bundle wont be
                // instantiated everytime you call toString().

                localizedFormat = ResourceBundle.getBundle(
                            resourceBundleBaseName, locale).getString(formatString);
            } catch (MissingResourceException e) {
                return formatString;
				
            }
            Object[] localizedParams = params;
            Object[] localeArg = null;

            if (params != null) {
                for (int i = 0; i < params.length; ++i) {
                    if (!(params[i] instanceof String) ||
                        !(params[i] instanceof Date) ||
                        !(params[i] instanceof Number)) {
                        if (localizedParams == params) {

                            // only done once
                            // NB if the following variant of cloning code is used
                            //         localizedParams = (Object [])mParams.clone();
                            // it causes ArrayStoreException in
                            //         localizedParams[i] = params[i].toString();
                            // below

                            localizedParams = new Object[params.length];
                            System.arraycopy(params, 0, localizedParams, 0,
                                params.length);
                        }
                        try {
                            Method toStringMethod = params[i].getClass().getMethod(
                                    "toString", toStringSignature);

                            if (localeArg == null) {
                                // only done once
                                localeArg = new Object[] { locale };
                            }
                            localizedParams[i] = toStringMethod.invoke(
                                        params[i], localeArg);
                        } catch (Exception e) {
                            // no method for localization, fall back
                            localizedParams[i] = params[i].toString();
                        }
                    }
                }
            }
            try {
                // XXX - runtime exception may be raised by the following function
                MessageFormat format = new MessageFormat(localizedFormat);

                return format.format(localizedParams);
            } catch (IllegalArgumentException e) {
                // XXX - for now, we just print the unformatted message
                // if the exception is raised
                return localizedFormat;
            }
        } catch (Exception e) {
            return localizedFormat;
        }
    }
}