blob: f368655e8fed2e384254888edb4e1bb589d0dc4c [file] [log] [blame]
<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT> /*<a name="line.1"></a>
<FONT color="green">002</FONT> * Licensed to the Apache Software Foundation (ASF) under one<a name="line.2"></a>
<FONT color="green">003</FONT> * or more contributor license agreements. See the NOTICE file<a name="line.3"></a>
<FONT color="green">004</FONT> * distributed with this work for additional information<a name="line.4"></a>
<FONT color="green">005</FONT> * regarding copyright ownership. The ASF licenses this file<a name="line.5"></a>
<FONT color="green">006</FONT> * to you under the Apache License, Version 2.0 (the "License");<a name="line.6"></a>
<FONT color="green">007</FONT> * you may not use this file except in compliance with the License.<a name="line.7"></a>
<FONT color="green">008</FONT> * You may obtain a copy of the License at<a name="line.8"></a>
<FONT color="green">009</FONT> *<a name="line.9"></a>
<FONT color="green">010</FONT> * http://www.apache.org/licenses/LICENSE-2.0<a name="line.10"></a>
<FONT color="green">011</FONT> *<a name="line.11"></a>
<FONT color="green">012</FONT> * Unless required by applicable law or agreed to in writing, software<a name="line.12"></a>
<FONT color="green">013</FONT> * distributed under the License is distributed on an "AS IS" BASIS,<a name="line.13"></a>
<FONT color="green">014</FONT> * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.14"></a>
<FONT color="green">015</FONT> * See the License for the specific language governing permissions and<a name="line.15"></a>
<FONT color="green">016</FONT> * limitations under the License.<a name="line.16"></a>
<FONT color="green">017</FONT> */<a name="line.17"></a>
<FONT color="green">018</FONT> /*<a name="line.18"></a>
<FONT color="green">019</FONT> * $Id: XStringForChars.java 468655 2006-10-28 07:12:06Z minchau $<a name="line.19"></a>
<FONT color="green">020</FONT> */<a name="line.20"></a>
<FONT color="green">021</FONT> package org.apache.xpath.objects;<a name="line.21"></a>
<FONT color="green">022</FONT> <a name="line.22"></a>
<FONT color="green">023</FONT> import org.apache.xalan.res.XSLMessages;<a name="line.23"></a>
<FONT color="green">024</FONT> import org.apache.xml.utils.FastStringBuffer;<a name="line.24"></a>
<FONT color="green">025</FONT> import org.apache.xpath.res.XPATHErrorResources;<a name="line.25"></a>
<FONT color="green">026</FONT> <a name="line.26"></a>
<FONT color="green">027</FONT> <a name="line.27"></a>
<FONT color="green">028</FONT> /**<a name="line.28"></a>
<FONT color="green">029</FONT> * This class will wrap a FastStringBuffer and allow for<a name="line.29"></a>
<FONT color="green">030</FONT> */<a name="line.30"></a>
<FONT color="green">031</FONT> public class XStringForChars extends XString<a name="line.31"></a>
<FONT color="green">032</FONT> {<a name="line.32"></a>
<FONT color="green">033</FONT> static final long serialVersionUID = -2235248887220850467L;<a name="line.33"></a>
<FONT color="green">034</FONT> /** The start position in the fsb. */<a name="line.34"></a>
<FONT color="green">035</FONT> int m_start;<a name="line.35"></a>
<FONT color="green">036</FONT> <a name="line.36"></a>
<FONT color="green">037</FONT> /** The length of the string. */<a name="line.37"></a>
<FONT color="green">038</FONT> int m_length;<a name="line.38"></a>
<FONT color="green">039</FONT> <a name="line.39"></a>
<FONT color="green">040</FONT> protected String m_strCache = null;<a name="line.40"></a>
<FONT color="green">041</FONT> <a name="line.41"></a>
<FONT color="green">042</FONT> /**<a name="line.42"></a>
<FONT color="green">043</FONT> * Construct a XNodeSet object.<a name="line.43"></a>
<FONT color="green">044</FONT> *<a name="line.44"></a>
<FONT color="green">045</FONT> * @param val FastStringBuffer object this will wrap, must be non-null.<a name="line.45"></a>
<FONT color="green">046</FONT> * @param start The start position in the array.<a name="line.46"></a>
<FONT color="green">047</FONT> * @param length The number of characters to read from the array.<a name="line.47"></a>
<FONT color="green">048</FONT> */<a name="line.48"></a>
<FONT color="green">049</FONT> public XStringForChars(char[] val, int start, int length)<a name="line.49"></a>
<FONT color="green">050</FONT> {<a name="line.50"></a>
<FONT color="green">051</FONT> super(val);<a name="line.51"></a>
<FONT color="green">052</FONT> m_start = start;<a name="line.52"></a>
<FONT color="green">053</FONT> m_length = length;<a name="line.53"></a>
<FONT color="green">054</FONT> if(null == val)<a name="line.54"></a>
<FONT color="green">055</FONT> throw new IllegalArgumentException(<a name="line.55"></a>
<FONT color="green">056</FONT> XSLMessages.createXPATHMessage(XPATHErrorResources.ER_FASTSTRINGBUFFER_CANNOT_BE_NULL, null)); //"The FastStringBuffer argument can not be null!!");<a name="line.56"></a>
<FONT color="green">057</FONT> }<a name="line.57"></a>
<FONT color="green">058</FONT> <a name="line.58"></a>
<FONT color="green">059</FONT> <a name="line.59"></a>
<FONT color="green">060</FONT> /**<a name="line.60"></a>
<FONT color="green">061</FONT> * Construct a XNodeSet object.<a name="line.61"></a>
<FONT color="green">062</FONT> *<a name="line.62"></a>
<FONT color="green">063</FONT> * @param val String object this will wrap.<a name="line.63"></a>
<FONT color="green">064</FONT> */<a name="line.64"></a>
<FONT color="green">065</FONT> private XStringForChars(String val)<a name="line.65"></a>
<FONT color="green">066</FONT> {<a name="line.66"></a>
<FONT color="green">067</FONT> super(val);<a name="line.67"></a>
<FONT color="green">068</FONT> throw new IllegalArgumentException(<a name="line.68"></a>
<FONT color="green">069</FONT> XSLMessages.createXPATHMessage(XPATHErrorResources.ER_XSTRINGFORCHARS_CANNOT_TAKE_STRING, null)); //"XStringForChars can not take a string for an argument!");<a name="line.69"></a>
<FONT color="green">070</FONT> }<a name="line.70"></a>
<FONT color="green">071</FONT> <a name="line.71"></a>
<FONT color="green">072</FONT> /**<a name="line.72"></a>
<FONT color="green">073</FONT> * Cast result object to a string.<a name="line.73"></a>
<FONT color="green">074</FONT> *<a name="line.74"></a>
<FONT color="green">075</FONT> * @return The string this wraps or the empty string if null<a name="line.75"></a>
<FONT color="green">076</FONT> */<a name="line.76"></a>
<FONT color="green">077</FONT> public FastStringBuffer fsb()<a name="line.77"></a>
<FONT color="green">078</FONT> {<a name="line.78"></a>
<FONT color="green">079</FONT> throw new RuntimeException(XSLMessages.createXPATHMessage(XPATHErrorResources.ER_FSB_NOT_SUPPORTED_XSTRINGFORCHARS, null)); //"fsb() not supported for XStringForChars!");<a name="line.79"></a>
<FONT color="green">080</FONT> }<a name="line.80"></a>
<FONT color="green">081</FONT> <a name="line.81"></a>
<FONT color="green">082</FONT> /**<a name="line.82"></a>
<FONT color="green">083</FONT> * Cast result object to a string.<a name="line.83"></a>
<FONT color="green">084</FONT> *<a name="line.84"></a>
<FONT color="green">085</FONT> * @return The string this wraps or the empty string if null<a name="line.85"></a>
<FONT color="green">086</FONT> */<a name="line.86"></a>
<FONT color="green">087</FONT> public void appendToFsb(org.apache.xml.utils.FastStringBuffer fsb)<a name="line.87"></a>
<FONT color="green">088</FONT> {<a name="line.88"></a>
<FONT color="green">089</FONT> fsb.append((char[])m_obj, m_start, m_length);<a name="line.89"></a>
<FONT color="green">090</FONT> }<a name="line.90"></a>
<FONT color="green">091</FONT> <a name="line.91"></a>
<FONT color="green">092</FONT> <a name="line.92"></a>
<FONT color="green">093</FONT> /**<a name="line.93"></a>
<FONT color="green">094</FONT> * Tell if this object contains a java String object.<a name="line.94"></a>
<FONT color="green">095</FONT> * <a name="line.95"></a>
<FONT color="green">096</FONT> * @return true if this XMLString can return a string without creating one.<a name="line.96"></a>
<FONT color="green">097</FONT> */<a name="line.97"></a>
<FONT color="green">098</FONT> public boolean hasString()<a name="line.98"></a>
<FONT color="green">099</FONT> {<a name="line.99"></a>
<FONT color="green">100</FONT> return (null != m_strCache);<a name="line.100"></a>
<FONT color="green">101</FONT> }<a name="line.101"></a>
<FONT color="green">102</FONT> <a name="line.102"></a>
<FONT color="green">103</FONT> <a name="line.103"></a>
<FONT color="green">104</FONT> /**<a name="line.104"></a>
<FONT color="green">105</FONT> * Cast result object to a string.<a name="line.105"></a>
<FONT color="green">106</FONT> *<a name="line.106"></a>
<FONT color="green">107</FONT> * @return The string this wraps or the empty string if null<a name="line.107"></a>
<FONT color="green">108</FONT> */<a name="line.108"></a>
<FONT color="green">109</FONT> public String str()<a name="line.109"></a>
<FONT color="green">110</FONT> {<a name="line.110"></a>
<FONT color="green">111</FONT> if(null == m_strCache)<a name="line.111"></a>
<FONT color="green">112</FONT> m_strCache = new String((char[])m_obj, m_start, m_length);<a name="line.112"></a>
<FONT color="green">113</FONT> <a name="line.113"></a>
<FONT color="green">114</FONT> return m_strCache;<a name="line.114"></a>
<FONT color="green">115</FONT> }<a name="line.115"></a>
<FONT color="green">116</FONT> <a name="line.116"></a>
<FONT color="green">117</FONT> <a name="line.117"></a>
<FONT color="green">118</FONT> /**<a name="line.118"></a>
<FONT color="green">119</FONT> * Since this object is incomplete without the length and the offset, we <a name="line.119"></a>
<FONT color="green">120</FONT> * have to convert to a string when this function is called.<a name="line.120"></a>
<FONT color="green">121</FONT> *<a name="line.121"></a>
<FONT color="green">122</FONT> * @return The java String representation of this object.<a name="line.122"></a>
<FONT color="green">123</FONT> */<a name="line.123"></a>
<FONT color="green">124</FONT> public Object object()<a name="line.124"></a>
<FONT color="green">125</FONT> {<a name="line.125"></a>
<FONT color="green">126</FONT> return str();<a name="line.126"></a>
<FONT color="green">127</FONT> }<a name="line.127"></a>
<FONT color="green">128</FONT> <a name="line.128"></a>
<FONT color="green">129</FONT> /**<a name="line.129"></a>
<FONT color="green">130</FONT> * Directly call the<a name="line.130"></a>
<FONT color="green">131</FONT> * characters method on the passed ContentHandler for the<a name="line.131"></a>
<FONT color="green">132</FONT> * string-value. Multiple calls to the<a name="line.132"></a>
<FONT color="green">133</FONT> * ContentHandler's characters methods may well occur for a single call to<a name="line.133"></a>
<FONT color="green">134</FONT> * this method.<a name="line.134"></a>
<FONT color="green">135</FONT> *<a name="line.135"></a>
<FONT color="green">136</FONT> * @param ch A non-null reference to a ContentHandler.<a name="line.136"></a>
<FONT color="green">137</FONT> *<a name="line.137"></a>
<FONT color="green">138</FONT> * @throws org.xml.sax.SAXException<a name="line.138"></a>
<FONT color="green">139</FONT> */<a name="line.139"></a>
<FONT color="green">140</FONT> public void dispatchCharactersEvents(org.xml.sax.ContentHandler ch)<a name="line.140"></a>
<FONT color="green">141</FONT> throws org.xml.sax.SAXException<a name="line.141"></a>
<FONT color="green">142</FONT> {<a name="line.142"></a>
<FONT color="green">143</FONT> ch.characters((char[])m_obj, m_start, m_length);<a name="line.143"></a>
<FONT color="green">144</FONT> }<a name="line.144"></a>
<FONT color="green">145</FONT> <a name="line.145"></a>
<FONT color="green">146</FONT> /**<a name="line.146"></a>
<FONT color="green">147</FONT> * Directly call the<a name="line.147"></a>
<FONT color="green">148</FONT> * comment method on the passed LexicalHandler for the<a name="line.148"></a>
<FONT color="green">149</FONT> * string-value.<a name="line.149"></a>
<FONT color="green">150</FONT> *<a name="line.150"></a>
<FONT color="green">151</FONT> * @param lh A non-null reference to a LexicalHandler.<a name="line.151"></a>
<FONT color="green">152</FONT> *<a name="line.152"></a>
<FONT color="green">153</FONT> * @throws org.xml.sax.SAXException<a name="line.153"></a>
<FONT color="green">154</FONT> */<a name="line.154"></a>
<FONT color="green">155</FONT> public void dispatchAsComment(org.xml.sax.ext.LexicalHandler lh)<a name="line.155"></a>
<FONT color="green">156</FONT> throws org.xml.sax.SAXException<a name="line.156"></a>
<FONT color="green">157</FONT> {<a name="line.157"></a>
<FONT color="green">158</FONT> lh.comment((char[])m_obj, m_start, m_length);<a name="line.158"></a>
<FONT color="green">159</FONT> }<a name="line.159"></a>
<FONT color="green">160</FONT> <a name="line.160"></a>
<FONT color="green">161</FONT> /**<a name="line.161"></a>
<FONT color="green">162</FONT> * Returns the length of this string.<a name="line.162"></a>
<FONT color="green">163</FONT> *<a name="line.163"></a>
<FONT color="green">164</FONT> * @return the length of the sequence of characters represented by this<a name="line.164"></a>
<FONT color="green">165</FONT> * object.<a name="line.165"></a>
<FONT color="green">166</FONT> */<a name="line.166"></a>
<FONT color="green">167</FONT> public int length()<a name="line.167"></a>
<FONT color="green">168</FONT> {<a name="line.168"></a>
<FONT color="green">169</FONT> return m_length;<a name="line.169"></a>
<FONT color="green">170</FONT> }<a name="line.170"></a>
<FONT color="green">171</FONT> <a name="line.171"></a>
<FONT color="green">172</FONT> /**<a name="line.172"></a>
<FONT color="green">173</FONT> * Returns the character at the specified index. An index ranges<a name="line.173"></a>
<FONT color="green">174</FONT> * from &lt;code&gt;0&lt;/code&gt; to &lt;code&gt;length() - 1&lt;/code&gt;. The first character<a name="line.174"></a>
<FONT color="green">175</FONT> * of the sequence is at index &lt;code&gt;0&lt;/code&gt;, the next at index<a name="line.175"></a>
<FONT color="green">176</FONT> * &lt;code&gt;1&lt;/code&gt;, and so on, as for array indexing.<a name="line.176"></a>
<FONT color="green">177</FONT> *<a name="line.177"></a>
<FONT color="green">178</FONT> * @param index the index of the character.<a name="line.178"></a>
<FONT color="green">179</FONT> * @return the character at the specified index of this string.<a name="line.179"></a>
<FONT color="green">180</FONT> * The first character is at index &lt;code&gt;0&lt;/code&gt;.<a name="line.180"></a>
<FONT color="green">181</FONT> * @exception IndexOutOfBoundsException if the &lt;code&gt;index&lt;/code&gt;<a name="line.181"></a>
<FONT color="green">182</FONT> * argument is negative or not less than the length of this<a name="line.182"></a>
<FONT color="green">183</FONT> * string.<a name="line.183"></a>
<FONT color="green">184</FONT> */<a name="line.184"></a>
<FONT color="green">185</FONT> public char charAt(int index)<a name="line.185"></a>
<FONT color="green">186</FONT> {<a name="line.186"></a>
<FONT color="green">187</FONT> return ((char[])m_obj)[index+m_start];<a name="line.187"></a>
<FONT color="green">188</FONT> }<a name="line.188"></a>
<FONT color="green">189</FONT> <a name="line.189"></a>
<FONT color="green">190</FONT> /**<a name="line.190"></a>
<FONT color="green">191</FONT> * Copies characters from this string into the destination character<a name="line.191"></a>
<FONT color="green">192</FONT> * array.<a name="line.192"></a>
<FONT color="green">193</FONT> *<a name="line.193"></a>
<FONT color="green">194</FONT> * @param srcBegin index of the first character in the string<a name="line.194"></a>
<FONT color="green">195</FONT> * to copy.<a name="line.195"></a>
<FONT color="green">196</FONT> * @param srcEnd index after the last character in the string<a name="line.196"></a>
<FONT color="green">197</FONT> * to copy.<a name="line.197"></a>
<FONT color="green">198</FONT> * @param dst the destination array.<a name="line.198"></a>
<FONT color="green">199</FONT> * @param dstBegin the start offset in the destination array.<a name="line.199"></a>
<FONT color="green">200</FONT> * @exception IndexOutOfBoundsException If any of the following<a name="line.200"></a>
<FONT color="green">201</FONT> * is true:<a name="line.201"></a>
<FONT color="green">202</FONT> * &lt;ul&gt;&lt;li&gt;&lt;code&gt;srcBegin&lt;/code&gt; is negative.<a name="line.202"></a>
<FONT color="green">203</FONT> * &lt;li&gt;&lt;code&gt;srcBegin&lt;/code&gt; is greater than &lt;code&gt;srcEnd&lt;/code&gt;<a name="line.203"></a>
<FONT color="green">204</FONT> * &lt;li&gt;&lt;code&gt;srcEnd&lt;/code&gt; is greater than the length of this<a name="line.204"></a>
<FONT color="green">205</FONT> * string<a name="line.205"></a>
<FONT color="green">206</FONT> * &lt;li&gt;&lt;code&gt;dstBegin&lt;/code&gt; is negative<a name="line.206"></a>
<FONT color="green">207</FONT> * &lt;li&gt;&lt;code&gt;dstBegin+(srcEnd-srcBegin)&lt;/code&gt; is larger than<a name="line.207"></a>
<FONT color="green">208</FONT> * &lt;code&gt;dst.length&lt;/code&gt;&lt;/ul&gt;<a name="line.208"></a>
<FONT color="green">209</FONT> * @exception NullPointerException if &lt;code&gt;dst&lt;/code&gt; is &lt;code&gt;null&lt;/code&gt;<a name="line.209"></a>
<FONT color="green">210</FONT> */<a name="line.210"></a>
<FONT color="green">211</FONT> public void getChars(int srcBegin, int srcEnd, char dst[], int dstBegin)<a name="line.211"></a>
<FONT color="green">212</FONT> {<a name="line.212"></a>
<FONT color="green">213</FONT> System.arraycopy((char[])m_obj, m_start+srcBegin, dst, dstBegin, srcEnd);<a name="line.213"></a>
<FONT color="green">214</FONT> }<a name="line.214"></a>
<FONT color="green">215</FONT> <a name="line.215"></a>
<FONT color="green">216</FONT> }<a name="line.216"></a>
</PRE>
</BODY>
</HTML>