001: /*
002: * The Apache Software License, Version 1.1
003: *
004: *
005: * Copyright (c) 1999-2002 The Apache Software Foundation. All rights
006: * reserved.
007: *
008: * Redistribution and use in source and binary forms, with or without
009: * modification, are permitted provided that the following conditions
010: * are met:
011: *
012: * 1. Redistributions of source code must retain the above copyright
013: * notice, this list of conditions and the following disclaimer.
014: *
015: * 2. Redistributions in binary form must reproduce the above copyright
016: * notice, this list of conditions and the following disclaimer in
017: * the documentation and/or other materials provided with the
018: * distribution.
019: *
020: * 3. The end-user documentation included with the redistribution,
021: * if any, must include the following acknowledgment:
022: * "This product includes software developed by the
023: * Apache Software Foundation (http://www.apache.org/)."
024: * Alternately, this acknowledgment may appear in the software itself,
025: * if and wherever such third-party acknowledgments normally appear.
026: *
027: * 4. The names "Xerces" and "Apache Software Foundation" must
028: * not be used to endorse or promote products derived from this
029: * software without prior written permission. For written
030: * permission, please contact apache@apache.org.
031: *
032: * 5. Products derived from this software may not be called "Apache",
033: * nor may "Apache" appear in their name, without prior written
034: * permission of the Apache Software Foundation.
035: *
036: * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
037: * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
038: * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
039: * DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
040: * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
041: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
042: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
043: * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
044: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
045: * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
046: * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
047: * SUCH DAMAGE.
048: * ====================================================================
049: *
050: * This software consists of voluntary contributions made by many
051: * individuals on behalf of the Apache Software Foundation and was
052: * originally based on software copyright (c) 1999, International
053: * Business Machines, Inc., http://www.apache.org. For more
054: * information on the Apache Software Foundation, please see
055: * <http://www.apache.org/>.
056: */
057:
058: package com.sun.xml.stream.xerces.impl.msg;
059:
060: import java.util.Locale;
061: import java.util.MissingResourceException;
062: import java.util.ResourceBundle;
063: import java.util.PropertyResourceBundle;
064:
065: import com.sun.xml.stream.xerces.util.MessageFormatter;
066:
067: /**
068: * XMLMessageFormatter provides error messages for the XML 1.0 Recommendation and for
069: * the Namespaces Recommendation
070: *
071: * @author Eric Ye, IBM
072: * @version $Id: XMLMessageFormatter.java,v 1.2 2006/04/01 06:01:45 jeffsuttor Exp $
073: *
074: */
075: public class XMLMessageFormatter implements MessageFormatter {
076: /**
077: * The domain of messages concerning the XML 1.0 specification.
078: */
079: public static final String XML_DOMAIN = "http://www.w3.org/TR/1998/REC-xml-19980210";
080: public static final String XMLNS_DOMAIN = "http://www.w3.org/TR/1999/REC-xml-names-19990114";
081:
082: // private objects to cache the locale and resource bundle
083: private Locale fLocale = null;
084: private ResourceBundle fResourceBundle = null;
085:
086: //
087: // MessageFormatter methods
088: //
089:
090: /**
091: * Formats a message with the specified arguments using the given
092: * locale information.
093: *
094: * @param locale The locale of the message.
095: * @param key The message key.
096: * @param arguments The message replacement text arguments. The order
097: * of the arguments must match that of the placeholders
098: * in the actual message.
099: *
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 formatMessage(Locale locale, String key,
106: Object[] arguments) throws MissingResourceException {
107:
108: if (fResourceBundle == null || locale != fLocale) {
109: if (locale != null) {
110: fResourceBundle = PropertyResourceBundle
111: .getBundle(
112: "com.sun.xml.stream.xerces.impl.msg.XMLMessages",
113: locale);
114: // memorize the most-recent locale
115: fLocale = locale;
116: }
117: if (fResourceBundle == null)
118: fResourceBundle = PropertyResourceBundle
119: .getBundle("com.sun.xml.stream.xerces.impl.msg.XMLMessages");
120: }
121:
122: // format message
123: String msg;
124: try {
125: msg = fResourceBundle.getString(key);
126: if (arguments != null) {
127: try {
128: msg = java.text.MessageFormat
129: .format(msg, arguments);
130: } catch (Exception e) {
131: msg = fResourceBundle.getString("FormatFailed");
132: msg += " " + fResourceBundle.getString(key);
133: }
134: }
135: }
136:
137: // error
138: catch (MissingResourceException e) {
139: msg = fResourceBundle.getString("BadMessageKey");
140: throw new MissingResourceException(key, msg, key);
141: }
142:
143: // no message
144: if (msg == null) {
145: msg = key;
146: if (arguments.length > 0) {
147: StringBuffer str = new StringBuffer(msg);
148: str.append('?');
149: for (int i = 0; i < arguments.length; i++) {
150: if (i > 0) {
151: str.append('&');
152: }
153: str.append(String.valueOf(arguments[i]));
154: }
155: }
156: }
157:
158: return msg;
159: }
160:
161: }
|