| <!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" /> |
| <title>UnicodeInputStream xref</title> |
| <link type="text/css" rel="stylesheet" href="../../../../stylesheet.css" /> |
| </head> |
| <body> |
| <div id="overview"><a href="../../../../../apidocs/org/apache/velocity/io/UnicodeInputStream.html">View Javadoc</a></div><pre> |
|
|
| <a name="1" href="#1">1</a> <strong class="jxr_keyword">package</strong> org.apache.velocity.io;
|
| <a name="2" href="#2">2</a>
|
| <a name="3" href="#3">3</a> <em class="jxr_comment">/*</em>
|
| <a name="4" href="#4">4</a> <em class="jxr_comment"> * Licensed to the Apache Software Foundation (ASF) under one</em>
|
| <a name="5" href="#5">5</a> <em class="jxr_comment"> * or more contributor license agreements. See the NOTICE file</em>
|
| <a name="6" href="#6">6</a> <em class="jxr_comment"> * distributed with this work for additional information</em>
|
| <a name="7" href="#7">7</a> <em class="jxr_comment"> * regarding copyright ownership. The ASF licenses this file</em>
|
| <a name="8" href="#8">8</a> <em class="jxr_comment"> * to you under the Apache License, Version 2.0 (the</em>
|
| <a name="9" href="#9">9</a> <em class="jxr_comment"> * "License"); you may not use this file except in compliance</em>
|
| <a name="10" href="#10">10</a> <em class="jxr_comment"> * with the License. You may obtain a copy of the License at</em>
|
| <a name="11" href="#11">11</a> <em class="jxr_comment"> *</em>
|
| <a name="12" href="#12">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 name="13" href="#13">13</a> <em class="jxr_comment"> *</em>
|
| <a name="14" href="#14">14</a> <em class="jxr_comment"> * Unless required by applicable law or agreed to in writing,</em>
|
| <a name="15" href="#15">15</a> <em class="jxr_comment"> * software distributed under the License is distributed on an</em>
|
| <a name="16" href="#16">16</a> <em class="jxr_comment"> * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY</em>
|
| <a name="17" href="#17">17</a> <em class="jxr_comment"> * KIND, either express or implied. See the License for the</em>
|
| <a name="18" href="#18">18</a> <em class="jxr_comment"> * specific language governing permissions and limitations</em>
|
| <a name="19" href="#19">19</a> <em class="jxr_comment"> * under the License.</em>
|
| <a name="20" href="#20">20</a> <em class="jxr_comment"> */</em>
|
| <a name="21" href="#21">21</a>
|
| <a name="22" href="#22">22</a>
|
| <a name="23" href="#23">23</a> <strong class="jxr_keyword">import</strong> java.io.IOException;
|
| <a name="24" href="#24">24</a> <strong class="jxr_keyword">import</strong> java.io.InputStream;
|
| <a name="25" href="#25">25</a> <strong class="jxr_keyword">import</strong> java.io.PushbackInputStream;
|
| <a name="26" href="#26">26</a>
|
| <a name="27" href="#27">27</a> <strong class="jxr_keyword">import</strong> org.apache.velocity.util.ExceptionUtils;
|
| <a name="28" href="#28">28</a>
|
| <a name="29" href="#29">29</a>
|
| <a name="30" href="#30">30</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="31" href="#31">31</a> <em class="jxr_javadoccomment"> * This is an input stream that is unicode BOM aware. This allows you to e.g. read</em>
|
| <a name="32" href="#32">32</a> <em class="jxr_javadoccomment"> * Windows Notepad Unicode files as Velocity templates.</em>
|
| <a name="33" href="#33">33</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="34" href="#34">34</a> <em class="jxr_javadoccomment"> * It allows you to check the actual encoding of a file by calling {@link #getEncodingFromStream()} on</em>
|
| <a name="35" href="#35">35</a> <em class="jxr_javadoccomment"> * the input stream reader.</em>
|
| <a name="36" href="#36">36</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="37" href="#37">37</a> <em class="jxr_javadoccomment"> * This class is not thread safe! When more than one thread wants to use an instance of UnicodeInputStream,</em>
|
| <a name="38" href="#38">38</a> <em class="jxr_javadoccomment"> * the caller must provide synchronization.</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:mailmur@yahoo.com" target="alexandria_uri">mailto:mailmur@yahoo.com</a>">Aki Nieminen</a></em>
|
| <a name="41" href="#41">41</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:henning@apache.org" target="alexandria_uri">mailto:henning@apache.org</a>">Henning P. Schmiedehausen</a></em>
|
| <a name="42" href="#42">42</a> <em class="jxr_javadoccomment"> * @version $Id: UnicodeInputStream.java 685685 2008-08-13 21:43:27Z nbubna $</em>
|
| <a name="43" href="#43">43</a> <em class="jxr_javadoccomment"> * @since 1.5</em>
|
| <a name="44" href="#44">44</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="45" href="#45">45</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/velocity/io/UnicodeInputStream.html">UnicodeInputStream</a>
|
| <a name="46" href="#46">46</a> <strong class="jxr_keyword">extends</strong> InputStream
|
| <a name="47" href="#47">47</a> {
|
| <a name="48" href="#48">48</a>
|
| <a name="49" href="#49">49</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> BOM Marker for UTF 8. See <a href="<a href="http://www.unicode.org/unicode/faq/utf_bom.html" target="alexandria_uri">http://www.unicode.org/unicode/faq/utf_bom.html</a>" target="alexandria_uri"><a href="http://www.unicode.org/unicode/faq/utf_bom.html" target="alexandria_uri">http://www.unicode.org/unicode/faq/utf_bom.html</a></a> */</em>
|
| <a name="50" href="#50">50</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/velocity/io/UnicodeInputStream.html">UnicodeBOM</a> UTF8_BOM = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/io/UnicodeInputStream.html">UnicodeBOM</a>(<span class="jxr_string">"UTF-8"</span>, <strong class="jxr_keyword">new</strong> byte [] { (byte)0xef, (byte)0xbb, (byte)0xbf });
|
| <a name="51" href="#51">51</a>
|
| <a name="52" href="#52">52</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> BOM Marker for UTF 16, little endian. See <a href="<a href="http://www.unicode.org/unicode/faq/utf_bom.html" target="alexandria_uri">http://www.unicode.org/unicode/faq/utf_bom.html</a>" target="alexandria_uri"><a href="http://www.unicode.org/unicode/faq/utf_bom.html" target="alexandria_uri">http://www.unicode.org/unicode/faq/utf_bom.html</a></a> */</em>
|
| <a name="53" href="#53">53</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/velocity/io/UnicodeInputStream.html">UnicodeBOM</a> UTF16LE_BOM = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/io/UnicodeInputStream.html">UnicodeBOM</a>(<span class="jxr_string">"UTF-16LE"</span>, <strong class="jxr_keyword">new</strong> byte [] { (byte)0xff, (byte)0xfe });
|
| <a name="54" href="#54">54</a>
|
| <a name="55" href="#55">55</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> BOM Marker for UTF 16, big endian. See <a href="<a href="http://www.unicode.org/unicode/faq/utf_bom.html" target="alexandria_uri">http://www.unicode.org/unicode/faq/utf_bom.html</a>" target="alexandria_uri"><a href="http://www.unicode.org/unicode/faq/utf_bom.html" target="alexandria_uri">http://www.unicode.org/unicode/faq/utf_bom.html</a></a> */</em>
|
| <a name="56" href="#56">56</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/velocity/io/UnicodeInputStream.html">UnicodeBOM</a> UTF16BE_BOM = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/io/UnicodeInputStream.html">UnicodeBOM</a>(<span class="jxr_string">"UTF-16BE"</span>, <strong class="jxr_keyword">new</strong> byte [] { (byte)0xfe, (byte)0xff });
|
| <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"> * BOM Marker for UTF 32, little endian. See <a href="http://www.unicode.org/unicode/faq/utf_bom.html" target="alexandria_uri">http://www.unicode.org/unicode/faq/utf_bom.html</a></em>
|
| <a name="60" href="#60">60</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="61" href="#61">61</a> <em class="jxr_javadoccomment"> * TODO: Does Java actually support this?</em>
|
| <a name="62" href="#62">62</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="63" href="#63">63</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/velocity/io/UnicodeInputStream.html">UnicodeBOM</a> UTF32LE_BOM = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/io/UnicodeInputStream.html">UnicodeBOM</a>(<span class="jxr_string">"UTF-32LE"</span>, <strong class="jxr_keyword">new</strong> byte [] { (byte)0xff, (byte)0xfe, (byte)0x00, (byte)0x00 });
|
| <a name="64" href="#64">64</a>
|
| <a name="65" href="#65">65</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="66" href="#66">66</a> <em class="jxr_javadoccomment"> * BOM Marker for UTF 32, big endian. See <a href="http://www.unicode.org/unicode/faq/utf_bom.html" target="alexandria_uri">http://www.unicode.org/unicode/faq/utf_bom.html</a></em>
|
| <a name="67" href="#67">67</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="68" href="#68">68</a> <em class="jxr_javadoccomment"> * TODO: Does Java actually support this?</em>
|
| <a name="69" href="#69">69</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="70" href="#70">70</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/velocity/io/UnicodeInputStream.html">UnicodeBOM</a> UTF32BE_BOM = <strong class="jxr_keyword">new</strong> <a href="../../../../org/apache/velocity/io/UnicodeInputStream.html">UnicodeBOM</a>(<span class="jxr_string">"UTF-32BE"</span>, <strong class="jxr_keyword">new</strong> byte [] { (byte)0x00, (byte)0x00, (byte)0xfe, (byte)0xff });
|
| <a name="71" href="#71">71</a>
|
| <a name="72" href="#72">72</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The maximum amount of bytes to read for a BOM */</em>
|
| <a name="73" href="#73">73</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> MAX_BOM_SIZE = 4;
|
| <a name="74" href="#74">74</a>
|
| <a name="75" href="#75">75</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Buffer for BOM reading */</em>
|
| <a name="76" href="#76">76</a> <strong class="jxr_keyword">private</strong> byte [] buf = <strong class="jxr_keyword">new</strong> byte[MAX_BOM_SIZE];
|
| <a name="77" href="#77">77</a>
|
| <a name="78" href="#78">78</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> Buffer pointer. */</em>
|
| <a name="79" href="#79">79</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">int</strong> pos = 0;
|
| <a name="80" href="#80">80</a>
|
| <a name="81" href="#81">81</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> The stream encoding as read from the BOM or null. */</em>
|
| <a name="82" href="#82">82</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String encoding;
|
| <a name="83" href="#83">83</a>
|
| <a name="84" href="#84">84</a> <em class="jxr_javadoccomment">/**</em><em class="jxr_javadoccomment"> True if the BOM itself should be skipped and not read. */</em>
|
| <a name="85" href="#85">85</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> skipBOM;
|
| <a name="86" href="#86">86</a>
|
| <a name="87" href="#87">87</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> PushbackInputStream inputStream;
|
| <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"> * Creates a new UnicodeInputStream object. Skips a BOM which defines the file encoding.</em>
|
| <a name="91" href="#91">91</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="92" href="#92">92</a> <em class="jxr_javadoccomment"> * @param inputStream The input stream to use for reading.</em>
|
| <a name="93" href="#93">93</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="94" href="#94">94</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/io/UnicodeInputStream.html">UnicodeInputStream</a>(<strong class="jxr_keyword">final</strong> InputStream inputStream)
|
| <a name="95" href="#95">95</a> <strong class="jxr_keyword">throws</strong> IllegalStateException, IOException
|
| <a name="96" href="#96">96</a> {
|
| <a name="97" href="#97">97</a> <strong class="jxr_keyword">this</strong>(inputStream, <strong class="jxr_keyword">true</strong>);
|
| <a name="98" href="#98">98</a> }
|
| <a name="99" href="#99">99</a>
|
| <a name="100" href="#100">100</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="101" href="#101">101</a> <em class="jxr_javadoccomment"> * Creates a new UnicodeInputStream object.</em>
|
| <a name="102" href="#102">102</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="103" href="#103">103</a> <em class="jxr_javadoccomment"> * @param inputStream The input stream to use for reading.</em>
|
| <a name="104" href="#104">104</a> <em class="jxr_javadoccomment"> * @param skipBOM If this is set to true, a BOM read from the stream is discarded. This parameter should normally be true.</em>
|
| <a name="105" href="#105">105</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="106" href="#106">106</a> <strong class="jxr_keyword">public</strong> <a href="../../../../org/apache/velocity/io/UnicodeInputStream.html">UnicodeInputStream</a>(<strong class="jxr_keyword">final</strong> InputStream inputStream, <strong class="jxr_keyword">boolean</strong> skipBOM)
|
| <a name="107" href="#107">107</a> <strong class="jxr_keyword">throws</strong> IllegalStateException, IOException
|
| <a name="108" href="#108">108</a> {
|
| <a name="109" href="#109">109</a> <strong class="jxr_keyword">super</strong>();
|
| <a name="110" href="#110">110</a>
|
| <a name="111" href="#111">111</a> <strong class="jxr_keyword">this</strong>.skipBOM = skipBOM;
|
| <a name="112" href="#112">112</a> <strong class="jxr_keyword">this</strong>.inputStream = <strong class="jxr_keyword">new</strong> PushbackInputStream(inputStream, MAX_BOM_SIZE);
|
| <a name="113" href="#113">113</a>
|
| <a name="114" href="#114">114</a> <strong class="jxr_keyword">try</strong>
|
| <a name="115" href="#115">115</a> {
|
| <a name="116" href="#116">116</a> <strong class="jxr_keyword">this</strong>.encoding = readEncoding();
|
| <a name="117" href="#117">117</a> }
|
| <a name="118" href="#118">118</a> <strong class="jxr_keyword">catch</strong> (IOException ioe)
|
| <a name="119" href="#119">119</a> {
|
| <a name="120" href="#120">120</a> IllegalStateException ex = <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"Could not read BOM from Stream"</span>);
|
| <a name="121" href="#121">121</a> ExceptionUtils.setCause(ex, ioe);
|
| <a name="122" href="#122">122</a> <strong class="jxr_keyword">throw</strong> ex;
|
| <a name="123" href="#123">123</a> }
|
| <a name="124" href="#124">124</a> }
|
| <a name="125" href="#125">125</a>
|
| <a name="126" href="#126">126</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="127" href="#127">127</a> <em class="jxr_javadoccomment"> * Returns true if the input stream discards the BOM.</em>
|
| <a name="128" href="#128">128</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="129" href="#129">129</a> <em class="jxr_javadoccomment"> * @return True if the input stream discards the BOM.</em>
|
| <a name="130" href="#130">130</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="131" href="#131">131</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> isSkipBOM()
|
| <a name="132" href="#132">132</a> {
|
| <a name="133" href="#133">133</a> <strong class="jxr_keyword">return</strong> skipBOM;
|
| <a name="134" href="#134">134</a> }
|
| <a name="135" href="#135">135</a>
|
| <a name="136" href="#136">136</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="137" href="#137">137</a> <em class="jxr_javadoccomment"> * Read encoding based on BOM.</em>
|
| <a name="138" href="#138">138</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="139" href="#139">139</a> <em class="jxr_javadoccomment"> * @return The encoding based on the BOM.</em>
|
| <a name="140" href="#140">140</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="141" href="#141">141</a> <em class="jxr_javadoccomment"> * @throws IllegalStateException When a problem reading the BOM occured.</em>
|
| <a name="142" href="#142">142</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="143" href="#143">143</a> <strong class="jxr_keyword">public</strong> String getEncodingFromStream()
|
| <a name="144" href="#144">144</a> {
|
| <a name="145" href="#145">145</a> <strong class="jxr_keyword">return</strong> encoding;
|
| <a name="146" href="#146">146</a> }
|
| <a name="147" href="#147">147</a>
|
| <a name="148" href="#148">148</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="149" href="#149">149</a> <em class="jxr_javadoccomment"> * This method gets the encoding from the stream contents if a BOM exists. If no BOM exists, the encoding</em>
|
| <a name="150" href="#150">150</a> <em class="jxr_javadoccomment"> * is undefined.</em>
|
| <a name="151" href="#151">151</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="152" href="#152">152</a> <em class="jxr_javadoccomment"> * @return The encoding of this streams contents as decided by the BOM or null if no BOM was found.</em>
|
| <a name="153" href="#153">153</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="154" href="#154">154</a> <strong class="jxr_keyword">protected</strong> String readEncoding()
|
| <a name="155" href="#155">155</a> <strong class="jxr_keyword">throws</strong> IOException
|
| <a name="156" href="#156">156</a> {
|
| <a name="157" href="#157">157</a> pos = 0;
|
| <a name="158" href="#158">158</a>
|
| <a name="159" href="#159">159</a> <a href="../../../../org/apache/velocity/io/UnicodeInputStream.html">UnicodeBOM</a> encoding = <strong class="jxr_keyword">null</strong>;
|
| <a name="160" href="#160">160</a>
|
| <a name="161" href="#161">161</a> <em class="jxr_comment">// read first byte.</em>
|
| <a name="162" href="#162">162</a> <strong class="jxr_keyword">if</strong> (readByte())
|
| <a name="163" href="#163">163</a> {
|
| <a name="164" href="#164">164</a> <em class="jxr_comment">// Build a list of matches</em>
|
| <a name="165" href="#165">165</a> <em class="jxr_comment">//</em>
|
| <a name="166" href="#166">166</a> <em class="jxr_comment">// 00 00 FE FF --> UTF 32 BE</em>
|
| <a name="167" href="#167">167</a> <em class="jxr_comment">// EF BB BF --> UTF 8</em>
|
| <a name="168" href="#168">168</a> <em class="jxr_comment">// FE FF --> UTF 16 BE</em>
|
| <a name="169" href="#169">169</a> <em class="jxr_comment">// FF FE --> UTF 16 LE</em>
|
| <a name="170" href="#170">170</a> <em class="jxr_comment">// FF FE 00 00 --> UTF 32 LE</em>
|
| <a name="171" href="#171">171</a>
|
| <a name="172" href="#172">172</a> <strong class="jxr_keyword">switch</strong> (buf[0])
|
| <a name="173" href="#173">173</a> {
|
| <a name="174" href="#174">174</a> <strong class="jxr_keyword">case</strong> (byte)0x00: <em class="jxr_comment">// UTF32 BE</em>
|
| <a name="175" href="#175">175</a> encoding = match(UTF32BE_BOM, <strong class="jxr_keyword">null</strong>);
|
| <a name="176" href="#176">176</a> <strong class="jxr_keyword">break</strong>;
|
| <a name="177" href="#177">177</a> <strong class="jxr_keyword">case</strong> (byte)0xef: <em class="jxr_comment">// UTF8</em>
|
| <a name="178" href="#178">178</a> encoding = match(UTF8_BOM, <strong class="jxr_keyword">null</strong>);
|
| <a name="179" href="#179">179</a> <strong class="jxr_keyword">break</strong>;
|
| <a name="180" href="#180">180</a> <strong class="jxr_keyword">case</strong> (byte)0xfe: <em class="jxr_comment">// UTF16 BE</em>
|
| <a name="181" href="#181">181</a> encoding = match(UTF16BE_BOM, <strong class="jxr_keyword">null</strong>);
|
| <a name="182" href="#182">182</a> <strong class="jxr_keyword">break</strong>;
|
| <a name="183" href="#183">183</a> <strong class="jxr_keyword">case</strong> (byte)0xff: <em class="jxr_comment">// UTF16/32 LE</em>
|
| <a name="184" href="#184">184</a> encoding = match(UTF16LE_BOM, <strong class="jxr_keyword">null</strong>);
|
| <a name="185" href="#185">185</a>
|
| <a name="186" href="#186">186</a> <strong class="jxr_keyword">if</strong> (encoding != <strong class="jxr_keyword">null</strong>)
|
| <a name="187" href="#187">187</a> {
|
| <a name="188" href="#188">188</a> encoding = match(UTF32LE_BOM, encoding);
|
| <a name="189" href="#189">189</a> }
|
| <a name="190" href="#190">190</a> <strong class="jxr_keyword">break</strong>;
|
| <a name="191" href="#191">191</a>
|
| <a name="192" href="#192">192</a> <strong class="jxr_keyword">default</strong>:
|
| <a name="193" href="#193">193</a> encoding = <strong class="jxr_keyword">null</strong>;
|
| <a name="194" href="#194">194</a> <strong class="jxr_keyword">break</strong>;
|
| <a name="195" href="#195">195</a> }
|
| <a name="196" href="#196">196</a> }
|
| <a name="197" href="#197">197</a>
|
| <a name="198" href="#198">198</a> pushback(encoding);
|
| <a name="199" href="#199">199</a>
|
| <a name="200" href="#200">200</a> <strong class="jxr_keyword">return</strong> (encoding != <strong class="jxr_keyword">null</strong>) ? encoding.getEncoding() : <strong class="jxr_keyword">null</strong>;
|
| <a name="201" href="#201">201</a> }
|
| <a name="202" href="#202">202</a>
|
| <a name="203" href="#203">203</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/velocity/io/UnicodeInputStream.html">UnicodeBOM</a> match(<strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/velocity/io/UnicodeInputStream.html">UnicodeBOM</a> matchEncoding, <strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/velocity/io/UnicodeInputStream.html">UnicodeBOM</a> noMatchEncoding)
|
| <a name="204" href="#204">204</a> <strong class="jxr_keyword">throws</strong> IOException
|
| <a name="205" href="#205">205</a> {
|
| <a name="206" href="#206">206</a> byte [] bom = matchEncoding.getBytes();
|
| <a name="207" href="#207">207</a>
|
| <a name="208" href="#208">208</a> <strong class="jxr_keyword">for</strong> (<strong class="jxr_keyword">int</strong> i = 0; i < bom.length; i++)
|
| <a name="209" href="#209">209</a> {
|
| <a name="210" href="#210">210</a> <strong class="jxr_keyword">if</strong> (pos <= i) <em class="jxr_comment">// Byte has not yet been read</em>
|
| <a name="211" href="#211">211</a> {
|
| <a name="212" href="#212">212</a> <strong class="jxr_keyword">if</strong> (!readByte())
|
| <a name="213" href="#213">213</a> {
|
| <a name="214" href="#214">214</a> <strong class="jxr_keyword">return</strong> noMatchEncoding;
|
| <a name="215" href="#215">215</a> }
|
| <a name="216" href="#216">216</a> }
|
| <a name="217" href="#217">217</a>
|
| <a name="218" href="#218">218</a> <strong class="jxr_keyword">if</strong> (bom[i] != buf[i])
|
| <a name="219" href="#219">219</a> {
|
| <a name="220" href="#220">220</a> <strong class="jxr_keyword">return</strong> noMatchEncoding;
|
| <a name="221" href="#221">221</a> }
|
| <a name="222" href="#222">222</a> }
|
| <a name="223" href="#223">223</a>
|
| <a name="224" href="#224">224</a> <strong class="jxr_keyword">return</strong> matchEncoding;
|
| <a name="225" href="#225">225</a> }
|
| <a name="226" href="#226">226</a>
|
| <a name="227" href="#227">227</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">boolean</strong> readByte()
|
| <a name="228" href="#228">228</a> <strong class="jxr_keyword">throws</strong> IOException
|
| <a name="229" href="#229">229</a> {
|
| <a name="230" href="#230">230</a> <strong class="jxr_keyword">int</strong> res = inputStream.read();
|
| <a name="231" href="#231">231</a> <strong class="jxr_keyword">if</strong> (res == -1)
|
| <a name="232" href="#232">232</a> {
|
| <a name="233" href="#233">233</a> <strong class="jxr_keyword">return</strong> false;
|
| <a name="234" href="#234">234</a> }
|
| <a name="235" href="#235">235</a>
|
| <a name="236" href="#236">236</a> <strong class="jxr_keyword">if</strong> (pos >= buf.length)
|
| <a name="237" href="#237">237</a> {
|
| <a name="238" href="#238">238</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IOException(<span class="jxr_string">"BOM read error"</span>);
|
| <a name="239" href="#239">239</a> }
|
| <a name="240" href="#240">240</a>
|
| <a name="241" href="#241">241</a> buf[pos++] = (byte) res;
|
| <a name="242" href="#242">242</a> <strong class="jxr_keyword">return</strong> <strong class="jxr_keyword">true</strong>;
|
| <a name="243" href="#243">243</a> }
|
| <a name="244" href="#244">244</a>
|
| <a name="245" href="#245">245</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">void</strong> pushback(<strong class="jxr_keyword">final</strong> <a href="../../../../org/apache/velocity/io/UnicodeInputStream.html">UnicodeBOM</a> matchBOM)
|
| <a name="246" href="#246">246</a> <strong class="jxr_keyword">throws</strong> IOException
|
| <a name="247" href="#247">247</a> {
|
| <a name="248" href="#248">248</a> <strong class="jxr_keyword">int</strong> count = pos; <em class="jxr_comment">// By default, all bytes are pushed back.</em>
|
| <a name="249" href="#249">249</a> <strong class="jxr_keyword">int</strong> start = 0;
|
| <a name="250" href="#250">250</a>
|
| <a name="251" href="#251">251</a> <strong class="jxr_keyword">if</strong> (matchBOM != <strong class="jxr_keyword">null</strong> && skipBOM)
|
| <a name="252" href="#252">252</a> {
|
| <a name="253" href="#253">253</a> <em class="jxr_comment">// We have a match (some bytes are part of the BOM)</em>
|
| <a name="254" href="#254">254</a> <em class="jxr_comment">// and we want to skip the BOM. Push back only the bytes</em>
|
| <a name="255" href="#255">255</a> <em class="jxr_comment">// after the BOM.</em>
|
| <a name="256" href="#256">256</a> start = matchBOM.getBytes().length;
|
| <a name="257" href="#257">257</a> count = (pos - start);
|
| <a name="258" href="#258">258</a>
|
| <a name="259" href="#259">259</a> <strong class="jxr_keyword">if</strong> (count < 0)
|
| <a name="260" href="#260">260</a> {
|
| <a name="261" href="#261">261</a> <strong class="jxr_keyword">throw</strong> <strong class="jxr_keyword">new</strong> IllegalStateException(<span class="jxr_string">"Match has more bytes than available!"</span>);
|
| <a name="262" href="#262">262</a> }
|
| <a name="263" href="#263">263</a> }
|
| <a name="264" href="#264">264</a>
|
| <a name="265" href="#265">265</a> inputStream.unread(buf, start, count);
|
| <a name="266" href="#266">266</a> }
|
| <a name="267" href="#267">267</a>
|
| <a name="268" href="#268">268</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="269" href="#269">269</a> <em class="jxr_javadoccomment"> * @see java.io.InputStream#close()</em>
|
| <a name="270" href="#270">270</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="271" href="#271">271</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> close()
|
| <a name="272" href="#272">272</a> <strong class="jxr_keyword">throws</strong> IOException
|
| <a name="273" href="#273">273</a> {
|
| <a name="274" href="#274">274</a> inputStream.close();
|
| <a name="275" href="#275">275</a> }
|
| <a name="276" href="#276">276</a>
|
| <a name="277" href="#277">277</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="278" href="#278">278</a> <em class="jxr_javadoccomment"> * @see java.io.InputStream#available()</em>
|
| <a name="279" href="#279">279</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="280" href="#280">280</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> available()
|
| <a name="281" href="#281">281</a> <strong class="jxr_keyword">throws</strong> IOException
|
| <a name="282" href="#282">282</a> {
|
| <a name="283" href="#283">283</a> <strong class="jxr_keyword">return</strong> inputStream.available();
|
| <a name="284" href="#284">284</a> }
|
| <a name="285" href="#285">285</a>
|
| <a name="286" href="#286">286</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="287" href="#287">287</a> <em class="jxr_javadoccomment"> * @see java.io.InputStream#mark(int)</em>
|
| <a name="288" href="#288">288</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="289" href="#289">289</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> mark(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> readlimit)
|
| <a name="290" href="#290">290</a> {
|
| <a name="291" href="#291">291</a> inputStream.mark(readlimit);
|
| <a name="292" href="#292">292</a> }
|
| <a name="293" href="#293">293</a>
|
| <a name="294" href="#294">294</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="295" href="#295">295</a> <em class="jxr_javadoccomment"> * @see java.io.InputStream#markSupported()</em>
|
| <a name="296" href="#296">296</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="297" href="#297">297</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">boolean</strong> markSupported()
|
| <a name="298" href="#298">298</a> {
|
| <a name="299" href="#299">299</a> <strong class="jxr_keyword">return</strong> inputStream.markSupported();
|
| <a name="300" href="#300">300</a> }
|
| <a name="301" href="#301">301</a>
|
| <a name="302" href="#302">302</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="303" href="#303">303</a> <em class="jxr_javadoccomment"> * @see java.io.InputStream#read()</em>
|
| <a name="304" href="#304">304</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="305" href="#305">305</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> read()
|
| <a name="306" href="#306">306</a> <strong class="jxr_keyword">throws</strong> IOException
|
| <a name="307" href="#307">307</a> {
|
| <a name="308" href="#308">308</a> <strong class="jxr_keyword">return</strong> inputStream.read();
|
| <a name="309" href="#309">309</a> }
|
| <a name="310" href="#310">310</a>
|
| <a name="311" href="#311">311</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="312" href="#312">312</a> <em class="jxr_javadoccomment"> * @see java.io.InputStream#read(byte[])</em>
|
| <a name="313" href="#313">313</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="314" href="#314">314</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> read(<strong class="jxr_keyword">final</strong> byte [] b)
|
| <a name="315" href="#315">315</a> <strong class="jxr_keyword">throws</strong> IOException
|
| <a name="316" href="#316">316</a> {
|
| <a name="317" href="#317">317</a> <strong class="jxr_keyword">return</strong> inputStream.read(b);
|
| <a name="318" href="#318">318</a> }
|
| <a name="319" href="#319">319</a>
|
| <a name="320" href="#320">320</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="321" href="#321">321</a> <em class="jxr_javadoccomment"> * @see java.io.InputStream#read(byte[], int, int)</em>
|
| <a name="322" href="#322">322</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="323" href="#323">323</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">int</strong> read(<strong class="jxr_keyword">final</strong> byte [] b, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> off, <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">int</strong> len)
|
| <a name="324" href="#324">324</a> <strong class="jxr_keyword">throws</strong> IOException
|
| <a name="325" href="#325">325</a> {
|
| <a name="326" href="#326">326</a> <strong class="jxr_keyword">return</strong> inputStream.read(b, off, len);
|
| <a name="327" href="#327">327</a> }
|
| <a name="328" href="#328">328</a>
|
| <a name="329" href="#329">329</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="330" href="#330">330</a> <em class="jxr_javadoccomment"> * @see java.io.InputStream#reset()</em>
|
| <a name="331" href="#331">331</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="332" href="#332">332</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">void</strong> reset()
|
| <a name="333" href="#333">333</a> <strong class="jxr_keyword">throws</strong> IOException
|
| <a name="334" href="#334">334</a> {
|
| <a name="335" href="#335">335</a> inputStream.reset();
|
| <a name="336" href="#336">336</a> }
|
| <a name="337" href="#337">337</a>
|
| <a name="338" href="#338">338</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="339" href="#339">339</a> <em class="jxr_javadoccomment"> * @see java.io.InputStream#skip(long)</em>
|
| <a name="340" href="#340">340</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="341" href="#341">341</a> <strong class="jxr_keyword">public</strong> <strong class="jxr_keyword">long</strong> skip(<strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">long</strong> n)
|
| <a name="342" href="#342">342</a> <strong class="jxr_keyword">throws</strong> IOException
|
| <a name="343" href="#343">343</a> {
|
| <a name="344" href="#344">344</a> <strong class="jxr_keyword">return</strong> inputStream.skip(n);
|
| <a name="345" href="#345">345</a> }
|
| <a name="346" href="#346">346</a>
|
| <a name="347" href="#347">347</a> <em class="jxr_javadoccomment">/**</em>
|
| <a name="348" href="#348">348</a> <em class="jxr_javadoccomment"> * Helper class to bundle encoding and BOM marker.</em>
|
| <a name="349" href="#349">349</a> <em class="jxr_javadoccomment"> *</em>
|
| <a name="350" href="#350">350</a> <em class="jxr_javadoccomment"> * @author <a href="<a href="mailto:henning@apache.org" target="alexandria_uri">mailto:henning@apache.org</a>">Henning P. Schmiedehausen</a></em>
|
| <a name="351" href="#351">351</a> <em class="jxr_javadoccomment"> * @version $Id: UnicodeInputStream.java 685685 2008-08-13 21:43:27Z nbubna $</em>
|
| <a name="352" href="#352">352</a> <em class="jxr_javadoccomment"> */</em>
|
| <a name="353" href="#353">353</a> <strong class="jxr_keyword">static</strong> <strong class="jxr_keyword">final</strong> <strong class="jxr_keyword">class</strong> <a href="../../../../org/apache/velocity/io/UnicodeInputStream.html">UnicodeBOM</a>
|
| <a name="354" href="#354">354</a> {
|
| <a name="355" href="#355">355</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> String encoding;
|
| <a name="356" href="#356">356</a>
|
| <a name="357" href="#357">357</a> <strong class="jxr_keyword">private</strong> <strong class="jxr_keyword">final</strong> byte [] bytes;
|
| <a name="358" href="#358">358</a>
|
| <a name="359" href="#359">359</a> <strong class="jxr_keyword">private</strong> <a href="../../../../org/apache/velocity/io/UnicodeInputStream.html">UnicodeBOM</a>(<strong class="jxr_keyword">final</strong> String encoding, <strong class="jxr_keyword">final</strong> byte [] bytes)
|
| <a name="360" href="#360">360</a> {
|
| <a name="361" href="#361">361</a> <strong class="jxr_keyword">this</strong>.encoding = encoding;
|
| <a name="362" href="#362">362</a> <strong class="jxr_keyword">this</strong>.bytes = bytes;
|
| <a name="363" href="#363">363</a> }
|
| <a name="364" href="#364">364</a>
|
| <a name="365" href="#365">365</a> String getEncoding()
|
| <a name="366" href="#366">366</a> {
|
| <a name="367" href="#367">367</a> <strong class="jxr_keyword">return</strong> encoding;
|
| <a name="368" href="#368">368</a> }
|
| <a name="369" href="#369">369</a>
|
| <a name="370" href="#370">370</a> byte [] getBytes()
|
| <a name="371" href="#371">371</a> {
|
| <a name="372" href="#372">372</a> <strong class="jxr_keyword">return</strong> bytes;
|
| <a name="373" href="#373">373</a> }
|
| <a name="374" href="#374">374</a> }
|
| <a name="375" href="#375">375</a> }
|
| </pre> |
| <hr/><div id="footer">This page was automatically generated by <a href="http://maven.apache.org/">Maven</a></div></body> |
| </html> |
|
|
