| <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> |
| <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
| <head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> |
| <title>LocalizationService xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/fulcrum/localization/LocalizationService.html">View Javadoc</a></div><pre> |
| <a class="jxr_linenumber" name="L1" href="#L1">1</a> <strong class="jxr_keyword">package</strong> org.apache.fulcrum.localization; |
| <a class="jxr_linenumber" name="L2" href="#L2">2</a> |
| <a class="jxr_linenumber" name="L3" href="#L3">3</a> |
| <a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment">/*</em> |
| <a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> |
| <a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> |
| <a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * distributed with this work for additional information</em> |
| <a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> |
| <a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> |
| <a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> |
| <a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> |
| <a class="jxr_linenumber" name="L12" href="#L12">12</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L13" href="#L13">13</a> <em class="jxr_comment"> * <a href="http://www.apache.org/licenses/LICENSE-2.0" target="alexandria_uri">http://www.apache.org/licenses/LICENSE-2.0</a></em> |
| <a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> *</em> |
| <a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> |
| <a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> |
| <a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> |
| <a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> |
| <a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> |
| <a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_comment"> * under the License.</em> |
| <a class="jxr_linenumber" name="L21" href="#L21">21</a> <em class="jxr_comment"> */</em> |
| <a class="jxr_linenumber" name="L22" href="#L22">22</a> |
| <a class="jxr_linenumber" name="L23" href="#L23">23</a> |
| <a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.Locale; |
| <a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.ResourceBundle; |
| <a class="jxr_linenumber" name="L26" href="#L26">26</a> |
| <a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest; |
| <a class="jxr_linenumber" name="L28" href="#L28">28</a> |
| <a class="jxr_linenumber" name="L29" href="#L29">29</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * Provides localization functionality using the interface provided</em> |
| <a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * by <code>ResourceBundle</code>, plus leverages a "search path"</em> |
| <a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> * style traversal of the <code>ResourceBundle</code> objects named by</em> |
| <a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * the <code>locale.default.bundles</code> to discover a value for a</em> |
| <a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * given key.</em> |
| <a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a class="jxr_linenumber" name="L37" href="#L37">37</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L38" href="#L38">38</a> <em class="jxr_javadoccomment"> * <p></em> |
| <a class="jxr_linenumber" name="L39" href="#L39">39</a> <em class="jxr_javadoccomment"> * It is suggested that one handle</em> |
| <a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment"> * <a href="<a href="http://www.math.fu-berlin.de/~rene/www/java/tutorial/i18n/message/messageFormat.html" target="alexandria_uri">http://www.math.fu-berlin.de/~rene/www/java/tutorial/i18n/message/messageFormat.html</a>">dealing with concatenated messages</a></em> |
| <a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * using <code>MessageFormat</code> and properties files.</em> |
| <a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * </p></em> |
| <a class="jxr_linenumber" name="L43" href="#L43">43</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L44" href="#L44">44</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:jon@latchkey.com" target="alexandria_uri">mailto:jon@latchkey.com</a>">Jon S. Stevens</a></em> |
| <a class="jxr_linenumber" name="L45" href="#L45">45</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:dlr@finemaltcoding.com" target="alexandria_uri">mailto:dlr@finemaltcoding.com</a>">Daniel Rall</a></em> |
| <a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:leonardr@collab.net" target="alexandria_uri">mailto:leonardr@collab.net</a>">Leonard Richardson</a></em> |
| <a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:mcconnell@apache.org" target="alexandria_uri">mailto:mcconnell@apache.org</a>">Stephen McConnell</a></em> |
| <a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:tv@apache.org" target="alexandria_uri">mailto:tv@apache.org</a>">Thomas Vandahl</a></em> |
| <a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * @version $Id$</em> |
| <a class="jxr_linenumber" name="L50" href="#L50">50</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L51" href="#L51">51</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a name="LocalizationService" href="../../../../org/apache/fulcrum/localization/LocalizationService.html#LocalizationService">LocalizationService</a> <strong class="jxr_keyword">extends</strong> <a name="SimpleLocalizationService" href="../../../../org/apache/fulcrum/localization/SimpleLocalizationService.html#SimpleLocalizationService">SimpleLocalizationService</a> |
| <a class="jxr_linenumber" name="L52" href="#L52">52</a> { |
| <a class="jxr_linenumber" name="L53" href="#L53">53</a> String ROLE = LocalizationService.<strong class="jxr_keyword">class</strong>.getName(); |
| <a class="jxr_linenumber" name="L54" href="#L54">54</a> String SERVICE_NAME = ROLE; |
| <a class="jxr_linenumber" name="L55" href="#L55">55</a> |
| <a class="jxr_linenumber" name="L56" href="#L56">56</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment"> * A constant for the HTTP <code>Accept-Language</code> header.</em> |
| <a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L59" href="#L59">59</a> String ACCEPT_LANGUAGE = <span class="jxr_string">"Accept-Language"</span>; |
| <a class="jxr_linenumber" name="L60" href="#L60">60</a> |
| <a class="jxr_linenumber" name="L61" href="#L61">61</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment"> * Convenience method to get a ResourceBundle based on name and</em> |
| <a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * HTTP <code>Accept-Language</code> header.</em> |
| <a class="jxr_linenumber" name="L64" href="#L64">64</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L65" href="#L65">65</a> <em class="jxr_javadoccomment"> * @param bundleName Name of bundle.</em> |
| <a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * @param languageHeader A String with the language header.</em> |
| <a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> * @return A localized ResourceBundle.</em> |
| <a class="jxr_linenumber" name="L68" href="#L68">68</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L69" href="#L69">69</a> ResourceBundle getBundle(String bundleName, String languageHeader); |
| <a class="jxr_linenumber" name="L70" href="#L70">70</a> |
| <a class="jxr_linenumber" name="L71" href="#L71">71</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L72" href="#L72">72</a> <em class="jxr_javadoccomment"> * Convenience method to get a ResourceBundle based on HTTP</em> |
| <a class="jxr_linenumber" name="L73" href="#L73">73</a> <em class="jxr_javadoccomment"> * Accept-Language header in HttpServletRequest.</em> |
| <a class="jxr_linenumber" name="L74" href="#L74">74</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L75" href="#L75">75</a> <em class="jxr_javadoccomment"> * @param req The HTTP request to parse the</em> |
| <a class="jxr_linenumber" name="L76" href="#L76">76</a> <em class="jxr_javadoccomment"> * <code>Accept-Language</code> of.</em> |
| <a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_javadoccomment"> * @return A localized ResourceBundle.</em> |
| <a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L79" href="#L79">79</a> ResourceBundle getBundle(HttpServletRequest req); |
| <a class="jxr_linenumber" name="L80" href="#L80">80</a> |
| <a class="jxr_linenumber" name="L81" href="#L81">81</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L82" href="#L82">82</a> <em class="jxr_javadoccomment"> * Convenience method to get a <code>ResourceBundle</code> based</em> |
| <a class="jxr_linenumber" name="L83" href="#L83">83</a> <em class="jxr_javadoccomment"> * on name and HTTP <code>Accept-Language</code> header from a</em> |
| <a class="jxr_linenumber" name="L84" href="#L84">84</a> <em class="jxr_javadoccomment"> * <code>HttpServletRequest</code>.</em> |
| <a class="jxr_linenumber" name="L85" href="#L85">85</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L86" href="#L86">86</a> <em class="jxr_javadoccomment"> * @param bundleName Name of bundle.</em> |
| <a class="jxr_linenumber" name="L87" href="#L87">87</a> <em class="jxr_javadoccomment"> * @param req The HTTP request to parse the</em> |
| <a class="jxr_linenumber" name="L88" href="#L88">88</a> <em class="jxr_javadoccomment"> * <code>Accept-Language</code> of.</em> |
| <a class="jxr_linenumber" name="L89" href="#L89">89</a> <em class="jxr_javadoccomment"> * @return A localized ResourceBundle.</em> |
| <a class="jxr_linenumber" name="L90" href="#L90">90</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L91" href="#L91">91</a> ResourceBundle getBundle(String bundleName, HttpServletRequest req); |
| <a class="jxr_linenumber" name="L92" href="#L92">92</a> |
| <a class="jxr_linenumber" name="L93" href="#L93">93</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L94" href="#L94">94</a> <em class="jxr_javadoccomment"> * Attempts to pull the <code>Accept-Language</code> header out of</em> |
| <a class="jxr_linenumber" name="L95" href="#L95">95</a> <em class="jxr_javadoccomment"> * the <code>HttpServletRequest</code> object and then parse it.</em> |
| <a class="jxr_linenumber" name="L96" href="#L96">96</a> <em class="jxr_javadoccomment"> * If the header is not present, it will return a</em> |
| <a class="jxr_linenumber" name="L97" href="#L97">97</a> <em class="jxr_javadoccomment"> * <code>null</code> <code>Locale</code>.</em> |
| <a class="jxr_linenumber" name="L98" href="#L98">98</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_javadoccomment"> * @param req The HTTP request to parse the</em> |
| <a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_javadoccomment"> * <code>Accept-Language</code> of.</em> |
| <a class="jxr_linenumber" name="L101" href="#L101">101</a> <em class="jxr_javadoccomment"> * @return The parsed locale.</em> |
| <a class="jxr_linenumber" name="L102" href="#L102">102</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L103" href="#L103">103</a> Locale getLocale(HttpServletRequest req); |
| <a class="jxr_linenumber" name="L104" href="#L104">104</a> |
| <a class="jxr_linenumber" name="L105" href="#L105">105</a> <em class="jxr_javadoccomment">/**</em> |
| <a class="jxr_linenumber" name="L106" href="#L106">106</a> <em class="jxr_javadoccomment"> * Parses the <code>Accept-Language</code> header and attempts to</em> |
| <a class="jxr_linenumber" name="L107" href="#L107">107</a> <em class="jxr_javadoccomment"> * create a <code>Locale</code> from it.</em> |
| <a class="jxr_linenumber" name="L108" href="#L108">108</a> <em class="jxr_javadoccomment"> *</em> |
| <a class="jxr_linenumber" name="L109" href="#L109">109</a> <em class="jxr_javadoccomment"> * @param languageHeader The language header (i.e. <code>en, es;q=0.8,</em> |
| <a class="jxr_linenumber" name="L110" href="#L110">110</a> <em class="jxr_javadoccomment"> * zh-TW;q=0.1</code>), or <code>null</code> for the locale</em> |
| <a class="jxr_linenumber" name="L111" href="#L111">111</a> <em class="jxr_javadoccomment"> * corresponding to the default language and country.</em> |
| <a class="jxr_linenumber" name="L112" href="#L112">112</a> <em class="jxr_javadoccomment"> * @return The parsed locale, or a locale corresponding to the</em> |
| <a class="jxr_linenumber" name="L113" href="#L113">113</a> <em class="jxr_javadoccomment"> * language and country defaults.</em> |
| <a class="jxr_linenumber" name="L114" href="#L114">114</a> <em class="jxr_javadoccomment"> */</em> |
| <a class="jxr_linenumber" name="L115" href="#L115">115</a> Locale getLocale(String languageHeader); |
| <a class="jxr_linenumber" name="L116" href="#L116">116</a> } |
| </pre> |
| <hr/> |
| <div id="footer">Copyright © 2005–2021 <a href="https://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</div> |
| </body> |
| </html> |
