blob: 98c5c1bd4985fa0121a3359cb6aa8b5167c35cb8 [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the "License");<a name="line.6"></a>
<FONT color="green">007</FONT> * you may not use this file except in compliance with the License.<a name="line.7"></a>
<FONT color="green">008</FONT> * You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<FONT color="green">013</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<FONT color="green">014</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<FONT color="green">015</FONT> * See the License for the specific language governing permissions and<a name="line.15"></a>
<FONT color="green">016</FONT> * limitations under the License.<a name="line.16"></a>
<FONT color="green">017</FONT> */<a name="line.17"></a>
<FONT color="green">018</FONT> /*<a name="line.18"></a>
<FONT color="green">019</FONT> * $Id: XMLMessages.java 468653 2006-10-28 07:07:05Z minchau $<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> package org.apache.xml.res;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> import java.util.ListResourceBundle;<a name="line.23"></a>
<FONT color="green">024</FONT> import java.util.Locale;<a name="line.24"></a>
<FONT color="green">025</FONT> import java.util.MissingResourceException;<a name="line.25"></a>
<FONT color="green">026</FONT> import java.util.ResourceBundle;<a name="line.26"></a>
<FONT color="green">027</FONT> <a name="line.27"></a>
<FONT color="green">028</FONT> /**<a name="line.28"></a>
<FONT color="green">029</FONT> * A utility class for issuing XML error messages.<a name="line.29"></a>
<FONT color="green">030</FONT> * @xsl.usage internal<a name="line.30"></a>
<FONT color="green">031</FONT> */<a name="line.31"></a>
<FONT color="green">032</FONT> public class XMLMessages<a name="line.32"></a>
<FONT color="green">033</FONT> {<a name="line.33"></a>
<FONT color="green">034</FONT> <a name="line.34"></a>
<FONT color="green">035</FONT> /** The local object to use. */<a name="line.35"></a>
<FONT color="green">036</FONT> protected Locale fLocale = Locale.getDefault();<a name="line.36"></a>
<FONT color="green">037</FONT> <a name="line.37"></a>
<FONT color="green">038</FONT> /** The language specific resource object for XML messages. */<a name="line.38"></a>
<FONT color="green">039</FONT> private static ListResourceBundle XMLBundle = null;<a name="line.39"></a>
<FONT color="green">040</FONT> <a name="line.40"></a>
<FONT color="green">041</FONT> /** The class name of the XML error message string table. */<a name="line.41"></a>
<FONT color="green">042</FONT> private static final String XML_ERROR_RESOURCES =<a name="line.42"></a>
<FONT color="green">043</FONT> "org.apache.xml.res.XMLErrorResources";<a name="line.43"></a>
<FONT color="green">044</FONT> <a name="line.44"></a>
<FONT color="green">045</FONT> /** String to use if a bad message code is used. */<a name="line.45"></a>
<FONT color="green">046</FONT> protected static final String BAD_CODE = "BAD_CODE";<a name="line.46"></a>
<FONT color="green">047</FONT> <a name="line.47"></a>
<FONT color="green">048</FONT> /** String to use if the message format operation failed. */<a name="line.48"></a>
<FONT color="green">049</FONT> protected static final String FORMAT_FAILED = "FORMAT_FAILED";<a name="line.49"></a>
<FONT color="green">050</FONT> <a name="line.50"></a>
<FONT color="green">051</FONT> /**<a name="line.51"></a>
<FONT color="green">052</FONT> * Set the Locale object to use.<a name="line.52"></a>
<FONT color="green">053</FONT> * <a name="line.53"></a>
<FONT color="green">054</FONT> * @param locale non-null reference to Locale object.<a name="line.54"></a>
<FONT color="green">055</FONT> */<a name="line.55"></a>
<FONT color="green">056</FONT> public void setLocale(Locale locale)<a name="line.56"></a>
<FONT color="green">057</FONT> {<a name="line.57"></a>
<FONT color="green">058</FONT> fLocale = locale;<a name="line.58"></a>
<FONT color="green">059</FONT> }<a name="line.59"></a>
<FONT color="green">060</FONT> <a name="line.60"></a>
<FONT color="green">061</FONT> /**<a name="line.61"></a>
<FONT color="green">062</FONT> * Get the Locale object that is being used.<a name="line.62"></a>
<FONT color="green">063</FONT> * <a name="line.63"></a>
<FONT color="green">064</FONT> * @return non-null reference to Locale object.<a name="line.64"></a>
<FONT color="green">065</FONT> */<a name="line.65"></a>
<FONT color="green">066</FONT> public Locale getLocale()<a name="line.66"></a>
<FONT color="green">067</FONT> {<a name="line.67"></a>
<FONT color="green">068</FONT> return fLocale;<a name="line.68"></a>
<FONT color="green">069</FONT> }<a name="line.69"></a>
<FONT color="green">070</FONT> <a name="line.70"></a>
<FONT color="green">071</FONT> /**<a name="line.71"></a>
<FONT color="green">072</FONT> * Creates a message from the specified key and replacement<a name="line.72"></a>
<FONT color="green">073</FONT> * arguments, localized to the given locale.<a name="line.73"></a>
<FONT color="green">074</FONT> *<a name="line.74"></a>
<FONT color="green">075</FONT> * @param msgKey The key for the message text.<a name="line.75"></a>
<FONT color="green">076</FONT> * @param args The arguments to be used as replacement text<a name="line.76"></a>
<FONT color="green">077</FONT> * in the message created.<a name="line.77"></a>
<FONT color="green">078</FONT> *<a name="line.78"></a>
<FONT color="green">079</FONT> * @return The formatted message string.<a name="line.79"></a>
<FONT color="green">080</FONT> */<a name="line.80"></a>
<FONT color="green">081</FONT> public static final String createXMLMessage(String msgKey, Object args[])<a name="line.81"></a>
<FONT color="green">082</FONT> {<a name="line.82"></a>
<FONT color="green">083</FONT> if (XMLBundle == null)<a name="line.83"></a>
<FONT color="green">084</FONT> XMLBundle = loadResourceBundle(XML_ERROR_RESOURCES);<a name="line.84"></a>
<FONT color="green">085</FONT> <a name="line.85"></a>
<FONT color="green">086</FONT> if (XMLBundle != null)<a name="line.86"></a>
<FONT color="green">087</FONT> {<a name="line.87"></a>
<FONT color="green">088</FONT> return createMsg(XMLBundle, msgKey, args);<a name="line.88"></a>
<FONT color="green">089</FONT> }<a name="line.89"></a>
<FONT color="green">090</FONT> else<a name="line.90"></a>
<FONT color="green">091</FONT> return "Could not load any resource bundles.";<a name="line.91"></a>
<FONT color="green">092</FONT> }<a name="line.92"></a>
<FONT color="green">093</FONT> <a name="line.93"></a>
<FONT color="green">094</FONT> /**<a name="line.94"></a>
<FONT color="green">095</FONT> * Creates a message from the specified key and replacement<a name="line.95"></a>
<FONT color="green">096</FONT> * arguments, localized to the given locale.<a name="line.96"></a>
<FONT color="green">097</FONT> *<a name="line.97"></a>
<FONT color="green">098</FONT> * @param fResourceBundle The resource bundle to use.<a name="line.98"></a>
<FONT color="green">099</FONT> * @param msgKey The message key to use.<a name="line.99"></a>
<FONT color="green">100</FONT> * @param args The arguments to be used as replacement text<a name="line.100"></a>
<FONT color="green">101</FONT> * in the message created.<a name="line.101"></a>
<FONT color="green">102</FONT> *<a name="line.102"></a>
<FONT color="green">103</FONT> * @return The formatted message string.<a name="line.103"></a>
<FONT color="green">104</FONT> */<a name="line.104"></a>
<FONT color="green">105</FONT> public static final String createMsg(ListResourceBundle fResourceBundle,<a name="line.105"></a>
<FONT color="green">106</FONT> String msgKey, Object args[]) //throws Exception<a name="line.106"></a>
<FONT color="green">107</FONT> {<a name="line.107"></a>
<FONT color="green">108</FONT> <a name="line.108"></a>
<FONT color="green">109</FONT> String fmsg = null;<a name="line.109"></a>
<FONT color="green">110</FONT> boolean throwex = false;<a name="line.110"></a>
<FONT color="green">111</FONT> String msg = null;<a name="line.111"></a>
<FONT color="green">112</FONT> <a name="line.112"></a>
<FONT color="green">113</FONT> if (msgKey != null)<a name="line.113"></a>
<FONT color="green">114</FONT> msg = fResourceBundle.getString(msgKey);<a name="line.114"></a>
<FONT color="green">115</FONT> <a name="line.115"></a>
<FONT color="green">116</FONT> if (msg == null)<a name="line.116"></a>
<FONT color="green">117</FONT> {<a name="line.117"></a>
<FONT color="green">118</FONT> msg = fResourceBundle.getString(BAD_CODE);<a name="line.118"></a>
<FONT color="green">119</FONT> throwex = true;<a name="line.119"></a>
<FONT color="green">120</FONT> }<a name="line.120"></a>
<FONT color="green">121</FONT> <a name="line.121"></a>
<FONT color="green">122</FONT> if (args != null)<a name="line.122"></a>
<FONT color="green">123</FONT> {<a name="line.123"></a>
<FONT color="green">124</FONT> try<a name="line.124"></a>
<FONT color="green">125</FONT> {<a name="line.125"></a>
<FONT color="green">126</FONT> <a name="line.126"></a>
<FONT color="green">127</FONT> // Do this to keep format from crying.<a name="line.127"></a>
<FONT color="green">128</FONT> // This is better than making a bunch of conditional<a name="line.128"></a>
<FONT color="green">129</FONT> // code all over the place.<a name="line.129"></a>
<FONT color="green">130</FONT> int n = args.length;<a name="line.130"></a>
<FONT color="green">131</FONT> <a name="line.131"></a>
<FONT color="green">132</FONT> for (int i = 0; i &lt; n; i++)<a name="line.132"></a>
<FONT color="green">133</FONT> {<a name="line.133"></a>
<FONT color="green">134</FONT> if (null == args[i])<a name="line.134"></a>
<FONT color="green">135</FONT> args[i] = "";<a name="line.135"></a>
<FONT color="green">136</FONT> }<a name="line.136"></a>
<FONT color="green">137</FONT> <a name="line.137"></a>
<FONT color="green">138</FONT> fmsg = java.text.MessageFormat.format(msg, args);<a name="line.138"></a>
<FONT color="green">139</FONT> }<a name="line.139"></a>
<FONT color="green">140</FONT> catch (Exception e)<a name="line.140"></a>
<FONT color="green">141</FONT> {<a name="line.141"></a>
<FONT color="green">142</FONT> fmsg = fResourceBundle.getString(FORMAT_FAILED);<a name="line.142"></a>
<FONT color="green">143</FONT> fmsg += " " + msg;<a name="line.143"></a>
<FONT color="green">144</FONT> }<a name="line.144"></a>
<FONT color="green">145</FONT> }<a name="line.145"></a>
<FONT color="green">146</FONT> else<a name="line.146"></a>
<FONT color="green">147</FONT> fmsg = msg;<a name="line.147"></a>
<FONT color="green">148</FONT> <a name="line.148"></a>
<FONT color="green">149</FONT> if (throwex)<a name="line.149"></a>
<FONT color="green">150</FONT> {<a name="line.150"></a>
<FONT color="green">151</FONT> throw new RuntimeException(fmsg);<a name="line.151"></a>
<FONT color="green">152</FONT> }<a name="line.152"></a>
<FONT color="green">153</FONT> <a name="line.153"></a>
<FONT color="green">154</FONT> return fmsg;<a name="line.154"></a>
<FONT color="green">155</FONT> }<a name="line.155"></a>
<FONT color="green">156</FONT> <a name="line.156"></a>
<FONT color="green">157</FONT> /**<a name="line.157"></a>
<FONT color="green">158</FONT> * Return a named ResourceBundle for a particular locale. This method mimics the behavior<a name="line.158"></a>
<FONT color="green">159</FONT> * of ResourceBundle.getBundle().<a name="line.159"></a>
<FONT color="green">160</FONT> *<a name="line.160"></a>
<FONT color="green">161</FONT> * @param className The class name of the resource bundle.<a name="line.161"></a>
<FONT color="green">162</FONT> * @return the ResourceBundle<a name="line.162"></a>
<FONT color="green">163</FONT> * @throws MissingResourceException<a name="line.163"></a>
<FONT color="green">164</FONT> */<a name="line.164"></a>
<FONT color="green">165</FONT> public static ListResourceBundle loadResourceBundle(String className)<a name="line.165"></a>
<FONT color="green">166</FONT> throws MissingResourceException<a name="line.166"></a>
<FONT color="green">167</FONT> { <a name="line.167"></a>
<FONT color="green">168</FONT> Locale locale = Locale.getDefault();<a name="line.168"></a>
<FONT color="green">169</FONT> <a name="line.169"></a>
<FONT color="green">170</FONT> try<a name="line.170"></a>
<FONT color="green">171</FONT> {<a name="line.171"></a>
<FONT color="green">172</FONT> return (ListResourceBundle)ResourceBundle.getBundle(className, locale);<a name="line.172"></a>
<FONT color="green">173</FONT> }<a name="line.173"></a>
<FONT color="green">174</FONT> catch (MissingResourceException e)<a name="line.174"></a>
<FONT color="green">175</FONT> {<a name="line.175"></a>
<FONT color="green">176</FONT> try // try to fall back to en_US if we can't load<a name="line.176"></a>
<FONT color="green">177</FONT> {<a name="line.177"></a>
<FONT color="green">178</FONT> <a name="line.178"></a>
<FONT color="green">179</FONT> // Since we can't find the localized property file,<a name="line.179"></a>
<FONT color="green">180</FONT> // fall back to en_US.<a name="line.180"></a>
<FONT color="green">181</FONT> return (ListResourceBundle)ResourceBundle.getBundle(<a name="line.181"></a>
<FONT color="green">182</FONT> className, new Locale("en", "US"));<a name="line.182"></a>
<FONT color="green">183</FONT> }<a name="line.183"></a>
<FONT color="green">184</FONT> catch (MissingResourceException e2)<a name="line.184"></a>
<FONT color="green">185</FONT> {<a name="line.185"></a>
<FONT color="green">186</FONT> <a name="line.186"></a>
<FONT color="green">187</FONT> // Now we are really in trouble.<a name="line.187"></a>
<FONT color="green">188</FONT> // very bad, definitely very bad...not going to get very far<a name="line.188"></a>
<FONT color="green">189</FONT> throw new MissingResourceException(<a name="line.189"></a>
<FONT color="green">190</FONT> "Could not load any resource bundles." + className, className, "");<a name="line.190"></a>
<FONT color="green">191</FONT> }<a name="line.191"></a>
<FONT color="green">192</FONT> }<a name="line.192"></a>
<FONT color="green">193</FONT> }<a name="line.193"></a>
<FONT color="green">194</FONT> <a name="line.194"></a>
<FONT color="green">195</FONT> /**<a name="line.195"></a>
<FONT color="green">196</FONT> * Return the resource file suffic for the indicated locale<a name="line.196"></a>
<FONT color="green">197</FONT> * For most locales, this will be based the language code. However<a name="line.197"></a>
<FONT color="green">198</FONT> * for Chinese, we do distinguish between Taiwan and PRC<a name="line.198"></a>
<FONT color="green">199</FONT> *<a name="line.199"></a>
<FONT color="green">200</FONT> * @param locale the locale<a name="line.200"></a>
<FONT color="green">201</FONT> * @return an String suffix which can be appended to a resource name<a name="line.201"></a>
<FONT color="green">202</FONT> */<a name="line.202"></a>
<FONT color="green">203</FONT> protected static String getResourceSuffix(Locale locale)<a name="line.203"></a>
<FONT color="green">204</FONT> {<a name="line.204"></a>
<FONT color="green">205</FONT> <a name="line.205"></a>
<FONT color="green">206</FONT> String suffix = "_" + locale.getLanguage();<a name="line.206"></a>
<FONT color="green">207</FONT> String country = locale.getCountry();<a name="line.207"></a>
<FONT color="green">208</FONT> <a name="line.208"></a>
<FONT color="green">209</FONT> if (country.equals("TW"))<a name="line.209"></a>
<FONT color="green">210</FONT> suffix += "_" + country;<a name="line.210"></a>
<FONT color="green">211</FONT> <a name="line.211"></a>
<FONT color="green">212</FONT> return suffix;<a name="line.212"></a>
<FONT color="green">213</FONT> }<a name="line.213"></a>
<FONT color="green">214</FONT> }<a name="line.214"></a>
</PRE>
</BODY>
</HTML>