Modified: websites/production/turbine/content/fulcrum/fulcrum-localization/xref/org/apache/fulcrum/localization/LocaleTokenizer.html ============================================================================== --- websites/production/turbine/content/fulcrum/fulcrum-localization/xref/org/apache/fulcrum/localization/LocaleTokenizer.html (original) +++ websites/production/turbine/content/fulcrum/fulcrum-localization/xref/org/apache/fulcrum/localization/LocaleTokenizer.html Tue May 21 03:35:35 2019 @@ -1,189 +1,198 @@ <!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=ISO-8859-1" /> +<head><meta http-equiv="content-type" content="text/html; charset=UTF-8" /> <title>LocaleTokenizer xref</title> <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> </head> <body> <div id="overview"><a href="../../../../../apidocs/org/apache/fulcrum/localization/LocaleTokenizer.html">View Javadoc</a></div><pre> - -<a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.fulcrum.localization; -<a name="2" href="#2">2</a> -<a name="3" href="#3">3</a> -<a name="4" href="#4">4</a> <em class="jxr_comment">/*</em> -<a name="5" href="#5">5</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> -<a name="6" href="#6">6</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> -<a name="7" href="#7">7</a> <em class="jxr_comment"> * distributed with this work for additional information</em> -<a name="8" href="#8">8</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> -<a name="9" href="#9">9</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> -<a name="10" href="#10">10</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> -<a name="11" href="#11">11</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> -<a name="12" href="#12">12</a> <em class="jxr_comment"> *</em> -<a name="13" href="#13">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 name="14" href="#14">14</a> <em class="jxr_comment"> *</em> -<a name="15" href="#15">15</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> -<a name="16" href="#16">16</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> -<a name="17" href="#17">17</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> -<a name="18" href="#18">18</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> -<a name="19" href="#19">19</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> -<a name="20" href="#20">20</a> <em class="jxr_comment"> * under the License.</em> -<a name="21" href="#21">21</a> <em class="jxr_comment"> */</em> -<a name="22" href="#22">22</a> -<a name="23" href="#23">23</a> -<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; -<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.Collections; -<a name="26" href="#26">26</a> <strong class="jxr_keyword">import</strong> java.util.Iterator; -<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> java.util.Locale; -<a name="28" href="#28">28</a> <strong class="jxr_keyword">import</strong> java.util.NoSuchElementException; -<a name="29" href="#29">29</a> <strong class="jxr_keyword">import</strong> java.util.StringTokenizer; -<a name="30" href="#30">30</a> -<a name="31" href="#31">31</a> <em class="jxr_javadoccomment">/**</em> -<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * Parses the HTTP <code>Accept-Language</code> header as per section</em> -<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * 14.4 of RFC 2068 (HTTP 1.1 header field definitions).</em> -<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> *</em> -<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Daniel Rall</a></em> -<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * @version $Id: LocaleTokenizer.java 670330 2008-06-22 09:37:21Z tv $</em> -<a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> */</em> -<a name="38" href="#38">38</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/fulcrum/localization/LocaleTokenizer.html">LocaleTokenizer</a> -<a name="39" href="#39">39</a> implements Iterator -<a name="40" href="#40">40</a> { -<a name="41" href="#41">41</a> <em class="jxr_javadoccomment">/**</em> -<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * Separates elements of the <code>Accept-Language</code> HTTP</em> -<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * header.</em> -<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> */</em> -<a name="45" href="#45">45</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String LOCALE_SEPARATOR = <span class="jxr_string">","</span>; -<a name="46" href="#46">46</a> -<a name="47" href="#47">47</a> <em class="jxr_javadoccomment">/**</em> -<a name="48" href="#48">48</a> <em class="jxr_javadoccomment"> * Separates locale from quality within elements.</em> -<a name="49" href="#49">49</a> <em class="jxr_javadoccomment"> */</em> -<a name="50" href="#50">50</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong> QUALITY_SEPARATOR = ';'; -<a name="51" href="#51">51</a> -<a name="52" href="#52">52</a> <em class="jxr_javadoccomment">/**</em> -<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * The default quality value for an <code>AcceptLanguage</code></em> -<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> * object.</em> -<a name="55" href="#55">55</a> <em class="jxr_javadoccomment"> */</em> -<a name="56" href="#56">56</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Float DEFAULT_QUALITY = <strong class="jxr_keyword">new</strong> Float(1.0f); -<a name="57" href="#57">57</a> -<a name="58" href="#58">58</a> <em class="jxr_javadoccomment">/**</em> -<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * The parsed locales.</em> -<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> */</em> -<a name="61" href="#61">61</a> <strong class="jxr_keyword">private</strong> ArrayList locales = <strong class="jxr_keyword">new</strong> ArrayList(3); -<a name="62" href="#62">62</a> -<a name="63" href="#63">63</a> <em class="jxr_javadoccomment">/**</em> -<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> * Parses the <code>Accept-Language</code> header.</em> -<a name="65" href="#65">65</a> <em class="jxr_javadoccomment"> *</em> -<a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * @param header The <code>Accept-Language</code> header</em> -<a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> * (i.e. <code>en, es;q=0.8, zh-TW;q=0.1</code>).</em> -<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> */</em> -<a name="69" href="#69">69</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/fulcrum/localization/LocaleTokenizer.html">LocaleTokenizer</a>(String header) -<a name="70" href="#70">70</a> { -<a name="71" href="#71">71</a> StringTokenizer tok = <strong class="jxr_keyword">new</strong> StringTokenizer(header, LOCALE_SEPARATOR); -<a name="72" href="#72">72</a> <strong class="jxr_keyword">while</strong> (tok.hasMoreTokens()) -<a name="73" href="#73">73</a> { -<a name="74" href="#74">74</a> <a href="../../../../org/apache/fulcrum/localization/LocaleTokenizer.html">AcceptLanguage</a> acceptLang = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/fulcrum/localization/LocaleTokenizer.html">AcceptLanguage</a>(); -<a name="75" href="#75">75</a> String element = tok.nextToken().trim(); -<a name="76" href="#76">76</a> <strong class="jxr_keyword">int</strong> index; -<a name="77" href="#77">77</a> -<a name="78" href="#78">78</a> <em class="jxr_comment">// Record and cut off any quality value that comes after a</em> -<a name="79" href="#79">79</a> <em class="jxr_comment">// semi-colon.</em> -<a name="80" href="#80">80</a> <strong class="jxr_keyword">if</strong> ( (index = element.indexOf(QUALITY_SEPARATOR)) != -1 ) -<a name="81" href="#81">81</a> { -<a name="82" href="#82">82</a> String q = element.substring(index); -<a name="83" href="#83">83</a> element = element.substring(0, index); -<a name="84" href="#84">84</a> <strong class="jxr_keyword">if</strong> ( (index = q.indexOf('=')) != -1 ) -<a name="85" href="#85">85</a> { -<a name="86" href="#86">86</a> <strong class="jxr_keyword">try</strong> -<a name="87" href="#87">87</a> { -<a name="88" href="#88">88</a> acceptLang.quality = -<a name="89" href="#89">89</a> Float.valueOf(q.substring(index + 1)); -<a name="90" href="#90">90</a> } -<a name="91" href="#91">91</a> <strong class="jxr_keyword">catch</strong> (NumberFormatException useDefault) -<a name="92" href="#92">92</a> { -<a name="93" href="#93">93</a> <em class="jxr_comment">// ignore</em> -<a name="94" href="#94">94</a> } -<a name="95" href="#95">95</a> } -<a name="96" href="#96">96</a> } -<a name="97" href="#97">97</a> -<a name="98" href="#98">98</a> element = element.trim(); -<a name="99" href="#99">99</a> -<a name="100" href="#100">100</a> <em class="jxr_comment">// Create a Locale from the language. A dash may separate the</em> -<a name="101" href="#101">101</a> <em class="jxr_comment">// language from the country.</em> -<a name="102" href="#102">102</a> <strong class="jxr_keyword">if</strong> ( (index = element.indexOf('-')) == -1 ) -<a name="103" href="#103">103</a> { -<a name="104" href="#104">104</a> <em class="jxr_comment">// No dash means no country.</em> -<a name="105" href="#105">105</a> acceptLang.locale = <strong class="jxr_keyword">new</strong> Locale(element, <span class="jxr_string">""</span>); -<a name="106" href="#106">106</a> } -<a name="107" href="#107">107</a> <strong class="jxr_keyword">else</strong> -<a name="108" href="#108">108</a> { -<a name="109" href="#109">109</a> acceptLang.locale = <strong class="jxr_keyword">new</strong> Locale(element.substring(0, index), -<a name="110" href="#110">110</a> element.substring(index + 1)); -<a name="111" href="#111">111</a> } -<a name="112" href="#112">112</a> -<a name="113" href="#113">113</a> locales.add(acceptLang); -<a name="114" href="#114">114</a> } -<a name="115" href="#115">115</a> -<a name="116" href="#116">116</a> <em class="jxr_comment">// Sort by quality in descending order.</em> -<a name="117" href="#117">117</a> Collections.sort(locales, Collections.reverseOrder()); -<a name="118" href="#118">118</a> } -<a name="119" href="#119">119</a> -<a name="120" href="#120">120</a> <em class="jxr_javadoccomment">/**</em> -<a name="121" href="#121">121</a> <em class="jxr_javadoccomment"> * @return Whether there are more locales.</em> -<a name="122" href="#122">122</a> <em class="jxr_javadoccomment"> */</em> -<a name="123" href="#123">123</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> hasNext() -<a name="124" href="#124">124</a> { -<a name="125" href="#125">125</a> <strong class="jxr_keyword">return</strong> !locales.isEmpty(); -<a name="126" href="#126">126</a> } -<a name="127" href="#127">127</a> -<a name="128" href="#128">128</a> <em class="jxr_javadoccomment">/**</em> -<a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * Creates a <code>Locale</code> from the next element of the</em> -<a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> * <code>Accept-Language</code> header.</em> -<a name="131" href="#131">131</a> <em class="jxr_javadoccomment"> *</em> -<a name="132" href="#132">132</a> <em class="jxr_javadoccomment"> * @return The next highest-rated <code>Locale</code>.</em> -<a name="133" href="#133">133</a> <em class="jxr_javadoccomment"> * @throws NoSuchElementException No more locales.</em> -<a name="134" href="#134">134</a> <em class="jxr_javadoccomment"> */</em> -<a name="135" href="#135">135</a> <strong class="jxr_keyword">public</strong> Object next() -<a name="136" href="#136">136</a> { -<a name="137" href="#137">137</a> <strong class="jxr_keyword">if</strong> (locales.isEmpty()) -<a name="138" href="#138">138</a> { -<a name="139" href="#139">139</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NoSuchElementException(); -<a name="140" href="#140">140</a> } -<a name="141" href="#141">141</a> <strong class="jxr_keyword">return</strong> ((AcceptLanguage) locales.remove(0)).locale; -<a name="142" href="#142">142</a> } -<a name="143" href="#143">143</a> -<a name="144" href="#144">144</a> <em class="jxr_javadoccomment">/**</em> -<a name="145" href="#145">145</a> <em class="jxr_javadoccomment"> * Not implemented.</em> -<a name="146" href="#146">146</a> <em class="jxr_javadoccomment"> */</em> -<a name="147" href="#147">147</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> remove() -<a name="148" href="#148">148</a> { -<a name="149" href="#149">149</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> UnsupportedOperationException(getClass().getName() + -<a name="150" href="#150">150</a> <span class="jxr_string">" does not support remove()"</span>); -<a name="151" href="#151">151</a> } -<a name="152" href="#152">152</a> -<a name="153" href="#153">153</a> <em class="jxr_javadoccomment">/**</em> -<a name="154" href="#154">154</a> <em class="jxr_javadoccomment"> * Struct representing an element of the HTTP</em> -<a name="155" href="#155">155</a> <em class="jxr_javadoccomment"> * <code>Accept-Language</code> header.</em> -<a name="156" href="#156">156</a> <em class="jxr_javadoccomment"> */</em> -<a name="157" href="#157">157</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/fulcrum/localization/LocaleTokenizer.html">AcceptLanguage</a> implements Comparable -<a name="158" href="#158">158</a> { -<a name="159" href="#159">159</a> <em class="jxr_javadoccomment">/**</em> -<a name="160" href="#160">160</a> <em class="jxr_javadoccomment"> * The language and country.</em> -<a name="161" href="#161">161</a> <em class="jxr_javadoccomment"> */</em> -<a name="162" href="#162">162</a> Locale locale; -<a name="163" href="#163">163</a> -<a name="164" href="#164">164</a> <em class="jxr_javadoccomment">/**</em> -<a name="165" href="#165">165</a> <em class="jxr_javadoccomment"> * The quality of our locale (as values approach</em> -<a name="166" href="#166">166</a> <em class="jxr_javadoccomment"> * <code>1.0</code>, they indicate increased user preference).</em> -<a name="167" href="#167">167</a> <em class="jxr_javadoccomment"> */</em> -<a name="168" href="#168">168</a> Float quality = DEFAULT_QUALITY; -<a name="169" href="#169">169</a> -<a name="170" href="#170">170</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> compareTo(Object acceptLang) -<a name="171" href="#171">171</a> { -<a name="172" href="#172">172</a> <strong class="jxr_keyword">return</strong> quality.compareTo( ((AcceptLanguage) acceptLang).quality ); -<a name="173" href="#173">173</a> } -<a name="174" href="#174">174</a> } -<a name="175" href="#175">175</a> } +<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> <em class="jxr_comment">/*</em> +<a class="jxr_linenumber" name="L4" href="#L4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> +<a class="jxr_linenumber" name="L5" href="#L5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> +<a class="jxr_linenumber" name="L6" href="#L6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em> +<a class="jxr_linenumber" name="L7" href="#L7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> +<a class="jxr_linenumber" name="L8" href="#L8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> +<a class="jxr_linenumber" name="L9" href="#L9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> +<a class="jxr_linenumber" name="L10" href="#L10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> +<a class="jxr_linenumber" name="L11" href="#L11">11</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L12" href="#L12">12</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="L13" href="#L13">13</a> <em class="jxr_comment"> *</em> +<a class="jxr_linenumber" name="L14" href="#L14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> +<a class="jxr_linenumber" name="L15" href="#L15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> +<a class="jxr_linenumber" name="L16" href="#L16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> +<a class="jxr_linenumber" name="L17" href="#L17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> +<a class="jxr_linenumber" name="L18" href="#L18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> +<a class="jxr_linenumber" name="L19" href="#L19">19</a> <em class="jxr_comment"> * under the License.</em> +<a class="jxr_linenumber" name="L20" href="#L20">20</a> <em class="jxr_comment"> */</em> +<a class="jxr_linenumber" name="L21" href="#L21">21</a> +<a class="jxr_linenumber" name="L22" href="#L22">22</a> +<a class="jxr_linenumber" name="L23" href="#L23">23</a> <strong class="jxr_keyword">import</strong> java.util.ArrayList; +<a class="jxr_linenumber" name="L24" href="#L24">24</a> <strong class="jxr_keyword">import</strong> java.util.Collections; +<a class="jxr_linenumber" name="L25" href="#L25">25</a> <strong class="jxr_keyword">import</strong> java.util.Iterator; +<a class="jxr_linenumber" name="L26" href="#L26">26</a> <strong class="jxr_keyword">import</strong> java.util.Locale; +<a class="jxr_linenumber" name="L27" href="#L27">27</a> <strong class="jxr_keyword">import</strong> java.util.NoSuchElementException; +<a class="jxr_linenumber" name="L28" href="#L28">28</a> <strong class="jxr_keyword">import</strong> java.util.StringTokenizer; +<a class="jxr_linenumber" name="L29" href="#L29">29</a> +<a class="jxr_linenumber" name="L30" href="#L30">30</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L31" href="#L31">31</a> <em class="jxr_javadoccomment"> * Parses the HTTP <code>Accept-Language</code> header as per section</em> +<a class="jxr_linenumber" name="L32" href="#L32">32</a> <em class="jxr_javadoccomment"> * 14.4 of RFC 2068 (HTTP 1.1 header field definitions).</em> +<a class="jxr_linenumber" name="L33" href="#L33">33</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L34" href="#L34">34</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Daniel Rall</a></em> +<a class="jxr_linenumber" name="L35" href="#L35">35</a> <em class="jxr_javadoccomment"> * @version $Id: LocaleTokenizer.java 1851408 2019-01-15 19:31:48Z painter $</em> +<a class="jxr_linenumber" name="L36" href="#L36">36</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L37" href="#L37">37</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a name="LocaleTokenizer" href="../../../../org/apache/fulcrum/localization/LocaleTokenizer.html#LocaleTokenizer">LocaleTokenizer</a> +<a class="jxr_linenumber" name="L38" href="#L38">38</a> <strong class="jxr_keyword">implements</strong> Iterator<Object> +<a class="jxr_linenumber" name="L39" href="#L39">39</a> { +<a class="jxr_linenumber" name="L40" href="#L40">40</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L41" href="#L41">41</a> <em class="jxr_javadoccomment"> * Separates elements of the <code>Accept-Language</code> HTTP</em> +<a class="jxr_linenumber" name="L42" href="#L42">42</a> <em class="jxr_javadoccomment"> * header.</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> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> String LOCALE_SEPARATOR = <span class="jxr_string">","</span>; +<a class="jxr_linenumber" name="L45" href="#L45">45</a> +<a class="jxr_linenumber" name="L46" href="#L46">46</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L47" href="#L47">47</a> <em class="jxr_javadoccomment"> * Separates locale from quality within elements.</em> +<a class="jxr_linenumber" name="L48" href="#L48">48</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">char</strong> QUALITY_SEPARATOR = ';'; +<a class="jxr_linenumber" name="L50" href="#L50">50</a> +<a class="jxr_linenumber" name="L51" href="#L51">51</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L52" href="#L52">52</a> <em class="jxr_javadoccomment"> * The default quality value for an <code>AcceptLanguage</code></em> +<a class="jxr_linenumber" name="L53" href="#L53">53</a> <em class="jxr_javadoccomment"> * object.</em> +<a class="jxr_linenumber" name="L54" href="#L54">54</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L55" href="#L55">55</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> Float DEFAULT_QUALITY = <strong class="jxr_keyword">new</strong> Float(1.0f); +<a class="jxr_linenumber" name="L56" href="#L56">56</a> +<a class="jxr_linenumber" name="L57" href="#L57">57</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L58" href="#L58">58</a> <em class="jxr_javadoccomment"> * The parsed locales.</em> +<a class="jxr_linenumber" name="L59" href="#L59">59</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L60" href="#L60">60</a> <strong class="jxr_keyword">private</strong> ArrayList<AcceptLanguage> locales = <strong class="jxr_keyword">new</strong> ArrayList<AcceptLanguage>(3); +<a class="jxr_linenumber" name="L61" href="#L61">61</a> +<a class="jxr_linenumber" name="L62" href="#L62">62</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L63" href="#L63">63</a> <em class="jxr_javadoccomment"> * Parses the <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 header The <code>Accept-Language</code> header</em> +<a class="jxr_linenumber" name="L66" href="#L66">66</a> <em class="jxr_javadoccomment"> * (i.e. <code>en, es;q=0.8, zh-TW;q=0.1</code>).</em> +<a class="jxr_linenumber" name="L67" href="#L67">67</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L68" href="#L68">68</a> <strong class="jxr_keyword">public</strong> <a name="LocaleTokenizer" href="../../../../org/apache/fulcrum/localization/LocaleTokenizer.html#LocaleTokenizer">LocaleTokenizer</a>(String header) +<a class="jxr_linenumber" name="L69" href="#L69">69</a> { +<a class="jxr_linenumber" name="L70" href="#L70">70</a> StringTokenizer tok = <strong class="jxr_keyword">new</strong> StringTokenizer(header, LOCALE_SEPARATOR); +<a class="jxr_linenumber" name="L71" href="#L71">71</a> <strong class="jxr_keyword">while</strong> (tok.hasMoreTokens()) +<a class="jxr_linenumber" name="L72" href="#L72">72</a> { +<a class="jxr_linenumber" name="L73" href="#L73">73</a> AcceptLanguage acceptLang = <strong class="jxr_keyword">new</strong> AcceptLanguage(); +<a class="jxr_linenumber" name="L74" href="#L74">74</a> String element = tok.nextToken().trim(); +<a class="jxr_linenumber" name="L75" href="#L75">75</a> <strong class="jxr_keyword">int</strong> index; +<a class="jxr_linenumber" name="L76" href="#L76">76</a> +<a class="jxr_linenumber" name="L77" href="#L77">77</a> <em class="jxr_comment">// Record and cut off any quality value that comes after a</em> +<a class="jxr_linenumber" name="L78" href="#L78">78</a> <em class="jxr_comment">// semi-colon.</em> +<a class="jxr_linenumber" name="L79" href="#L79">79</a> <strong class="jxr_keyword">if</strong> ( (index = element.indexOf(QUALITY_SEPARATOR)) != -1 ) +<a class="jxr_linenumber" name="L80" href="#L80">80</a> { +<a class="jxr_linenumber" name="L81" href="#L81">81</a> String q = element.substring(index); +<a class="jxr_linenumber" name="L82" href="#L82">82</a> element = element.substring(0, index); +<a class="jxr_linenumber" name="L83" href="#L83">83</a> <strong class="jxr_keyword">if</strong> ( (index = q.indexOf('=')) != -1 ) +<a class="jxr_linenumber" name="L84" href="#L84">84</a> { +<a class="jxr_linenumber" name="L85" href="#L85">85</a> <strong class="jxr_keyword">try</strong> +<a class="jxr_linenumber" name="L86" href="#L86">86</a> { +<a class="jxr_linenumber" name="L87" href="#L87">87</a> acceptLang.quality = +<a class="jxr_linenumber" name="L88" href="#L88">88</a> Float.valueOf(q.substring(index + 1)); +<a class="jxr_linenumber" name="L89" href="#L89">89</a> } +<a class="jxr_linenumber" name="L90" href="#L90">90</a> <strong class="jxr_keyword">catch</strong> (NumberFormatException useDefault) +<a class="jxr_linenumber" name="L91" href="#L91">91</a> { +<a class="jxr_linenumber" name="L92" href="#L92">92</a> <em class="jxr_comment">// ignore</em> +<a class="jxr_linenumber" name="L93" href="#L93">93</a> } +<a class="jxr_linenumber" name="L94" href="#L94">94</a> } +<a class="jxr_linenumber" name="L95" href="#L95">95</a> } +<a class="jxr_linenumber" name="L96" href="#L96">96</a> +<a class="jxr_linenumber" name="L97" href="#L97">97</a> element = element.trim(); +<a class="jxr_linenumber" name="L98" href="#L98">98</a> +<a class="jxr_linenumber" name="L99" href="#L99">99</a> <em class="jxr_comment">// Create a Locale from the language. A dash may separate the</em> +<a class="jxr_linenumber" name="L100" href="#L100">100</a> <em class="jxr_comment">// language from the country.</em> +<a class="jxr_linenumber" name="L101" href="#L101">101</a> <strong class="jxr_keyword">if</strong> ( (index = element.indexOf('-')) == -1 ) +<a class="jxr_linenumber" name="L102" href="#L102">102</a> { +<a class="jxr_linenumber" name="L103" href="#L103">103</a> <em class="jxr_comment">// No dash means no country.</em> +<a class="jxr_linenumber" name="L104" href="#L104">104</a> acceptLang.locale = <strong class="jxr_keyword">new</strong> Locale(element, <span class="jxr_string">""</span>); +<a class="jxr_linenumber" name="L105" href="#L105">105</a> } +<a class="jxr_linenumber" name="L106" href="#L106">106</a> <strong class="jxr_keyword">else</strong> +<a class="jxr_linenumber" name="L107" href="#L107">107</a> { +<a class="jxr_linenumber" name="L108" href="#L108">108</a> acceptLang.locale = <strong class="jxr_keyword">new</strong> Locale(element.substring(0, index), +<a class="jxr_linenumber" name="L109" href="#L109">109</a> element.substring(index + 1)); +<a class="jxr_linenumber" name="L110" href="#L110">110</a> } +<a class="jxr_linenumber" name="L111" href="#L111">111</a> +<a class="jxr_linenumber" name="L112" href="#L112">112</a> locales.add(acceptLang); +<a class="jxr_linenumber" name="L113" href="#L113">113</a> } +<a class="jxr_linenumber" name="L114" href="#L114">114</a> +<a class="jxr_linenumber" name="L115" href="#L115">115</a> <em class="jxr_comment">// Sort by quality in descending order.</em> +<a class="jxr_linenumber" name="L116" href="#L116">116</a> Collections.sort(locales, Collections.reverseOrder()); +<a class="jxr_linenumber" name="L117" href="#L117">117</a> } +<a class="jxr_linenumber" name="L118" href="#L118">118</a> +<a class="jxr_linenumber" name="L119" href="#L119">119</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L120" href="#L120">120</a> <em class="jxr_javadoccomment"> * @return Whether there are more locales.</em> +<a class="jxr_linenumber" name="L121" href="#L121">121</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L122" href="#L122">122</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> hasNext() +<a class="jxr_linenumber" name="L123" href="#L123">123</a> { +<a class="jxr_linenumber" name="L124" href="#L124">124</a> <strong class="jxr_keyword">return</strong> !locales.isEmpty(); +<a class="jxr_linenumber" name="L125" href="#L125">125</a> } +<a class="jxr_linenumber" name="L126" href="#L126">126</a> +<a class="jxr_linenumber" name="L127" href="#L127">127</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L128" href="#L128">128</a> <em class="jxr_javadoccomment"> * Creates a <code>Locale</code> from the next element of the</em> +<a class="jxr_linenumber" name="L129" href="#L129">129</a> <em class="jxr_javadoccomment"> * <code>Accept-Language</code> header.</em> +<a class="jxr_linenumber" name="L130" href="#L130">130</a> <em class="jxr_javadoccomment"> *</em> +<a class="jxr_linenumber" name="L131" href="#L131">131</a> <em class="jxr_javadoccomment"> * @return The next highest-rated <code>Locale</code>.</em> +<a class="jxr_linenumber" name="L132" href="#L132">132</a> <em class="jxr_javadoccomment"> * @throws NoSuchElementException No more locales.</em> +<a class="jxr_linenumber" name="L133" href="#L133">133</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L134" href="#L134">134</a> <strong class="jxr_keyword">public</strong> Object next() +<a class="jxr_linenumber" name="L135" href="#L135">135</a> { +<a class="jxr_linenumber" name="L136" href="#L136">136</a> <strong class="jxr_keyword">if</strong> (locales.isEmpty()) +<a class="jxr_linenumber" name="L137" href="#L137">137</a> { +<a class="jxr_linenumber" name="L138" href="#L138">138</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NoSuchElementException(); +<a class="jxr_linenumber" name="L139" href="#L139">139</a> } +<a class="jxr_linenumber" name="L140" href="#L140">140</a> <strong class="jxr_keyword">return</strong> ((AcceptLanguage) locales.remove(0)).locale; +<a class="jxr_linenumber" name="L141" href="#L141">141</a> } +<a class="jxr_linenumber" name="L142" href="#L142">142</a> +<a class="jxr_linenumber" name="L143" href="#L143">143</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L144" href="#L144">144</a> <em class="jxr_javadoccomment"> * Not implemented.</em> +<a class="jxr_linenumber" name="L145" href="#L145">145</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L146" href="#L146">146</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> remove() +<a class="jxr_linenumber" name="L147" href="#L147">147</a> { +<a class="jxr_linenumber" name="L148" href="#L148">148</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> UnsupportedOperationException(getClass().getName() + +<a class="jxr_linenumber" name="L149" href="#L149">149</a> <span class="jxr_string">" does not support remove()"</span>); +<a class="jxr_linenumber" name="L150" href="#L150">150</a> } +<a class="jxr_linenumber" name="L151" href="#L151">151</a> +<a class="jxr_linenumber" name="L152" href="#L152">152</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L153" href="#L153">153</a> <em class="jxr_javadoccomment"> * Struct representing an element of the HTTP</em> +<a class="jxr_linenumber" name="L154" href="#L154">154</a> <em class="jxr_javadoccomment"> * <code>Accept-Language</code> header.</em> +<a class="jxr_linenumber" name="L155" href="#L155">155</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L156" href="#L156">156</a> <strong class="jxr_keyword">protected</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">class</strong> AcceptLanguage <strong class="jxr_keyword">implements</strong> Comparable<Object> +<a class="jxr_linenumber" name="L157" href="#L157">157</a> { +<a class="jxr_linenumber" name="L158" href="#L158">158</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L159" href="#L159">159</a> <em class="jxr_javadoccomment"> * The language and country.</em> +<a class="jxr_linenumber" name="L160" href="#L160">160</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L161" href="#L161">161</a> Locale locale; +<a class="jxr_linenumber" name="L162" href="#L162">162</a> +<a class="jxr_linenumber" name="L163" href="#L163">163</a> <em class="jxr_javadoccomment">/**</em> +<a class="jxr_linenumber" name="L164" href="#L164">164</a> <em class="jxr_javadoccomment"> * The quality of our locale (as values approach</em> +<a class="jxr_linenumber" name="L165" href="#L165">165</a> <em class="jxr_javadoccomment"> * <code>1.0</code>, they indicate increased user preference).</em> +<a class="jxr_linenumber" name="L166" href="#L166">166</a> <em class="jxr_javadoccomment"> */</em> +<a class="jxr_linenumber" name="L167" href="#L167">167</a> Float quality = DEFAULT_QUALITY; +<a class="jxr_linenumber" name="L168" href="#L168">168</a> +<a class="jxr_linenumber" name="L169" href="#L169">169</a> @Override +<a class="jxr_linenumber" name="L170" href="#L170">170</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> compareTo(Object acceptLang) +<a class="jxr_linenumber" name="L171" href="#L171">171</a> { +<a class="jxr_linenumber" name="L172" href="#L172">172</a> <strong class="jxr_keyword">if</strong> ( acceptLang == <strong class="jxr_keyword">null</strong> ) +<a class="jxr_linenumber" name="L173" href="#L173">173</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"AcceptLanguage not found"</span>); +<a class="jxr_linenumber" name="L174" href="#L174">174</a> +<a class="jxr_linenumber" name="L175" href="#L175">175</a> <strong class="jxr_keyword">if</strong> ( acceptLang instanceof AcceptLanguage ) +<a class="jxr_linenumber" name="L176" href="#L176">176</a> { +<a class="jxr_linenumber" name="L177" href="#L177">177</a> Float q2 = ((AcceptLanguage) acceptLang).quality; +<a class="jxr_linenumber" name="L178" href="#L178">178</a> <strong class="jxr_keyword">return</strong> quality.compareTo( q2 ); +<a class="jxr_linenumber" name="L179" href="#L179">179</a> } <strong class="jxr_keyword">else</strong> { +<a class="jxr_linenumber" name="L180" href="#L180">180</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> NullPointerException(<span class="jxr_string">"The object to compare is not the correct type"</span>); +<a class="jxr_linenumber" name="L181" href="#L181">181</a> } +<a class="jxr_linenumber" name="L182" href="#L182">182</a> +<a class="jxr_linenumber" name="L183" href="#L183">183</a> } +<a class="jxr_linenumber" name="L184" href="#L184">184</a> } +<a class="jxr_linenumber" name="L185" href="#L185">185</a> } </pre> -<hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/";>Maven</a></div></body> -</html> - +<hr/> +<div id="footer">Copyright © 2005–2019 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> +</html> \ No newline at end of file
Modified: websites/production/turbine/content/fulcrum/fulcrum-localization/xref/org/apache/fulcrum/localization/LocalizationService.html ============================================================================== --- websites/production/turbine/content/fulcrum/fulcrum-localization/xref/org/apache/fulcrum/localization/LocalizationService.html (original) +++ websites/production/turbine/content/fulcrum/fulcrum-localization/xref/org/apache/fulcrum/localization/LocalizationService.html Tue May 21 03:35:35 2019 @@ -1,126 +1,129 @@ <!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=ISO-8859-1" /> +<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 name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.fulcrum.localization; -<a name="2" href="#2">2</a> -<a name="3" href="#3">3</a> -<a name="4" href="#4">4</a> <em class="jxr_comment">/*</em> -<a name="5" href="#5">5</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em> -<a name="6" href="#6">6</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em> -<a name="7" href="#7">7</a> <em class="jxr_comment"> * distributed with this work for additional information</em> -<a name="8" href="#8">8</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em> -<a name="9" href="#9">9</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em> -<a name="10" href="#10">10</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em> -<a name="11" href="#11">11</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em> -<a name="12" href="#12">12</a> <em class="jxr_comment"> *</em> -<a name="13" href="#13">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 name="14" href="#14">14</a> <em class="jxr_comment"> *</em> -<a name="15" href="#15">15</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em> -<a name="16" href="#16">16</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em> -<a name="17" href="#17">17</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em> -<a name="18" href="#18">18</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em> -<a name="19" href="#19">19</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em> -<a name="20" href="#20">20</a> <em class="jxr_comment"> * under the License.</em> -<a name="21" href="#21">21</a> <em class="jxr_comment"> */</em> -<a name="22" href="#22">22</a> -<a name="23" href="#23">23</a> -<a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.util.Locale; -<a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.util.ResourceBundle; -<a name="26" href="#26">26</a> -<a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> javax.servlet.http.HttpServletRequest; -<a name="28" href="#28">28</a> -<a name="29" href="#29">29</a> <em class="jxr_javadoccomment">/**</em> -<a name="30" href="#30">30</a> <em class="jxr_javadoccomment"> * <p>Provides localization functionality using the interface provided</em> -<a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * by <code>ResourceBundle</code>, plus leverages a "search path"</em> -<a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * style traversal of the <code>ResourceBundle</code> objects named by</em> -<a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> * the <code>locale.default.bundles</code> to discover a value for a</em> -<a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * given key.</p></em> -<a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> *</em> -<a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> * <p>It is suggested that one handle</em> -<a name="37" href="#37">37</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 name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * using <code>MessageFormat</code> and properties files.</p></em> -<a name="39" href="#39">39</a> <em class="jxr_javadoccomment"> *</em> -<a name="40" href="#40">40</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Jon S. Stevens</a></em> -<a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Daniel Rall</a></em> -<a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Leonard Richardson</a></em> -<a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Stephen McConnell</a></em> -<a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Thomas Vandahl</a></em> -<a name="45" href="#45">45</a> <em class="jxr_javadoccomment"> * @version $Id: LocalizationService.java 645885 2008-04-08 12:50:57Z tv $</em> -<a name="46" href="#46">46</a> <em class="jxr_javadoccomment"> */</em> -<a name="47" href="#47">47</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">interface</strong> <a href="../../../../org/apache/fulcrum/localization/LocalizationService.html">LocalizationService</a> <strong class="jxr_keyword">extends</strong> <a href="../../../../org/apache/fulcrum/localization/SimpleLocalizationService.html">SimpleLocalizationService</a> -<a name="48" href="#48">48</a> { -<a name="49" href="#49">49</a> String ROLE = LocalizationService.<strong class="jxr_keyword">class</strong>.getName(); -<a name="50" href="#50">50</a> String SERVICE_NAME = ROLE; -<a name="51" href="#51">51</a> -<a name="52" href="#52">52</a> <em class="jxr_javadoccomment">/**</em> -<a name="53" href="#53">53</a> <em class="jxr_javadoccomment"> * A constant for the HTTP <code>Accept-Language</code> header.</em> -<a name="54" href="#54">54</a> <em class="jxr_javadoccomment"> */</em> -<a name="55" href="#55">55</a> String ACCEPT_LANGUAGE = <span class="jxr_string">"Accept-Language"</span>; -<a name="56" href="#56">56</a> -<a name="57" href="#57">57</a> <em class="jxr_javadoccomment">/**</em> -<a name="58" href="#58">58</a> <em class="jxr_javadoccomment"> * Convenience method to get a ResourceBundle based on name and</em> -<a name="59" href="#59">59</a> <em class="jxr_javadoccomment"> * HTTP <code>Accept-Language</code> header.</em> -<a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> *</em> -<a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * @param bundleName Name of bundle.</em> -<a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> * @param languageHeader A String with the language header.</em> -<a name="63" href="#63">63</a> <em class="jxr_javadoccomment"> * @return A localized ResourceBundle.</em> -<a name="64" href="#64">64</a> <em class="jxr_javadoccomment"> */</em> -<a name="65" href="#65">65</a> ResourceBundle getBundle(String bundleName, String languageHeader); -<a name="66" href="#66">66</a> -<a name="67" href="#67">67</a> <em class="jxr_javadoccomment">/**</em> -<a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * Convenience method to get a ResourceBundle based on HTTP</em> -<a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> * Accept-Language header in HttpServletRequest.</em> -<a name="70" href="#70">70</a> <em class="jxr_javadoccomment"> *</em> -<a name="71" href="#71">71</a> <em class="jxr_javadoccomment"> * @param req The HTTP request to parse the</em> -<a name="72" href="#72">72</a> <em class="jxr_javadoccomment"> * <code>Accept-Language</code> of.</em> -<a name="73" href="#73">73</a> <em class="jxr_javadoccomment"> * @return A localized ResourceBundle.</em> -<a name="74" href="#74">74</a> <em class="jxr_javadoccomment"> */</em> -<a name="75" href="#75">75</a> ResourceBundle getBundle(HttpServletRequest req); -<a name="76" href="#76">76</a> -<a name="77" href="#77">77</a> <em class="jxr_javadoccomment">/**</em> -<a name="78" href="#78">78</a> <em class="jxr_javadoccomment"> * Convenience method to get a <code>ResourceBundle</code> based</em> -<a name="79" href="#79">79</a> <em class="jxr_javadoccomment"> * on name and HTTP <code>Accept-Language</code> header from a</em> -<a name="80" href="#80">80</a> <em class="jxr_javadoccomment"> * <code>HttpServletRequest</code>.</em> -<a name="81" href="#81">81</a> <em class="jxr_javadoccomment"> *</em> -<a name="82" href="#82">82</a> <em class="jxr_javadoccomment"> * @param bundleName Name of bundle.</em> -<a name="83" href="#83">83</a> <em class="jxr_javadoccomment"> * @param req The HTTP request to parse the</em> -<a name="84" href="#84">84</a> <em class="jxr_javadoccomment"> * <code>Accept-Language</code> of.</em> -<a name="85" href="#85">85</a> <em class="jxr_javadoccomment"> * @return A localized ResourceBundle.</em> -<a name="86" href="#86">86</a> <em class="jxr_javadoccomment"> */</em> -<a name="87" href="#87">87</a> ResourceBundle getBundle(String bundleName, HttpServletRequest req); -<a name="88" href="#88">88</a> -<a name="89" href="#89">89</a> <em class="jxr_javadoccomment">/**</em> -<a name="90" href="#90">90</a> <em class="jxr_javadoccomment"> * Attempts to pull the <code>Accept-Language</code> header out of</em> -<a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> * the <code>HttpServletRequest</code> object and then parse it.</em> -<a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * If the header is not present, it will return a</em> -<a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> * <code>null</code> <code>Locale</code>.</em> -<a name="94" href="#94">94</a> <em class="jxr_javadoccomment"> *</em> -<a name="95" href="#95">95</a> <em class="jxr_javadoccomment"> * @param req The HTTP request to parse the</em> -<a name="96" href="#96">96</a> <em class="jxr_javadoccomment"> * <code>Accept-Language</code> of.</em> -<a name="97" href="#97">97</a> <em class="jxr_javadoccomment"> * @return The parsed locale.</em> -<a name="98" href="#98">98</a> <em class="jxr_javadoccomment"> */</em> -<a name="99" href="#99">99</a> Locale getLocale(HttpServletRequest req); -<a name="100" href="#100">100</a> -<a name="101" href="#101">101</a> <em class="jxr_javadoccomment">/**</em> -<a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> * Parses the <code>Accept-Language</code> header and attempts to</em> -<a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * create a <code>Locale</code> from it.</em> -<a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> *</em> -<a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> * @param header The language header (i.e. <code>en, es;q=0.8,</em> -<a name="106" href="#106">106</a> <em class="jxr_javadoccomment"> * zh-TW;q=0.1</code>), or <code>null</code> for the locale</em> -<a name="107" href="#107">107</a> <em class="jxr_javadoccomment"> * corresponding to the default language and country.</em> -<a name="108" href="#108">108</a> <em class="jxr_javadoccomment"> * @return The parsed locale, or a locale corresponding to the</em> -<a name="109" href="#109">109</a> <em class="jxr_javadoccomment"> * language and country defaults.</em> -<a name="110" href="#110">110</a> <em class="jxr_javadoccomment"> */</em> -<a name="111" href="#111">111</a> Locale getLocale(String languageHeader); -<a name="112" href="#112">112</a> } +<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:[email protected]"; target="alexandria_uri">mailto:[email protected]</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:[email protected]"; target="alexandria_uri">mailto:[email protected]</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:[email protected]"; target="alexandria_uri">mailto:[email protected]</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:[email protected]"; target="alexandria_uri">mailto:[email protected]</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:[email protected]"; target="alexandria_uri">mailto:[email protected]</a>">Thomas Vandahl</a></em> +<a class="jxr_linenumber" name="L49" href="#L49">49</a> <em class="jxr_javadoccomment"> * @version $Id: LocalizationService.java 1851408 2019-01-15 19:31:48Z painter $</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">This page was automatically generated by <a href="http://maven.apache.org/";>Maven</a></div></body> -</html> - +<hr/> +<div id="footer">Copyright © 2005–2019 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</div> +</body> +</html> \ No newline at end of file
