blob: d6c01125089d1521c395d468e7401848fe6e357d [file] [log] [blame]
<!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.ArrayList;</a>
<span class="sourceLineNo">024</span><a id="line.24">import java.util.Collections;</a>
<span class="sourceLineNo">025</span><a id="line.25">import java.util.Iterator;</a>
<span class="sourceLineNo">026</span><a id="line.26">import java.util.Locale;</a>
<span class="sourceLineNo">027</span><a id="line.27">import java.util.NoSuchElementException;</a>
<span class="sourceLineNo">028</span><a id="line.28">import java.util.StringTokenizer;</a>
<span class="sourceLineNo">029</span><a id="line.29"></a>
<span class="sourceLineNo">030</span><a id="line.30">/**</a>
<span class="sourceLineNo">031</span><a id="line.31"> * Parses the HTTP &lt;code&gt;Accept-Language&lt;/code&gt; header as per section</a>
<span class="sourceLineNo">032</span><a id="line.32"> * 14.4 of RFC 2068 (HTTP 1.1 header field definitions).</a>
<span class="sourceLineNo">033</span><a id="line.33"> *</a>
<span class="sourceLineNo">034</span><a id="line.34"> * @author &lt;a href="mailto:dlr@collab.net"&gt;Daniel Rall&lt;/a&gt;</a>
<span class="sourceLineNo">035</span><a id="line.35"> * @version $Id$</a>
<span class="sourceLineNo">036</span><a id="line.36"> */</a>
<span class="sourceLineNo">037</span><a id="line.37">public class LocaleTokenizer</a>
<span class="sourceLineNo">038</span><a id="line.38"> implements Iterator&lt;Object&gt;</a>
<span class="sourceLineNo">039</span><a id="line.39">{</a>
<span class="sourceLineNo">040</span><a id="line.40"> /**</a>
<span class="sourceLineNo">041</span><a id="line.41"> * Separates elements of the &lt;code&gt;Accept-Language&lt;/code&gt; HTTP</a>
<span class="sourceLineNo">042</span><a id="line.42"> * header.</a>
<span class="sourceLineNo">043</span><a id="line.43"> */</a>
<span class="sourceLineNo">044</span><a id="line.44"> private static final String LOCALE_SEPARATOR = ",";</a>
<span class="sourceLineNo">045</span><a id="line.45"></a>
<span class="sourceLineNo">046</span><a id="line.46"> /**</a>
<span class="sourceLineNo">047</span><a id="line.47"> * Separates locale from quality within elements.</a>
<span class="sourceLineNo">048</span><a id="line.48"> */</a>
<span class="sourceLineNo">049</span><a id="line.49"> private static final char QUALITY_SEPARATOR = ';';</a>
<span class="sourceLineNo">050</span><a id="line.50"></a>
<span class="sourceLineNo">051</span><a id="line.51"> /**</a>
<span class="sourceLineNo">052</span><a id="line.52"> * The default quality value for an &lt;code&gt;AcceptLanguage&lt;/code&gt;</a>
<span class="sourceLineNo">053</span><a id="line.53"> * object.</a>
<span class="sourceLineNo">054</span><a id="line.54"> */</a>
<span class="sourceLineNo">055</span><a id="line.55"> protected static final Float DEFAULT_QUALITY = new Float(1.0f);</a>
<span class="sourceLineNo">056</span><a id="line.56"></a>
<span class="sourceLineNo">057</span><a id="line.57"> /**</a>
<span class="sourceLineNo">058</span><a id="line.58"> * The parsed locales.</a>
<span class="sourceLineNo">059</span><a id="line.59"> */</a>
<span class="sourceLineNo">060</span><a id="line.60"> private ArrayList&lt;AcceptLanguage&gt; locales = new ArrayList&lt;AcceptLanguage&gt;(3);</a>
<span class="sourceLineNo">061</span><a id="line.61"></a>
<span class="sourceLineNo">062</span><a id="line.62"> /**</a>
<span class="sourceLineNo">063</span><a id="line.63"> * Parses the &lt;code&gt;Accept-Language&lt;/code&gt; header.</a>
<span class="sourceLineNo">064</span><a id="line.64"> *</a>
<span class="sourceLineNo">065</span><a id="line.65"> * @param header The &lt;code&gt;Accept-Language&lt;/code&gt; header</a>
<span class="sourceLineNo">066</span><a id="line.66"> * (i.e. &lt;code&gt;en, es;q=0.8, zh-TW;q=0.1&lt;/code&gt;).</a>
<span class="sourceLineNo">067</span><a id="line.67"> */</a>
<span class="sourceLineNo">068</span><a id="line.68"> public LocaleTokenizer(String header)</a>
<span class="sourceLineNo">069</span><a id="line.69"> {</a>
<span class="sourceLineNo">070</span><a id="line.70"> StringTokenizer tok = new StringTokenizer(header, LOCALE_SEPARATOR);</a>
<span class="sourceLineNo">071</span><a id="line.71"> while (tok.hasMoreTokens())</a>
<span class="sourceLineNo">072</span><a id="line.72"> {</a>
<span class="sourceLineNo">073</span><a id="line.73"> AcceptLanguage acceptLang = new AcceptLanguage();</a>
<span class="sourceLineNo">074</span><a id="line.74"> String element = tok.nextToken().trim();</a>
<span class="sourceLineNo">075</span><a id="line.75"> int index;</a>
<span class="sourceLineNo">076</span><a id="line.76"></a>
<span class="sourceLineNo">077</span><a id="line.77"> // Record and cut off any quality value that comes after a</a>
<span class="sourceLineNo">078</span><a id="line.78"> // semi-colon.</a>
<span class="sourceLineNo">079</span><a id="line.79"> if ( (index = element.indexOf(QUALITY_SEPARATOR)) != -1 )</a>
<span class="sourceLineNo">080</span><a id="line.80"> {</a>
<span class="sourceLineNo">081</span><a id="line.81"> String q = element.substring(index);</a>
<span class="sourceLineNo">082</span><a id="line.82"> element = element.substring(0, index);</a>
<span class="sourceLineNo">083</span><a id="line.83"> if ( (index = q.indexOf('=')) != -1 )</a>
<span class="sourceLineNo">084</span><a id="line.84"> {</a>
<span class="sourceLineNo">085</span><a id="line.85"> try</a>
<span class="sourceLineNo">086</span><a id="line.86"> {</a>
<span class="sourceLineNo">087</span><a id="line.87"> acceptLang.quality =</a>
<span class="sourceLineNo">088</span><a id="line.88"> Float.valueOf(q.substring(index + 1));</a>
<span class="sourceLineNo">089</span><a id="line.89"> }</a>
<span class="sourceLineNo">090</span><a id="line.90"> catch (NumberFormatException useDefault)</a>
<span class="sourceLineNo">091</span><a id="line.91"> {</a>
<span class="sourceLineNo">092</span><a id="line.92"> // ignore</a>
<span class="sourceLineNo">093</span><a id="line.93"> }</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"></a>
<span class="sourceLineNo">097</span><a id="line.97"> element = element.trim();</a>
<span class="sourceLineNo">098</span><a id="line.98"></a>
<span class="sourceLineNo">099</span><a id="line.99"> // Create a Locale from the language. A dash may separate the</a>
<span class="sourceLineNo">100</span><a id="line.100"> // language from the country.</a>
<span class="sourceLineNo">101</span><a id="line.101"> if ( (index = element.indexOf('-')) == -1 )</a>
<span class="sourceLineNo">102</span><a id="line.102"> {</a>
<span class="sourceLineNo">103</span><a id="line.103"> // No dash means no country.</a>
<span class="sourceLineNo">104</span><a id="line.104"> acceptLang.locale = new Locale(element, "");</a>
<span class="sourceLineNo">105</span><a id="line.105"> }</a>
<span class="sourceLineNo">106</span><a id="line.106"> else</a>
<span class="sourceLineNo">107</span><a id="line.107"> {</a>
<span class="sourceLineNo">108</span><a id="line.108"> acceptLang.locale = new Locale(element.substring(0, index),</a>
<span class="sourceLineNo">109</span><a id="line.109"> element.substring(index + 1));</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"> locales.add(acceptLang);</a>
<span class="sourceLineNo">113</span><a id="line.113"> }</a>
<span class="sourceLineNo">114</span><a id="line.114"></a>
<span class="sourceLineNo">115</span><a id="line.115"> // Sort by quality in descending order.</a>
<span class="sourceLineNo">116</span><a id="line.116"> Collections.sort(locales, Collections.reverseOrder());</a>
<span class="sourceLineNo">117</span><a id="line.117"> }</a>
<span class="sourceLineNo">118</span><a id="line.118"></a>
<span class="sourceLineNo">119</span><a id="line.119"> /**</a>
<span class="sourceLineNo">120</span><a id="line.120"> * @return Whether there are more locales.</a>
<span class="sourceLineNo">121</span><a id="line.121"> */</a>
<span class="sourceLineNo">122</span><a id="line.122"> public boolean hasNext()</a>
<span class="sourceLineNo">123</span><a id="line.123"> {</a>
<span class="sourceLineNo">124</span><a id="line.124"> return !locales.isEmpty();</a>
<span class="sourceLineNo">125</span><a id="line.125"> }</a>
<span class="sourceLineNo">126</span><a id="line.126"></a>
<span class="sourceLineNo">127</span><a id="line.127"> /**</a>
<span class="sourceLineNo">128</span><a id="line.128"> * Creates a &lt;code&gt;Locale&lt;/code&gt; from the next element of the</a>
<span class="sourceLineNo">129</span><a id="line.129"> * &lt;code&gt;Accept-Language&lt;/code&gt; header.</a>
<span class="sourceLineNo">130</span><a id="line.130"> *</a>
<span class="sourceLineNo">131</span><a id="line.131"> * @return The next highest-rated &lt;code&gt;Locale&lt;/code&gt;.</a>
<span class="sourceLineNo">132</span><a id="line.132"> * @throws NoSuchElementException No more locales.</a>
<span class="sourceLineNo">133</span><a id="line.133"> */</a>
<span class="sourceLineNo">134</span><a id="line.134"> public Object next()</a>
<span class="sourceLineNo">135</span><a id="line.135"> {</a>
<span class="sourceLineNo">136</span><a id="line.136"> if (locales.isEmpty())</a>
<span class="sourceLineNo">137</span><a id="line.137"> {</a>
<span class="sourceLineNo">138</span><a id="line.138"> throw new NoSuchElementException();</a>
<span class="sourceLineNo">139</span><a id="line.139"> }</a>
<span class="sourceLineNo">140</span><a id="line.140"> return ((AcceptLanguage) locales.remove(0)).locale;</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"> /**</a>
<span class="sourceLineNo">144</span><a id="line.144"> * Not implemented.</a>
<span class="sourceLineNo">145</span><a id="line.145"> */</a>
<span class="sourceLineNo">146</span><a id="line.146"> public final void remove()</a>
<span class="sourceLineNo">147</span><a id="line.147"> {</a>
<span class="sourceLineNo">148</span><a id="line.148"> throw new UnsupportedOperationException(getClass().getName() +</a>
<span class="sourceLineNo">149</span><a id="line.149"> " does not support remove()");</a>
<span class="sourceLineNo">150</span><a id="line.150"> }</a>
<span class="sourceLineNo">151</span><a id="line.151"></a>
<span class="sourceLineNo">152</span><a id="line.152"> /**</a>
<span class="sourceLineNo">153</span><a id="line.153"> * Struct representing an element of the HTTP</a>
<span class="sourceLineNo">154</span><a id="line.154"> * &lt;code&gt;Accept-Language&lt;/code&gt; header.</a>
<span class="sourceLineNo">155</span><a id="line.155"> */</a>
<span class="sourceLineNo">156</span><a id="line.156"> protected static class AcceptLanguage implements Comparable&lt;Object&gt;</a>
<span class="sourceLineNo">157</span><a id="line.157"> {</a>
<span class="sourceLineNo">158</span><a id="line.158"> /**</a>
<span class="sourceLineNo">159</span><a id="line.159"> * The language and country.</a>
<span class="sourceLineNo">160</span><a id="line.160"> */</a>
<span class="sourceLineNo">161</span><a id="line.161"> Locale locale;</a>
<span class="sourceLineNo">162</span><a id="line.162"></a>
<span class="sourceLineNo">163</span><a id="line.163"> /**</a>
<span class="sourceLineNo">164</span><a id="line.164"> * The quality of our locale (as values approach</a>
<span class="sourceLineNo">165</span><a id="line.165"> * &lt;code&gt;1.0&lt;/code&gt;, they indicate increased user preference).</a>
<span class="sourceLineNo">166</span><a id="line.166"> */</a>
<span class="sourceLineNo">167</span><a id="line.167"> Float quality = DEFAULT_QUALITY;</a>
<span class="sourceLineNo">168</span><a id="line.168"> </a>
<span class="sourceLineNo">169</span><a id="line.169"> @Override</a>
<span class="sourceLineNo">170</span><a id="line.170"> public int compareTo(Object acceptLang)</a>
<span class="sourceLineNo">171</span><a id="line.171"> {</a>
<span class="sourceLineNo">172</span><a id="line.172"> if ( acceptLang == null )</a>
<span class="sourceLineNo">173</span><a id="line.173"> throw new NullPointerException("AcceptLanguage not found");</a>
<span class="sourceLineNo">174</span><a id="line.174"> </a>
<span class="sourceLineNo">175</span><a id="line.175"> if ( acceptLang instanceof AcceptLanguage )</a>
<span class="sourceLineNo">176</span><a id="line.176"> {</a>
<span class="sourceLineNo">177</span><a id="line.177"> Float q2 = ((AcceptLanguage) acceptLang).quality;</a>
<span class="sourceLineNo">178</span><a id="line.178"> return quality.compareTo( q2 );</a>
<span class="sourceLineNo">179</span><a id="line.179"> } else {</a>
<span class="sourceLineNo">180</span><a id="line.180"> throw new NullPointerException("The object to compare is not the correct type");</a>
<span class="sourceLineNo">181</span><a id="line.181"> }</a>
<span class="sourceLineNo">182</span><a id="line.182"> </a>
<span class="sourceLineNo">183</span><a id="line.183"> }</a>
<span class="sourceLineNo">184</span><a id="line.184"> }</a>
<span class="sourceLineNo">185</span><a id="line.185">}</a>
</pre>
</div>
</main>
</body>
</html>