KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > sun > org > apache > xerces > internal > xinclude > XIncludeMessageFormatter


1 /*
2  * The Apache Software License, Version 1.1
3  *
4  *
5  * Copyright (c) 2001-2004 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) 2003, 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.xinclude;
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 import com.sun.org.apache.xerces.internal.util.MessageFormatter;
65
66 // TODO: fix error messages in XIncludeMessages.properties
67 /**
68  * XIncludeMessageFormatter provides error messages for the XInclude 1.0 Candidate Recommendation
69  *
70  * @author Peter McCracken, IBM
71  *
72  * @version $Id: XIncludeMessageFormatter.java,v 1.3 2004/01/22 16:08:58 mrglavas Exp $
73  */
74 public class XIncludeMessageFormatter implements MessageFormatter {
75     
76     public static final String JavaDoc XINCLUDE_DOMAIN = "http://www.w3.org/TR/xinclude";
77     
78      // private objects to cache the locale and resource bundle
79 private Locale JavaDoc fLocale = null;
80     private ResourceBundle JavaDoc fResourceBundle = null;
81
82     /**
83      * Formats a message with the specified arguments using the given
84      * locale information.
85      *
86      * @param locale The locale of the message.
87      * @param key The message key.
88      * @param arguments The message replacement text arguments. The order
89      * of the arguments must match that of the placeholders
90      * in the actual message.
91      *
92      * @return Returns the formatted message.
93      *
94      * @throws MissingResourceException Thrown if the message with the
95      * specified key cannot be found.
96      */
97      public String JavaDoc formatMessage(Locale JavaDoc locale, String JavaDoc key, Object JavaDoc[] arguments)
98         throws MissingResourceException JavaDoc {
99         
100         if (fResourceBundle == null || locale != fLocale) {
101             if (locale != null) {
102                 fResourceBundle = PropertyResourceBundle.getBundle("com.sun.org.apache.xerces.internal.impl.msg.XIncludeMessages", locale);
103                 // memorize the most-recent locale
104 fLocale = locale;
105             }
106             if (fResourceBundle == null)
107                 fResourceBundle = PropertyResourceBundle.getBundle("com.sun.org.apache.xerces.internal.impl.msg.XIncludeMessages");
108         }
109         
110         String JavaDoc msg = fResourceBundle.getString(key);
111         if (arguments != null) {
112             try {
113                 msg = java.text.MessageFormat.format(msg, arguments);
114             } catch (Exception JavaDoc e) {
115                 msg = fResourceBundle.getString("FormatFailed");
116                 msg += " " + fResourceBundle.getString(key);
117             }
118         }
119
120         if (msg == null) {
121             msg = fResourceBundle.getString("BadMessageKey");
122             throw new MissingResourceException JavaDoc(msg, "com.sun.org.apache.xerces.internal.impl.msg.XIncludeMessages", key);
123         }
124
125         return msg;
126     }
127 }
128
129
Popular Tags