| <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd"> |
| <html lang="en"> |
| <head> |
| <title>Source code</title> |
| <link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style"> |
| </head> |
| <body> |
| <div class="sourceContainer"> |
| <pre><span class="sourceLineNo">001</span>package org.apache.fulcrum.localization;<a name="line.1"></a> |
| <span class="sourceLineNo">002</span><a name="line.2"></a> |
| <span class="sourceLineNo">003</span>/*<a name="line.3"></a> |
| <span class="sourceLineNo">004</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.4"></a> |
| <span class="sourceLineNo">005</span> * or more contributor license agreements. See the NOTICE file<a name="line.5"></a> |
| <span class="sourceLineNo">006</span> * distributed with this work for additional information<a name="line.6"></a> |
| <span class="sourceLineNo">007</span> * regarding copyright ownership. The ASF licenses this file<a name="line.7"></a> |
| <span class="sourceLineNo">008</span> * to you under the Apache License, Version 2.0 (the<a name="line.8"></a> |
| <span class="sourceLineNo">009</span> * "License"); you may not use this file except in compliance<a name="line.9"></a> |
| <span class="sourceLineNo">010</span> * with the License. You may obtain a copy of the License at<a name="line.10"></a> |
| <span class="sourceLineNo">011</span> *<a name="line.11"></a> |
| <span class="sourceLineNo">012</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.12"></a> |
| <span class="sourceLineNo">013</span> *<a name="line.13"></a> |
| <span class="sourceLineNo">014</span> * Unless required by applicable law or agreed to in writing,<a name="line.14"></a> |
| <span class="sourceLineNo">015</span> * software distributed under the License is distributed on an<a name="line.15"></a> |
| <span class="sourceLineNo">016</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.16"></a> |
| <span class="sourceLineNo">017</span> * KIND, either express or implied. See the License for the<a name="line.17"></a> |
| <span class="sourceLineNo">018</span> * specific language governing permissions and limitations<a name="line.18"></a> |
| <span class="sourceLineNo">019</span> * under the License.<a name="line.19"></a> |
| <span class="sourceLineNo">020</span> */<a name="line.20"></a> |
| <span class="sourceLineNo">021</span><a name="line.21"></a> |
| <span class="sourceLineNo">022</span><a name="line.22"></a> |
| <span class="sourceLineNo">023</span>import java.util.Locale;<a name="line.23"></a> |
| <span class="sourceLineNo">024</span>import java.util.MissingResourceException;<a name="line.24"></a> |
| <span class="sourceLineNo">025</span>import java.util.ResourceBundle;<a name="line.25"></a> |
| <span class="sourceLineNo">026</span><a name="line.26"></a> |
| <span class="sourceLineNo">027</span>/**<a name="line.27"></a> |
| <span class="sourceLineNo">028</span> * <p><a name="line.28"></a> |
| <span class="sourceLineNo">029</span> * Provides localization functionality using the interface provided<a name="line.29"></a> |
| <span class="sourceLineNo">030</span> * by <code>ResourceBundle</code>, plus leverages a "search path"<a name="line.30"></a> |
| <span class="sourceLineNo">031</span> * style traversal of the <code>ResourceBundle</code> objects named by<a name="line.31"></a> |
| <span class="sourceLineNo">032</span> * the <code>locale.default.bundles</code> to discover a value for a<a name="line.32"></a> |
| <span class="sourceLineNo">033</span> * given key.<a name="line.33"></a> |
| <span class="sourceLineNo">034</span> * </p><a name="line.34"></a> |
| <span class="sourceLineNo">035</span> *<a name="line.35"></a> |
| <span class="sourceLineNo">036</span> * <p><a name="line.36"></a> |
| <span class="sourceLineNo">037</span> * It is suggested that one handle<a name="line.37"></a> |
| <span class="sourceLineNo">038</span> * <a href="http://www.math.fu-berlin.de/~rene/www/java/tutorial/i18n/message/messageFormat.html">dealing with concatenated messages</a><a name="line.38"></a> |
| <span class="sourceLineNo">039</span> * using <code>MessageFormat</code> and properties files.<a name="line.39"></a> |
| <span class="sourceLineNo">040</span> * </p><a name="line.40"></a> |
| <span class="sourceLineNo">041</span> *<a name="line.41"></a> |
| <span class="sourceLineNo">042</span> * @author <a href="mailto:jon@latchkey.com">Jon S. Stevens</a><a name="line.42"></a> |
| <span class="sourceLineNo">043</span> * @author <a href="mailto:dlr@finemaltcoding.com">Daniel Rall</a><a name="line.43"></a> |
| <span class="sourceLineNo">044</span> * @author <a href="mailto:leonardr@collab.net">Leonard Richardson</a><a name="line.44"></a> |
| <span class="sourceLineNo">045</span> * @author <a href="mailto:mcconnell@apache.org">Stephen McConnell</a><a name="line.45"></a> |
| <span class="sourceLineNo">046</span> * @author <a href="mailto:tv@apache.org">Thomas Vandahl</a><a name="line.46"></a> |
| <span class="sourceLineNo">047</span> * @version $Id: LocalizationService.java 535465 2007-05-05 06:58:06Z tv $<a name="line.47"></a> |
| <span class="sourceLineNo">048</span> */<a name="line.48"></a> |
| <span class="sourceLineNo">049</span>public interface SimpleLocalizationService<a name="line.49"></a> |
| <span class="sourceLineNo">050</span>{<a name="line.50"></a> |
| <span class="sourceLineNo">051</span> String ROLE = SimpleLocalizationService.class.getName();<a name="line.51"></a> |
| <span class="sourceLineNo">052</span> String SERVICE_NAME = ROLE;<a name="line.52"></a> |
| <span class="sourceLineNo">053</span><a name="line.53"></a> |
| <span class="sourceLineNo">054</span> /**<a name="line.54"></a> |
| <span class="sourceLineNo">055</span> * Retrieves the default language (as specified in the config<a name="line.55"></a> |
| <span class="sourceLineNo">056</span> * file).<a name="line.56"></a> |
| <span class="sourceLineNo">057</span> * @return the default language<a name="line.57"></a> |
| <span class="sourceLineNo">058</span> */<a name="line.58"></a> |
| <span class="sourceLineNo">059</span> String getDefaultLanguage();<a name="line.59"></a> |
| <span class="sourceLineNo">060</span><a name="line.60"></a> |
| <span class="sourceLineNo">061</span> /**<a name="line.61"></a> |
| <span class="sourceLineNo">062</span> * Retrieves the default country (as specified in the config<a name="line.62"></a> |
| <span class="sourceLineNo">063</span> * file).<a name="line.63"></a> |
| <span class="sourceLineNo">064</span> * <a name="line.64"></a> |
| <span class="sourceLineNo">065</span> * @return the default country<a name="line.65"></a> |
| <span class="sourceLineNo">066</span> */<a name="line.66"></a> |
| <span class="sourceLineNo">067</span> String getDefaultCountry();<a name="line.67"></a> |
| <span class="sourceLineNo">068</span><a name="line.68"></a> |
| <span class="sourceLineNo">069</span> /**<a name="line.69"></a> |
| <span class="sourceLineNo">070</span> * Retrieves the default Locale (as created from default<a name="line.70"></a> |
| <span class="sourceLineNo">071</span> * language and default country).<a name="line.71"></a> |
| <span class="sourceLineNo">072</span> * <a name="line.72"></a> |
| <span class="sourceLineNo">073</span> * @return the default locale<a name="line.73"></a> |
| <span class="sourceLineNo">074</span> */<a name="line.74"></a> |
| <span class="sourceLineNo">075</span> Locale getDefaultLocale();<a name="line.75"></a> |
| <span class="sourceLineNo">076</span><a name="line.76"></a> |
| <span class="sourceLineNo">077</span> /**<a name="line.77"></a> |
| <span class="sourceLineNo">078</span> * Retrieves the name of the default bundle (as specified in the<a name="line.78"></a> |
| <span class="sourceLineNo">079</span> * config file), or the first in the list if there are more than<a name="line.79"></a> |
| <span class="sourceLineNo">080</span> * one.<a name="line.80"></a> |
| <span class="sourceLineNo">081</span> * <a name="line.81"></a> |
| <span class="sourceLineNo">082</span> * @return the default bundle name<a name="line.82"></a> |
| <span class="sourceLineNo">083</span> */<a name="line.83"></a> |
| <span class="sourceLineNo">084</span> String getDefaultBundleName();<a name="line.84"></a> |
| <span class="sourceLineNo">085</span><a name="line.85"></a> |
| <span class="sourceLineNo">086</span> /**<a name="line.86"></a> |
| <span class="sourceLineNo">087</span> * Retrieves the list of names of bundles to search by default for<a name="line.87"></a> |
| <span class="sourceLineNo">088</span> * <code>ResourceBundle</code> keys (as specified in the config<a name="line.88"></a> |
| <span class="sourceLineNo">089</span> * file).<a name="line.89"></a> |
| <span class="sourceLineNo">090</span> *<a name="line.90"></a> |
| <span class="sourceLineNo">091</span> * @return The list of configured bundle names.<a name="line.91"></a> |
| <span class="sourceLineNo">092</span> */<a name="line.92"></a> |
| <span class="sourceLineNo">093</span> String[] getBundleNames();<a name="line.93"></a> |
| <span class="sourceLineNo">094</span><a name="line.94"></a> |
| <span class="sourceLineNo">095</span> /**<a name="line.95"></a> |
| <span class="sourceLineNo">096</span> * Convenience method to get the default <code>ResourceBundle</code>.<a name="line.96"></a> |
| <span class="sourceLineNo">097</span> *<a name="line.97"></a> |
| <span class="sourceLineNo">098</span> * @return A localized <code>ResourceBundle</code>.<a name="line.98"></a> |
| <span class="sourceLineNo">099</span> */<a name="line.99"></a> |
| <span class="sourceLineNo">100</span> ResourceBundle getBundle();<a name="line.100"></a> |
| <span class="sourceLineNo">101</span><a name="line.101"></a> |
| <span class="sourceLineNo">102</span> /**<a name="line.102"></a> |
| <span class="sourceLineNo">103</span> * Returns a ResourceBundle given the bundle name and the default<a name="line.103"></a> |
| <span class="sourceLineNo">104</span> * locale information supplied by the configuration.<a name="line.104"></a> |
| <span class="sourceLineNo">105</span> *<a name="line.105"></a> |
| <span class="sourceLineNo">106</span> * @param bundleName Name of bundle.<a name="line.106"></a> |
| <span class="sourceLineNo">107</span> * @return A localized ResourceBundle.<a name="line.107"></a> |
| <span class="sourceLineNo">108</span> */<a name="line.108"></a> |
| <span class="sourceLineNo">109</span> ResourceBundle getBundle(String bundleName);<a name="line.109"></a> |
| <span class="sourceLineNo">110</span><a name="line.110"></a> |
| <span class="sourceLineNo">111</span> /**<a name="line.111"></a> |
| <span class="sourceLineNo">112</span> * Convenience method to get a ResourceBundle based on name and<a name="line.112"></a> |
| <span class="sourceLineNo">113</span> * Locale.<a name="line.113"></a> |
| <span class="sourceLineNo">114</span> *<a name="line.114"></a> |
| <span class="sourceLineNo">115</span> * @param bundleName Name of bundle.<a name="line.115"></a> |
| <span class="sourceLineNo">116</span> * @param locale A Locale.<a name="line.116"></a> |
| <span class="sourceLineNo">117</span> * @return A localized ResourceBundle.<a name="line.117"></a> |
| <span class="sourceLineNo">118</span> */<a name="line.118"></a> |
| <span class="sourceLineNo">119</span> ResourceBundle getBundle(String bundleName, Locale locale);<a name="line.119"></a> |
| <span class="sourceLineNo">120</span><a name="line.120"></a> |
| <span class="sourceLineNo">121</span> /**<a name="line.121"></a> |
| <span class="sourceLineNo">122</span> * Tries very hard to return a value, looking first in the<a name="line.122"></a> |
| <span class="sourceLineNo">123</span> * specified bundle, then searching list of default bundles<a name="line.123"></a> |
| <span class="sourceLineNo">124</span> * (giving precedence to earlier bundles over later bundles).<a name="line.124"></a> |
| <span class="sourceLineNo">125</span> *<a name="line.125"></a> |
| <span class="sourceLineNo">126</span> * @param bundleName Name of the bundle to look in first.<a name="line.126"></a> |
| <span class="sourceLineNo">127</span> * @param locale Locale to get text for.<a name="line.127"></a> |
| <span class="sourceLineNo">128</span> * @param key Name of the text to retrieve.<a name="line.128"></a> |
| <span class="sourceLineNo">129</span> * @return Localized text.<a name="line.129"></a> |
| <span class="sourceLineNo">130</span> * @throws MissingResourceException if the resource is not found<a name="line.130"></a> |
| <span class="sourceLineNo">131</span> */<a name="line.131"></a> |
| <span class="sourceLineNo">132</span> String getString(String bundleName, Locale locale, String key) throws MissingResourceException;<a name="line.132"></a> |
| <span class="sourceLineNo">133</span> <a name="line.133"></a> |
| <span class="sourceLineNo">134</span> /**<a name="line.134"></a> |
| <span class="sourceLineNo">135</span> * Returns the value for the key in the default bundle and the default locale.<a name="line.135"></a> |
| <span class="sourceLineNo">136</span> * <a name="line.136"></a> |
| <span class="sourceLineNo">137</span> * @param key The key to retrieve the value for.<a name="line.137"></a> |
| <span class="sourceLineNo">138</span> * @return The value mapped to the key.<a name="line.138"></a> |
| <span class="sourceLineNo">139</span> */<a name="line.139"></a> |
| <span class="sourceLineNo">140</span> String getString(String key);<a name="line.140"></a> |
| <span class="sourceLineNo">141</span><a name="line.141"></a> |
| <span class="sourceLineNo">142</span> /**<a name="line.142"></a> |
| <span class="sourceLineNo">143</span> * This method sets the name of the defaultBundle.<a name="line.143"></a> |
| <span class="sourceLineNo">144</span> *<a name="line.144"></a> |
| <span class="sourceLineNo">145</span> * @param defaultBundle Name of default bundle.<a name="line.145"></a> |
| <span class="sourceLineNo">146</span> */<a name="line.146"></a> |
| <span class="sourceLineNo">147</span> void setBundle(String defaultBundle);<a name="line.147"></a> |
| <span class="sourceLineNo">148</span><a name="line.148"></a> |
| <span class="sourceLineNo">149</span> /**<a name="line.149"></a> |
| <span class="sourceLineNo">150</span> * Formats a localized value using the provided object.<a name="line.150"></a> |
| <span class="sourceLineNo">151</span> *<a name="line.151"></a> |
| <span class="sourceLineNo">152</span> * @param bundleName The bundle in which to look for the localizable text.<a name="line.152"></a> |
| <span class="sourceLineNo">153</span> * @param locale The locale for which to format the text.<a name="line.153"></a> |
| <span class="sourceLineNo">154</span> * @param key The identifier for the localized text to retrieve,<a name="line.154"></a> |
| <span class="sourceLineNo">155</span> * @param arg1 The object to use as {0} when formatting the localized text.<a name="line.155"></a> |
| <span class="sourceLineNo">156</span> * @return Formatted localized text.<a name="line.156"></a> |
| <span class="sourceLineNo">157</span> * @see #format(String, Locale, String, Object[])<a name="line.157"></a> |
| <span class="sourceLineNo">158</span> */<a name="line.158"></a> |
| <span class="sourceLineNo">159</span> String format(String bundleName, Locale locale,<a name="line.159"></a> |
| <span class="sourceLineNo">160</span> String key, Object arg1);<a name="line.160"></a> |
| <span class="sourceLineNo">161</span><a name="line.161"></a> |
| <span class="sourceLineNo">162</span> /**<a name="line.162"></a> |
| <span class="sourceLineNo">163</span> * Formats a localized value using the provided objects.<a name="line.163"></a> |
| <span class="sourceLineNo">164</span> *<a name="line.164"></a> |
| <span class="sourceLineNo">165</span> * @param bundleName The bundle in which to look for the localizable text.<a name="line.165"></a> |
| <span class="sourceLineNo">166</span> * @param locale The locale for which to format the text.<a name="line.166"></a> |
| <span class="sourceLineNo">167</span> * @param key The identifier for the localized text to retrieve,<a name="line.167"></a> |
| <span class="sourceLineNo">168</span> * @param arg1 The object to use as {0} when formatting the localized text.<a name="line.168"></a> |
| <span class="sourceLineNo">169</span> * @param arg2 The object to use as {1} when formatting the localized text.<a name="line.169"></a> |
| <span class="sourceLineNo">170</span> * <a name="line.170"></a> |
| <span class="sourceLineNo">171</span> * @return Formatted localized text.<a name="line.171"></a> |
| <span class="sourceLineNo">172</span> * <a name="line.172"></a> |
| <span class="sourceLineNo">173</span> * @see #format(String, Locale, String, Object[])<a name="line.173"></a> |
| <span class="sourceLineNo">174</span> */<a name="line.174"></a> |
| <span class="sourceLineNo">175</span> String format(String bundleName, Locale locale,<a name="line.175"></a> |
| <span class="sourceLineNo">176</span> String key, Object arg1, Object arg2);<a name="line.176"></a> |
| <span class="sourceLineNo">177</span><a name="line.177"></a> |
| <span class="sourceLineNo">178</span> /**<a name="line.178"></a> |
| <span class="sourceLineNo">179</span> * Formats a localized value using the provided objects.<a name="line.179"></a> |
| <span class="sourceLineNo">180</span> *<a name="line.180"></a> |
| <span class="sourceLineNo">181</span> * @param bundleName The bundle in which to look for the localizable text.<a name="line.181"></a> |
| <span class="sourceLineNo">182</span> * @param locale The locale for which to format the text.<a name="line.182"></a> |
| <span class="sourceLineNo">183</span> * @param key The identifier for the localized text to retrieve,<a name="line.183"></a> |
| <span class="sourceLineNo">184</span> * @param args The objects to use as {0}, {1}, etc. when<a name="line.184"></a> |
| <span class="sourceLineNo">185</span> * formatting the localized text.<a name="line.185"></a> |
| <span class="sourceLineNo">186</span> * @return Formatted localized text.<a name="line.186"></a> |
| <span class="sourceLineNo">187</span> */<a name="line.187"></a> |
| <span class="sourceLineNo">188</span> String format(String bundleName, Locale locale,<a name="line.188"></a> |
| <span class="sourceLineNo">189</span> String key, Object[] args);<a name="line.189"></a> |
| <span class="sourceLineNo">190</span>}<a name="line.190"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </pre> |
| </div> |
| </body> |
| </html> |
