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