KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > xerces > internal > impl > msg > XMLMessageFormatter


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 1999-2002 The Apache Software Foundation. All rights
6  * reserved.
7  *
8  * Redistribution and use in source and binary forms, with or without
9  * modification, are permitted provided that the following conditions
10  * are met:
11  *
12  * 1. Redistributions of source code must retain the above copyright
13  * notice, this list of conditions and the following disclaimer.
14  *
15  * 2. Redistributions in binary form must reproduce the above copyright
16  * notice, this list of conditions and the following disclaimer in
17  * the documentation and/or other materials provided with the
18  * distribution.
19  *
20  * 3. The end-user documentation included with the redistribution,
21  * if any, must include the following acknowledgment:
22  * "This product includes software developed by the
23  * Apache Software Foundation (http://www.apache.org/)."
24  * Alternately, this acknowledgment may appear in the software itself,
25  * if and wherever such third-party acknowledgments normally appear.
26  *
27  * 4. The names "Xerces" and "Apache Software Foundation" must
28  * not be used to endorse or promote products derived from this
29  * software without prior written permission. For written
30  * permission, please contact apache@apache.org.
31  *
32  * 5. Products derived from this software may not be called "Apache",
33  * nor may "Apache" appear in their name, without prior written
34  * permission of the Apache Software Foundation.
35  *
36  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39  * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
40  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47  * SUCH DAMAGE.
48  * ====================================================================
49  *
50  * This software consists of voluntary contributions made by many
51  * individuals on behalf of the Apache Software Foundation and was
52  * originally based on software copyright (c) 1999, International
53  * Business Machines, Inc., http://www.apache.org. For more
54  * information on the Apache Software Foundation, please see
55  * <http://www.apache.org/>.
56  */
57
58 package com.sun.org.apache.xerces.internal.impl.msg;
59
60 import java.util.Locale JavaDoc;
61 import java.util.MissingResourceException JavaDoc;
62 import java.util.ResourceBundle JavaDoc;
63 import java.util.PropertyResourceBundle JavaDoc;
64
65 import com.sun.org.apache.xerces.internal.util.MessageFormatter;
66
67 /**
68  * XMLMessageFormatter provides error messages for the XML 1.0 Recommendation and for
69  * the Namespaces Recommendation
70  *
71  * @author Eric Ye, IBM
72  * @version $Id: XMLMessageFormatter.java,v 1.4 2002/01/29 01:15:13 lehors Exp $
73  *
74  */
75 public class XMLMessageFormatter implements MessageFormatter {
76     /**
77      * The domain of messages concerning the XML 1.0 specification.
78      */
79     public static final String JavaDoc XML_DOMAIN = "http://www.w3.org/TR/1998/REC-xml-19980210";
80     public static final String JavaDoc XMLNS_DOMAIN = "http://www.w3.org/TR/1999/REC-xml-names-19990114";
81
82     // private objects to cache the locale and resource bundle
83 private Locale JavaDoc fLocale = null;
84     private ResourceBundle JavaDoc fResourceBundle = null;
85     
86     //
87 // MessageFormatter methods
88 //
89
90     /**
91      * Formats a message with the specified arguments using the given
92      * locale information.
93      *
94      * @param locale The locale of the message.
95      * @param key The message key.
96      * @param arguments The message replacement text arguments. The order
97      * of the arguments must match that of the placeholders
98      * in the actual message.
99      *
100      * @return Returns the formatted message.
101      *
102      * @throws MissingResourceException Thrown if the message with the
103      * specified key cannot be found.
104      */
105     public String JavaDoc formatMessage(Locale JavaDoc locale, String JavaDoc key, Object JavaDoc[] arguments)
106         throws MissingResourceException JavaDoc {
107         
108         if (fResourceBundle == null || locale != fLocale) {
109             if (locale != null) {
110                 fResourceBundle = PropertyResourceBundle.getBundle("com.sun.org.apache.xerces.internal.impl.msg.XMLMessages", locale);
111                 // memorize the most-recent locale
112 fLocale = locale;
113             }
114             if (fResourceBundle == null)
115                 fResourceBundle = PropertyResourceBundle.getBundle("com.sun.org.apache.xerces.internal.impl.msg.XMLMessages");
116         }
117         
118         // format message
119 String JavaDoc msg;
120         try {
121             msg = fResourceBundle.getString(key);
122             if (arguments != null) {
123                 try {
124                     msg = java.text.MessageFormat.format(msg, arguments);
125                 }
126                 catch (Exception JavaDoc e) {
127                     msg = fResourceBundle.getString("FormatFailed");
128                     msg += " " + fResourceBundle.getString(key);
129                 }
130             }
131         }
132
133         // error
134 catch (MissingResourceException JavaDoc e) {
135             msg = fResourceBundle.getString("BadMessageKey");
136             throw new MissingResourceException JavaDoc(key, msg, key);
137         }
138
139         // no message
140 if (msg == null) {
141             msg = key;
142             if (arguments.length > 0) {
143                 StringBuffer JavaDoc str = new StringBuffer JavaDoc(msg);
144                 str.append('?');
145                 for (int i = 0; i < arguments.length; i++) {
146                     if (i > 0) {
147                         str.append('&');
148                     }
149                     str.append(String.valueOf(arguments[i]));
150                 }
151             }
152         }
153
154         return msg;
155     }
156
157 }
158
Popular Tags