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