1 /*
   2  * reserved comment block
   3  * DO NOT REMOVE OR ALTER!
   4  */
   5 /*
   6  * Licensed to the Apache Software Foundation (ASF) under one or more
   7  * contributor license agreements.  See the NOTICE file distributed with
   8  * this work for additional information regarding copyright ownership.
   9  * The ASF licenses this file to You under the Apache License, Version 2.0
  10  * (the "License"); you may not use this file except in compliance with
  11  * the License.  You may obtain a copy of the License at
  12  *
  13  *      http://www.apache.org/licenses/LICENSE-2.0
  14  *
  15  * Unless required by applicable law or agreed to in writing, software
  16  * distributed under the License is distributed on an "AS IS" BASIS,
  17  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  18  * See the License for the specific language governing permissions and
  19  * limitations under the License.
  20  */
  21 
  22 package com.sun.org.apache.xerces.internal.xinclude;
  23 
  24 import com.sun.org.apache.xerces.internal.util.MessageFormatter;
  25 import com.sun.org.apache.xerces.internal.utils.SecuritySupport;
  26 import java.util.Locale;
  27 import java.util.MissingResourceException;
  28 import java.util.ResourceBundle;
  29 
  30 // TODO: fix error messages in XIncludeMessages.properties
  31 /**
  32  * XIncludeMessageFormatter provides error messages for the XInclude 1.0 Candidate Recommendation
  33  *
  34  * @author Peter McCracken, IBM
  35  *
  36  * @version $Id: XIncludeMessageFormatter.java,v 1.7 2010-11-01 04:40:18 joehw Exp $
  37  */
  38 public class XIncludeMessageFormatter implements MessageFormatter {
  39 
  40     public static final String XINCLUDE_DOMAIN = "http://www.w3.org/TR/xinclude";
  41 
  42      // private objects to cache the locale and resource bundle
  43     private Locale fLocale = null;
  44     private ResourceBundle fResourceBundle = null;
  45 
  46     /**
  47      * Formats a message with the specified arguments using the given
  48      * locale information.
  49      *
  50      * @param locale    The locale of the message.
  51      * @param key       The message key.
  52      * @param arguments The message replacement text arguments. The order
  53      *                  of the arguments must match that of the placeholders
  54      *                  in the actual message.
  55      *
  56      * @return Returns the formatted message.
  57      *
  58      * @throws MissingResourceException Thrown if the message with the
  59      *                                  specified key cannot be found.
  60      */
  61      public String formatMessage(Locale locale, String key, Object[] arguments)
  62         throws MissingResourceException {
  63 
  64         if (fResourceBundle == null || locale != fLocale) {
  65             if (locale != null) {
  66                 fResourceBundle = SecuritySupport.getResourceBundle("com.sun.org.apache.xerces.internal.impl.msg.XIncludeMessages", locale);
  67                 // memorize the most-recent locale
  68                 fLocale = locale;
  69             }
  70             if (fResourceBundle == null)
  71                 fResourceBundle = SecuritySupport.getResourceBundle("com.sun.org.apache.xerces.internal.impl.msg.XIncludeMessages");
  72         }
  73 
  74         String msg = fResourceBundle.getString(key);
  75         if (arguments != null) {
  76             try {
  77                 msg = java.text.MessageFormat.format(msg, arguments);
  78             } catch (Exception e) {
  79                 msg = fResourceBundle.getString("FormatFailed");
  80                 msg += " " + fResourceBundle.getString(key);
  81             }
  82         }
  83 
  84         if (msg == null) {
  85             msg = fResourceBundle.getString("BadMessageKey");
  86             throw new MissingResourceException(msg, "com.sun.org.apache.xerces.internal.impl.msg.XIncludeMessages", key);
  87         }
  88 
  89         return msg;
  90     }
  91 }