blob: fe17638ffa4e2f50a48e950d7e04093113e6d416 [file] [log] [blame]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>package org.apache.fulcrum.localization;<a name="line.1"></a>
<span class="sourceLineNo">002</span><a name="line.2"></a>
<span class="sourceLineNo">003</span>/*<a name="line.3"></a>
<span class="sourceLineNo">004</span> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.4"></a>
<span class="sourceLineNo">005</span> * or more contributor license agreements. See the NOTICE file<a name="line.5"></a>
<span class="sourceLineNo">006</span> * distributed with this work for additional information<a name="line.6"></a>
<span class="sourceLineNo">007</span> * regarding copyright ownership. The ASF licenses this file<a name="line.7"></a>
<span class="sourceLineNo">008</span> * to you under the Apache License, Version 2.0 (the<a name="line.8"></a>
<span class="sourceLineNo">009</span> * "License"); you may not use this file except in compliance<a name="line.9"></a>
<span class="sourceLineNo">010</span> * with the License. You may obtain a copy of the License at<a name="line.10"></a>
<span class="sourceLineNo">011</span> *<a name="line.11"></a>
<span class="sourceLineNo">012</span> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.12"></a>
<span class="sourceLineNo">013</span> *<a name="line.13"></a>
<span class="sourceLineNo">014</span> * Unless required by applicable law or agreed to in writing,<a name="line.14"></a>
<span class="sourceLineNo">015</span> * software distributed under the License is distributed on an<a name="line.15"></a>
<span class="sourceLineNo">016</span> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY<a name="line.16"></a>
<span class="sourceLineNo">017</span> * KIND, either express or implied. See the License for the<a name="line.17"></a>
<span class="sourceLineNo">018</span> * specific language governing permissions and limitations<a name="line.18"></a>
<span class="sourceLineNo">019</span> * under the License.<a name="line.19"></a>
<span class="sourceLineNo">020</span> */<a name="line.20"></a>
<span class="sourceLineNo">021</span><a name="line.21"></a>
<span class="sourceLineNo">022</span><a name="line.22"></a>
<span class="sourceLineNo">023</span>import java.util.ArrayList;<a name="line.23"></a>
<span class="sourceLineNo">024</span>import java.util.Collections;<a name="line.24"></a>
<span class="sourceLineNo">025</span>import java.util.Iterator;<a name="line.25"></a>
<span class="sourceLineNo">026</span>import java.util.Locale;<a name="line.26"></a>
<span class="sourceLineNo">027</span>import java.util.NoSuchElementException;<a name="line.27"></a>
<span class="sourceLineNo">028</span>import java.util.Objects;<a name="line.28"></a>
<span class="sourceLineNo">029</span>import java.util.StringTokenizer;<a name="line.29"></a>
<span class="sourceLineNo">030</span><a name="line.30"></a>
<span class="sourceLineNo">031</span>/**<a name="line.31"></a>
<span class="sourceLineNo">032</span> * Parses the HTTP &lt;code&gt;Accept-Language&lt;/code&gt; header as per section<a name="line.32"></a>
<span class="sourceLineNo">033</span> * 14.4 of RFC 2068 (HTTP 1.1 header field definitions).<a name="line.33"></a>
<span class="sourceLineNo">034</span> *<a name="line.34"></a>
<span class="sourceLineNo">035</span> * @author &lt;a href="mailto:dlr@collab.net"&gt;Daniel Rall&lt;/a&gt;<a name="line.35"></a>
<span class="sourceLineNo">036</span> * @version $Id$<a name="line.36"></a>
<span class="sourceLineNo">037</span> */<a name="line.37"></a>
<span class="sourceLineNo">038</span>public class LocaleTokenizer<a name="line.38"></a>
<span class="sourceLineNo">039</span> implements Iterator&lt;Object&gt;<a name="line.39"></a>
<span class="sourceLineNo">040</span>{<a name="line.40"></a>
<span class="sourceLineNo">041</span> /**<a name="line.41"></a>
<span class="sourceLineNo">042</span> * Separates elements of the &lt;code&gt;Accept-Language&lt;/code&gt; HTTP<a name="line.42"></a>
<span class="sourceLineNo">043</span> * header.<a name="line.43"></a>
<span class="sourceLineNo">044</span> */<a name="line.44"></a>
<span class="sourceLineNo">045</span> private static final String LOCALE_SEPARATOR = ",";<a name="line.45"></a>
<span class="sourceLineNo">046</span><a name="line.46"></a>
<span class="sourceLineNo">047</span> /**<a name="line.47"></a>
<span class="sourceLineNo">048</span> * Separates locale from quality within elements.<a name="line.48"></a>
<span class="sourceLineNo">049</span> */<a name="line.49"></a>
<span class="sourceLineNo">050</span> private static final char QUALITY_SEPARATOR = ';';<a name="line.50"></a>
<span class="sourceLineNo">051</span><a name="line.51"></a>
<span class="sourceLineNo">052</span> /**<a name="line.52"></a>
<span class="sourceLineNo">053</span> * The default quality value for an &lt;code&gt;AcceptLanguage&lt;/code&gt;<a name="line.53"></a>
<span class="sourceLineNo">054</span> * object.<a name="line.54"></a>
<span class="sourceLineNo">055</span> */<a name="line.55"></a>
<span class="sourceLineNo">056</span> protected static final Float DEFAULT_QUALITY = 1.0f;<a name="line.56"></a>
<span class="sourceLineNo">057</span><a name="line.57"></a>
<span class="sourceLineNo">058</span> /**<a name="line.58"></a>
<span class="sourceLineNo">059</span> * The parsed locales.<a name="line.59"></a>
<span class="sourceLineNo">060</span> */<a name="line.60"></a>
<span class="sourceLineNo">061</span> private ArrayList&lt;AcceptLanguage&gt; locales = new ArrayList&lt;&gt;(3);<a name="line.61"></a>
<span class="sourceLineNo">062</span><a name="line.62"></a>
<span class="sourceLineNo">063</span> /**<a name="line.63"></a>
<span class="sourceLineNo">064</span> * Parses the &lt;code&gt;Accept-Language&lt;/code&gt; header.<a name="line.64"></a>
<span class="sourceLineNo">065</span> *<a name="line.65"></a>
<span class="sourceLineNo">066</span> * @param header The &lt;code&gt;Accept-Language&lt;/code&gt; header<a name="line.66"></a>
<span class="sourceLineNo">067</span> * (i.e. &lt;code&gt;en, es;q=0.8, zh-TW;q=0.1&lt;/code&gt;).<a name="line.67"></a>
<span class="sourceLineNo">068</span> */<a name="line.68"></a>
<span class="sourceLineNo">069</span> public LocaleTokenizer(String header)<a name="line.69"></a>
<span class="sourceLineNo">070</span> {<a name="line.70"></a>
<span class="sourceLineNo">071</span> StringTokenizer tok = new StringTokenizer(header, LOCALE_SEPARATOR);<a name="line.71"></a>
<span class="sourceLineNo">072</span> while (tok.hasMoreTokens())<a name="line.72"></a>
<span class="sourceLineNo">073</span> {<a name="line.73"></a>
<span class="sourceLineNo">074</span> AcceptLanguage acceptLang = new AcceptLanguage();<a name="line.74"></a>
<span class="sourceLineNo">075</span> String element = tok.nextToken().trim();<a name="line.75"></a>
<span class="sourceLineNo">076</span> int index;<a name="line.76"></a>
<span class="sourceLineNo">077</span><a name="line.77"></a>
<span class="sourceLineNo">078</span> // Record and cut off any quality value that comes after a<a name="line.78"></a>
<span class="sourceLineNo">079</span> // semi-colon.<a name="line.79"></a>
<span class="sourceLineNo">080</span> if ( (index = element.indexOf(QUALITY_SEPARATOR)) != -1 )<a name="line.80"></a>
<span class="sourceLineNo">081</span> {<a name="line.81"></a>
<span class="sourceLineNo">082</span> String q = element.substring(index);<a name="line.82"></a>
<span class="sourceLineNo">083</span> element = element.substring(0, index);<a name="line.83"></a>
<span class="sourceLineNo">084</span> if ( (index = q.indexOf('=')) != -1 )<a name="line.84"></a>
<span class="sourceLineNo">085</span> {<a name="line.85"></a>
<span class="sourceLineNo">086</span> try<a name="line.86"></a>
<span class="sourceLineNo">087</span> {<a name="line.87"></a>
<span class="sourceLineNo">088</span> acceptLang.quality =<a name="line.88"></a>
<span class="sourceLineNo">089</span> Float.valueOf(q.substring(index + 1));<a name="line.89"></a>
<span class="sourceLineNo">090</span> }<a name="line.90"></a>
<span class="sourceLineNo">091</span> catch (NumberFormatException useDefault)<a name="line.91"></a>
<span class="sourceLineNo">092</span> {<a name="line.92"></a>
<span class="sourceLineNo">093</span> // ignore<a name="line.93"></a>
<span class="sourceLineNo">094</span> }<a name="line.94"></a>
<span class="sourceLineNo">095</span> }<a name="line.95"></a>
<span class="sourceLineNo">096</span> }<a name="line.96"></a>
<span class="sourceLineNo">097</span><a name="line.97"></a>
<span class="sourceLineNo">098</span> element = element.trim();<a name="line.98"></a>
<span class="sourceLineNo">099</span><a name="line.99"></a>
<span class="sourceLineNo">100</span> // Create a Locale from the language. A dash may separate the<a name="line.100"></a>
<span class="sourceLineNo">101</span> // language from the country.<a name="line.101"></a>
<span class="sourceLineNo">102</span> if ( (index = element.indexOf('-')) == -1 )<a name="line.102"></a>
<span class="sourceLineNo">103</span> {<a name="line.103"></a>
<span class="sourceLineNo">104</span> // No dash means no country.<a name="line.104"></a>
<span class="sourceLineNo">105</span> acceptLang.locale = new Locale(element, "");<a name="line.105"></a>
<span class="sourceLineNo">106</span> }<a name="line.106"></a>
<span class="sourceLineNo">107</span> else<a name="line.107"></a>
<span class="sourceLineNo">108</span> {<a name="line.108"></a>
<span class="sourceLineNo">109</span> acceptLang.locale = new Locale(element.substring(0, index),<a name="line.109"></a>
<span class="sourceLineNo">110</span> element.substring(index + 1));<a name="line.110"></a>
<span class="sourceLineNo">111</span> }<a name="line.111"></a>
<span class="sourceLineNo">112</span><a name="line.112"></a>
<span class="sourceLineNo">113</span> locales.add(acceptLang);<a name="line.113"></a>
<span class="sourceLineNo">114</span> }<a name="line.114"></a>
<span class="sourceLineNo">115</span><a name="line.115"></a>
<span class="sourceLineNo">116</span> // Sort by quality in descending order.<a name="line.116"></a>
<span class="sourceLineNo">117</span> locales.sort(Collections.reverseOrder());<a name="line.117"></a>
<span class="sourceLineNo">118</span> }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span> /**<a name="line.120"></a>
<span class="sourceLineNo">121</span> * @return Whether there are more locales.<a name="line.121"></a>
<span class="sourceLineNo">122</span> */<a name="line.122"></a>
<span class="sourceLineNo">123</span> public boolean hasNext()<a name="line.123"></a>
<span class="sourceLineNo">124</span> {<a name="line.124"></a>
<span class="sourceLineNo">125</span> return !locales.isEmpty();<a name="line.125"></a>
<span class="sourceLineNo">126</span> }<a name="line.126"></a>
<span class="sourceLineNo">127</span><a name="line.127"></a>
<span class="sourceLineNo">128</span> /**<a name="line.128"></a>
<span class="sourceLineNo">129</span> * Creates a &lt;code&gt;Locale&lt;/code&gt; from the next element of the<a name="line.129"></a>
<span class="sourceLineNo">130</span> * &lt;code&gt;Accept-Language&lt;/code&gt; header.<a name="line.130"></a>
<span class="sourceLineNo">131</span> *<a name="line.131"></a>
<span class="sourceLineNo">132</span> * @return The next highest-rated &lt;code&gt;Locale&lt;/code&gt;.<a name="line.132"></a>
<span class="sourceLineNo">133</span> * @throws NoSuchElementException No more locales.<a name="line.133"></a>
<span class="sourceLineNo">134</span> */<a name="line.134"></a>
<span class="sourceLineNo">135</span> public Object next()<a name="line.135"></a>
<span class="sourceLineNo">136</span> {<a name="line.136"></a>
<span class="sourceLineNo">137</span> if (locales.isEmpty())<a name="line.137"></a>
<span class="sourceLineNo">138</span> {<a name="line.138"></a>
<span class="sourceLineNo">139</span> throw new NoSuchElementException();<a name="line.139"></a>
<span class="sourceLineNo">140</span> }<a name="line.140"></a>
<span class="sourceLineNo">141</span> return (locales.remove(0)).locale;<a name="line.141"></a>
<span class="sourceLineNo">142</span> }<a name="line.142"></a>
<span class="sourceLineNo">143</span><a name="line.143"></a>
<span class="sourceLineNo">144</span> /**<a name="line.144"></a>
<span class="sourceLineNo">145</span> * Not implemented.<a name="line.145"></a>
<span class="sourceLineNo">146</span> */<a name="line.146"></a>
<span class="sourceLineNo">147</span> @Override<a name="line.147"></a>
<span class="sourceLineNo">148</span> public final void remove()<a name="line.148"></a>
<span class="sourceLineNo">149</span> {<a name="line.149"></a>
<span class="sourceLineNo">150</span> throw new UnsupportedOperationException(getClass().getName() +<a name="line.150"></a>
<span class="sourceLineNo">151</span> " does not support remove()");<a name="line.151"></a>
<span class="sourceLineNo">152</span> }<a name="line.152"></a>
<span class="sourceLineNo">153</span><a name="line.153"></a>
<span class="sourceLineNo">154</span> /**<a name="line.154"></a>
<span class="sourceLineNo">155</span> * Struct representing an element of the HTTP<a name="line.155"></a>
<span class="sourceLineNo">156</span> * &lt;code&gt;Accept-Language&lt;/code&gt; header.<a name="line.156"></a>
<span class="sourceLineNo">157</span> */<a name="line.157"></a>
<span class="sourceLineNo">158</span> protected static class AcceptLanguage implements Comparable&lt;Object&gt;<a name="line.158"></a>
<span class="sourceLineNo">159</span> {<a name="line.159"></a>
<span class="sourceLineNo">160</span> /**<a name="line.160"></a>
<span class="sourceLineNo">161</span> * The language and country.<a name="line.161"></a>
<span class="sourceLineNo">162</span> */<a name="line.162"></a>
<span class="sourceLineNo">163</span> Locale locale;<a name="line.163"></a>
<span class="sourceLineNo">164</span><a name="line.164"></a>
<span class="sourceLineNo">165</span> /**<a name="line.165"></a>
<span class="sourceLineNo">166</span> * The quality of our locale (as values approach<a name="line.166"></a>
<span class="sourceLineNo">167</span> * &lt;code&gt;1.0&lt;/code&gt;, they indicate increased user preference).<a name="line.167"></a>
<span class="sourceLineNo">168</span> */<a name="line.168"></a>
<span class="sourceLineNo">169</span> Float quality = DEFAULT_QUALITY;<a name="line.169"></a>
<span class="sourceLineNo">170</span> <a name="line.170"></a>
<span class="sourceLineNo">171</span> @Override<a name="line.171"></a>
<span class="sourceLineNo">172</span> public int compareTo(Object acceptLang)<a name="line.172"></a>
<span class="sourceLineNo">173</span> {<a name="line.173"></a>
<span class="sourceLineNo">174</span> if ( acceptLang == null )<a name="line.174"></a>
<span class="sourceLineNo">175</span> throw new NullPointerException("AcceptLanguage not found");<a name="line.175"></a>
<span class="sourceLineNo">176</span> <a name="line.176"></a>
<span class="sourceLineNo">177</span> if ( acceptLang instanceof AcceptLanguage )<a name="line.177"></a>
<span class="sourceLineNo">178</span> {<a name="line.178"></a>
<span class="sourceLineNo">179</span> Float q2 = ((AcceptLanguage) acceptLang).quality;<a name="line.179"></a>
<span class="sourceLineNo">180</span> return quality.compareTo( q2 );<a name="line.180"></a>
<span class="sourceLineNo">181</span> } else {<a name="line.181"></a>
<span class="sourceLineNo">182</span> throw new NullPointerException("The object to compare is not the correct type");<a name="line.182"></a>
<span class="sourceLineNo">183</span> }<a name="line.183"></a>
<span class="sourceLineNo">184</span> <a name="line.184"></a>
<span class="sourceLineNo">185</span> }<a name="line.185"></a>
<span class="sourceLineNo">186</span><a name="line.186"></a>
<span class="sourceLineNo">187</span> @Override<a name="line.187"></a>
<span class="sourceLineNo">188</span> public boolean equals(Object o) {<a name="line.188"></a>
<span class="sourceLineNo">189</span> if (this == o) return true;<a name="line.189"></a>
<span class="sourceLineNo">190</span> if (!(o instanceof AcceptLanguage)) return false;<a name="line.190"></a>
<span class="sourceLineNo">191</span> AcceptLanguage that = (AcceptLanguage) o;<a name="line.191"></a>
<span class="sourceLineNo">192</span> return quality.equals(that.quality);<a name="line.192"></a>
<span class="sourceLineNo">193</span> }<a name="line.193"></a>
<span class="sourceLineNo">194</span><a name="line.194"></a>
<span class="sourceLineNo">195</span> @Override<a name="line.195"></a>
<span class="sourceLineNo">196</span> public int hashCode() {<a name="line.196"></a>
<span class="sourceLineNo">197</span> return Objects.hash(locale, quality);<a name="line.197"></a>
<span class="sourceLineNo">198</span> }<a name="line.198"></a>
<span class="sourceLineNo">199</span> }<a name="line.199"></a>
<span class="sourceLineNo">200</span>}<a name="line.200"></a>
</pre>
</div>
</body>
</html>