| <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: XMLString.java 570109 2007-08-27 13:31:35Z zongaro $<a name="line.19"></a> |
| <FONT color="green">020</FONT> */<a name="line.20"></a> |
| <FONT color="green">021</FONT> package org.apache.xml.utils;<a name="line.21"></a> |
| <FONT color="green">022</FONT> <a name="line.22"></a> |
| <FONT color="green">023</FONT> import java.util.Locale;<a name="line.23"></a> |
| <FONT color="green">024</FONT> <a name="line.24"></a> |
| <FONT color="green">025</FONT> /**<a name="line.25"></a> |
| <FONT color="green">026</FONT> * This class is meant to be an interface to character strings, whether they<a name="line.26"></a> |
| <FONT color="green">027</FONT> * be java Strings or <code>org.apache.xml.utils.FastStringBuffer</code>s, or<a name="line.27"></a> |
| <FONT color="green">028</FONT> * other character data. By using XMLString, character copies can be reduced<a name="line.28"></a> |
| <FONT color="green">029</FONT> * in the XML pipeline.<a name="line.29"></a> |
| <FONT color="green">030</FONT> */<a name="line.30"></a> |
| <FONT color="green">031</FONT> public interface XMLString<a name="line.31"></a> |
| <FONT color="green">032</FONT> {<a name="line.32"></a> |
| <FONT color="green">033</FONT> <a name="line.33"></a> |
| <FONT color="green">034</FONT> /**<a name="line.34"></a> |
| <FONT color="green">035</FONT> * Directly call the<a name="line.35"></a> |
| <FONT color="green">036</FONT> * characters method on the passed ContentHandler for the<a name="line.36"></a> |
| <FONT color="green">037</FONT> * string-value. Multiple calls to the<a name="line.37"></a> |
| <FONT color="green">038</FONT> * ContentHandler's characters methods may well occur for a single call to<a name="line.38"></a> |
| <FONT color="green">039</FONT> * this method.<a name="line.39"></a> |
| <FONT color="green">040</FONT> *<a name="line.40"></a> |
| <FONT color="green">041</FONT> * @param ch A non-null reference to a ContentHandler.<a name="line.41"></a> |
| <FONT color="green">042</FONT> *<a name="line.42"></a> |
| <FONT color="green">043</FONT> * @throws org.xml.sax.SAXException<a name="line.43"></a> |
| <FONT color="green">044</FONT> */<a name="line.44"></a> |
| <FONT color="green">045</FONT> public abstract void dispatchCharactersEvents(org.xml.sax.ContentHandler ch)<a name="line.45"></a> |
| <FONT color="green">046</FONT> throws org.xml.sax.SAXException;<a name="line.46"></a> |
| <FONT color="green">047</FONT> <a name="line.47"></a> |
| <FONT color="green">048</FONT> /**<a name="line.48"></a> |
| <FONT color="green">049</FONT> * Directly call the<a name="line.49"></a> |
| <FONT color="green">050</FONT> * comment method on the passed LexicalHandler for the<a name="line.50"></a> |
| <FONT color="green">051</FONT> * string-value.<a name="line.51"></a> |
| <FONT color="green">052</FONT> *<a name="line.52"></a> |
| <FONT color="green">053</FONT> * @param lh A non-null reference to a LexicalHandler.<a name="line.53"></a> |
| <FONT color="green">054</FONT> *<a name="line.54"></a> |
| <FONT color="green">055</FONT> * @throws org.xml.sax.SAXException<a name="line.55"></a> |
| <FONT color="green">056</FONT> */<a name="line.56"></a> |
| <FONT color="green">057</FONT> public abstract void dispatchAsComment(org.xml.sax.ext.LexicalHandler lh)<a name="line.57"></a> |
| <FONT color="green">058</FONT> throws org.xml.sax.SAXException;<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> * Conditionally trim all leading and trailing whitespace in the specified String.<a name="line.61"></a> |
| <FONT color="green">062</FONT> * All strings of white space are<a name="line.62"></a> |
| <FONT color="green">063</FONT> * replaced by a single space character (#x20), except spaces after punctuation which<a name="line.63"></a> |
| <FONT color="green">064</FONT> * receive double spaces if doublePunctuationSpaces is true.<a name="line.64"></a> |
| <FONT color="green">065</FONT> * This function may be useful to a formatter, but to get first class<a name="line.65"></a> |
| <FONT color="green">066</FONT> * results, the formatter should probably do it's own white space handling<a name="line.66"></a> |
| <FONT color="green">067</FONT> * based on the semantics of the formatting object.<a name="line.67"></a> |
| <FONT color="green">068</FONT> * <a name="line.68"></a> |
| <FONT color="green">069</FONT> * @param trimHead Trim leading whitespace?<a name="line.69"></a> |
| <FONT color="green">070</FONT> * @param trimTail Trim trailing whitespace?<a name="line.70"></a> |
| <FONT color="green">071</FONT> * @param doublePunctuationSpaces Use double spaces for punctuation?<a name="line.71"></a> |
| <FONT color="green">072</FONT> * @return The trimmed string.<a name="line.72"></a> |
| <FONT color="green">073</FONT> */<a name="line.73"></a> |
| <FONT color="green">074</FONT> public XMLString fixWhiteSpace(boolean trimHead,<a name="line.74"></a> |
| <FONT color="green">075</FONT> boolean trimTail,<a name="line.75"></a> |
| <FONT color="green">076</FONT> boolean doublePunctuationSpaces);<a name="line.76"></a> |
| <FONT color="green">077</FONT> <a name="line.77"></a> |
| <FONT color="green">078</FONT> /**<a name="line.78"></a> |
| <FONT color="green">079</FONT> * Returns the length of this string.<a name="line.79"></a> |
| <FONT color="green">080</FONT> *<a name="line.80"></a> |
| <FONT color="green">081</FONT> * @return the length of the sequence of characters represented by this<a name="line.81"></a> |
| <FONT color="green">082</FONT> * object.<a name="line.82"></a> |
| <FONT color="green">083</FONT> */<a name="line.83"></a> |
| <FONT color="green">084</FONT> public abstract int length();<a name="line.84"></a> |
| <FONT color="green">085</FONT> <a name="line.85"></a> |
| <FONT color="green">086</FONT> /**<a name="line.86"></a> |
| <FONT color="green">087</FONT> * Returns the character at the specified index. An index ranges<a name="line.87"></a> |
| <FONT color="green">088</FONT> * from <code>0</code> to <code>length() - 1</code>. The first character<a name="line.88"></a> |
| <FONT color="green">089</FONT> * of the sequence is at index <code>0</code>, the next at index<a name="line.89"></a> |
| <FONT color="green">090</FONT> * <code>1</code>, and so on, as for array indexing.<a name="line.90"></a> |
| <FONT color="green">091</FONT> *<a name="line.91"></a> |
| <FONT color="green">092</FONT> * @param index the index of the character.<a name="line.92"></a> |
| <FONT color="green">093</FONT> * @return the character at the specified index of this string.<a name="line.93"></a> |
| <FONT color="green">094</FONT> * The first character is at index <code>0</code>.<a name="line.94"></a> |
| <FONT color="green">095</FONT> * @exception IndexOutOfBoundsException if the <code>index</code><a name="line.95"></a> |
| <FONT color="green">096</FONT> * argument is negative or not less than the length of this<a name="line.96"></a> |
| <FONT color="green">097</FONT> * string.<a name="line.97"></a> |
| <FONT color="green">098</FONT> */<a name="line.98"></a> |
| <FONT color="green">099</FONT> public abstract char charAt(int index);<a name="line.99"></a> |
| <FONT color="green">100</FONT> <a name="line.100"></a> |
| <FONT color="green">101</FONT> /**<a name="line.101"></a> |
| <FONT color="green">102</FONT> * Copies characters from this string into the destination character<a name="line.102"></a> |
| <FONT color="green">103</FONT> * array.<a name="line.103"></a> |
| <FONT color="green">104</FONT> *<a name="line.104"></a> |
| <FONT color="green">105</FONT> * @param srcBegin index of the first character in the string<a name="line.105"></a> |
| <FONT color="green">106</FONT> * to copy.<a name="line.106"></a> |
| <FONT color="green">107</FONT> * @param srcEnd index after the last character in the string<a name="line.107"></a> |
| <FONT color="green">108</FONT> * to copy.<a name="line.108"></a> |
| <FONT color="green">109</FONT> * @param dst the destination array.<a name="line.109"></a> |
| <FONT color="green">110</FONT> * @param dstBegin the start offset in the destination array.<a name="line.110"></a> |
| <FONT color="green">111</FONT> * @exception IndexOutOfBoundsException If any of the following<a name="line.111"></a> |
| <FONT color="green">112</FONT> * is true:<a name="line.112"></a> |
| <FONT color="green">113</FONT> * <ul><li><code>srcBegin</code> is negative.<a name="line.113"></a> |
| <FONT color="green">114</FONT> * <li><code>srcBegin</code> is greater than <code>srcEnd</code><a name="line.114"></a> |
| <FONT color="green">115</FONT> * <li><code>srcEnd</code> is greater than the length of this<a name="line.115"></a> |
| <FONT color="green">116</FONT> * string<a name="line.116"></a> |
| <FONT color="green">117</FONT> * <li><code>dstBegin</code> is negative<a name="line.117"></a> |
| <FONT color="green">118</FONT> * <li><code>dstBegin+(srcEnd-srcBegin)</code> is larger than<a name="line.118"></a> |
| <FONT color="green">119</FONT> * <code>dst.length</code></ul><a name="line.119"></a> |
| <FONT color="green">120</FONT> * @exception NullPointerException if <code>dst</code> is <code>null</code><a name="line.120"></a> |
| <FONT color="green">121</FONT> */<a name="line.121"></a> |
| <FONT color="green">122</FONT> public abstract void getChars(int srcBegin, int srcEnd, char dst[],<a name="line.122"></a> |
| <FONT color="green">123</FONT> int dstBegin);<a name="line.123"></a> |
| <FONT color="green">124</FONT> <a name="line.124"></a> |
| <FONT color="green">125</FONT> /**<a name="line.125"></a> |
| <FONT color="green">126</FONT> * Compares this string to the specified object.<a name="line.126"></a> |
| <FONT color="green">127</FONT> * The result is <code>true</code> if and only if the argument is not<a name="line.127"></a> |
| <FONT color="green">128</FONT> * <code>null</code> and is an <code>XMLString</code> object that represents<a name="line.128"></a> |
| <FONT color="green">129</FONT> * the same sequence of characters as this object.<a name="line.129"></a> |
| <FONT color="green">130</FONT> *<a name="line.130"></a> |
| <FONT color="green">131</FONT> * @param anObject the object to compare this <code>String</code><a name="line.131"></a> |
| <FONT color="green">132</FONT> * against.<a name="line.132"></a> |
| <FONT color="green">133</FONT> * @return <code>true</code> if the <code>String </code>are equal;<a name="line.133"></a> |
| <FONT color="green">134</FONT> * <code>false</code> otherwise.<a name="line.134"></a> |
| <FONT color="green">135</FONT> * @see java.lang.String#compareTo(java.lang.String)<a name="line.135"></a> |
| <FONT color="green">136</FONT> * @see java.lang.String#equalsIgnoreCase(java.lang.String)<a name="line.136"></a> |
| <FONT color="green">137</FONT> */<a name="line.137"></a> |
| <FONT color="green">138</FONT> public abstract boolean equals(XMLString anObject);<a name="line.138"></a> |
| <FONT color="green">139</FONT> <a name="line.139"></a> |
| <FONT color="green">140</FONT> /**<a name="line.140"></a> |
| <FONT color="green">141</FONT> * Compares this string to the specified <code>String</code>.<a name="line.141"></a> |
| <FONT color="green">142</FONT> * The result is <code>true</code> if and only if the argument is not<a name="line.142"></a> |
| <FONT color="green">143</FONT> * <code>null</code> and is a <code>String</code> object that represents<a name="line.143"></a> |
| <FONT color="green">144</FONT> * the same sequence of characters as this object.<a name="line.144"></a> |
| <FONT color="green">145</FONT> *<a name="line.145"></a> |
| <FONT color="green">146</FONT> * @param anotherString the object to compare this <code>String</code><a name="line.146"></a> |
| <FONT color="green">147</FONT> * against.<a name="line.147"></a> |
| <FONT color="green">148</FONT> * @return <code>true</code> if the <code>String</code>s are equal;<a name="line.148"></a> |
| <FONT color="green">149</FONT> * <code>false</code> otherwise.<a name="line.149"></a> |
| <FONT color="green">150</FONT> * @see java.lang.String#compareTo(java.lang.String)<a name="line.150"></a> |
| <FONT color="green">151</FONT> * @see java.lang.String#equalsIgnoreCase(java.lang.String)<a name="line.151"></a> |
| <FONT color="green">152</FONT> */<a name="line.152"></a> |
| <FONT color="green">153</FONT> public abstract boolean equals(String anotherString);<a name="line.153"></a> |
| <FONT color="green">154</FONT> <a name="line.154"></a> |
| <FONT color="green">155</FONT> /**<a name="line.155"></a> |
| <FONT color="green">156</FONT> * Compares this string to the specified object.<a name="line.156"></a> |
| <FONT color="green">157</FONT> * The result is <code>true</code> if and only if the argument is not<a name="line.157"></a> |
| <FONT color="green">158</FONT> * <code>null</code> and is a <code>String</code> object that represents<a name="line.158"></a> |
| <FONT color="green">159</FONT> * the same sequence of characters as this object.<a name="line.159"></a> |
| <FONT color="green">160</FONT> *<a name="line.160"></a> |
| <FONT color="green">161</FONT> * @param anObject the object to compare this <code>String</code><a name="line.161"></a> |
| <FONT color="green">162</FONT> * against.<a name="line.162"></a> |
| <FONT color="green">163</FONT> * @return <code>true</code> if the <code>String </code>are equal;<a name="line.163"></a> |
| <FONT color="green">164</FONT> * <code>false</code> otherwise.<a name="line.164"></a> |
| <FONT color="green">165</FONT> * @see java.lang.String#compareTo(java.lang.String)<a name="line.165"></a> |
| <FONT color="green">166</FONT> * @see java.lang.String#equalsIgnoreCase(java.lang.String)<a name="line.166"></a> |
| <FONT color="green">167</FONT> */<a name="line.167"></a> |
| <FONT color="green">168</FONT> public abstract boolean equals(Object anObject);<a name="line.168"></a> |
| <FONT color="green">169</FONT> <a name="line.169"></a> |
| <FONT color="green">170</FONT> /**<a name="line.170"></a> |
| <FONT color="green">171</FONT> * Compares this <code>String</code> to another <code>String</code>,<a name="line.171"></a> |
| <FONT color="green">172</FONT> * ignoring case considerations. Two strings are considered equal<a name="line.172"></a> |
| <FONT color="green">173</FONT> * ignoring case if they are of the same length, and corresponding<a name="line.173"></a> |
| <FONT color="green">174</FONT> * characters in the two strings are equal ignoring case.<a name="line.174"></a> |
| <FONT color="green">175</FONT> *<a name="line.175"></a> |
| <FONT color="green">176</FONT> * @param anotherString the <code>String</code> to compare this<a name="line.176"></a> |
| <FONT color="green">177</FONT> * <code>String</code> against.<a name="line.177"></a> |
| <FONT color="green">178</FONT> * @return <code>true</code> if the argument is not <code>null</code><a name="line.178"></a> |
| <FONT color="green">179</FONT> * and the <code>String</code>s are equal,<a name="line.179"></a> |
| <FONT color="green">180</FONT> * ignoring case; <code>false</code> otherwise.<a name="line.180"></a> |
| <FONT color="green">181</FONT> * @see #equals(Object)<a name="line.181"></a> |
| <FONT color="green">182</FONT> * @see java.lang.Character#toLowerCase(char)<a name="line.182"></a> |
| <FONT color="green">183</FONT> * @see java.lang.Character#toUpperCase(char)<a name="line.183"></a> |
| <FONT color="green">184</FONT> */<a name="line.184"></a> |
| <FONT color="green">185</FONT> public abstract boolean equalsIgnoreCase(String anotherString);<a name="line.185"></a> |
| <FONT color="green">186</FONT> <a name="line.186"></a> |
| <FONT color="green">187</FONT> /**<a name="line.187"></a> |
| <FONT color="green">188</FONT> * Compares two strings lexicographically.<a name="line.188"></a> |
| <FONT color="green">189</FONT> *<a name="line.189"></a> |
| <FONT color="green">190</FONT> * @param anotherString the <code>String</code> to be compared.<a name="line.190"></a> |
| <FONT color="green">191</FONT> * @return the value <code>0</code> if the argument string is equal to<a name="line.191"></a> |
| <FONT color="green">192</FONT> * this string; a value less than <code>0</code> if this string<a name="line.192"></a> |
| <FONT color="green">193</FONT> * is lexicographically less than the string argument; and a<a name="line.193"></a> |
| <FONT color="green">194</FONT> * value greater than <code>0</code> if this string is<a name="line.194"></a> |
| <FONT color="green">195</FONT> * lexicographically greater than the string argument.<a name="line.195"></a> |
| <FONT color="green">196</FONT> * @exception java.lang.NullPointerException if <code>anotherString</code><a name="line.196"></a> |
| <FONT color="green">197</FONT> * is <code>null</code>.<a name="line.197"></a> |
| <FONT color="green">198</FONT> */<a name="line.198"></a> |
| <FONT color="green">199</FONT> public abstract int compareTo(XMLString anotherString);<a name="line.199"></a> |
| <FONT color="green">200</FONT> <a name="line.200"></a> |
| <FONT color="green">201</FONT> /**<a name="line.201"></a> |
| <FONT color="green">202</FONT> * Compares two strings lexicographically, ignoring case considerations.<a name="line.202"></a> |
| <FONT color="green">203</FONT> * This method returns an integer whose sign is that of<a name="line.203"></a> |
| <FONT color="green">204</FONT> * <code>this.toUpperCase().toLowerCase().compareTo(<a name="line.204"></a> |
| <FONT color="green">205</FONT> * str.toUpperCase().toLowerCase())</code>.<a name="line.205"></a> |
| <FONT color="green">206</FONT> * <p><a name="line.206"></a> |
| <FONT color="green">207</FONT> * Note that this method does <em>not</em> take locale into account,<a name="line.207"></a> |
| <FONT color="green">208</FONT> * and will result in an unsatisfactory ordering for certain locales.<a name="line.208"></a> |
| <FONT color="green">209</FONT> * The java.text package provides <em>collators</em> to allow<a name="line.209"></a> |
| <FONT color="green">210</FONT> * locale-sensitive ordering.<a name="line.210"></a> |
| <FONT color="green">211</FONT> *<a name="line.211"></a> |
| <FONT color="green">212</FONT> * @param str the <code>String</code> to be compared.<a name="line.212"></a> |
| <FONT color="green">213</FONT> * @return a negative integer, zero, or a positive integer as the<a name="line.213"></a> |
| <FONT color="green">214</FONT> * the specified String is greater than, equal to, or less<a name="line.214"></a> |
| <FONT color="green">215</FONT> * than this String, ignoring case considerations.<a name="line.215"></a> |
| <FONT color="green">216</FONT> * @see java.text.Collator#compare(String, String)<a name="line.216"></a> |
| <FONT color="green">217</FONT> * @since 1.2<a name="line.217"></a> |
| <FONT color="green">218</FONT> */<a name="line.218"></a> |
| <FONT color="green">219</FONT> public abstract int compareToIgnoreCase(XMLString str);<a name="line.219"></a> |
| <FONT color="green">220</FONT> <a name="line.220"></a> |
| <FONT color="green">221</FONT> /**<a name="line.221"></a> |
| <FONT color="green">222</FONT> * Tests if this string starts with the specified prefix beginning<a name="line.222"></a> |
| <FONT color="green">223</FONT> * a specified index.<a name="line.223"></a> |
| <FONT color="green">224</FONT> *<a name="line.224"></a> |
| <FONT color="green">225</FONT> * @param prefix the prefix.<a name="line.225"></a> |
| <FONT color="green">226</FONT> * @param toffset where to begin looking in the string.<a name="line.226"></a> |
| <FONT color="green">227</FONT> * @return <code>true</code> if the character sequence represented by the<a name="line.227"></a> |
| <FONT color="green">228</FONT> * argument is a prefix of the substring of this object starting<a name="line.228"></a> |
| <FONT color="green">229</FONT> * at index <code>toffset</code>; <code>false</code> otherwise.<a name="line.229"></a> |
| <FONT color="green">230</FONT> * The result is <code>false</code> if <code>toffset</code> is<a name="line.230"></a> |
| <FONT color="green">231</FONT> * negative or greater than the length of this<a name="line.231"></a> |
| <FONT color="green">232</FONT> * <code>String</code> object; otherwise the result is the same<a name="line.232"></a> |
| <FONT color="green">233</FONT> * as the result of the expression<a name="line.233"></a> |
| <FONT color="green">234</FONT> * <pre><a name="line.234"></a> |
| <FONT color="green">235</FONT> * this.subString(toffset).startsWith(prefix)<a name="line.235"></a> |
| <FONT color="green">236</FONT> * </pre><a name="line.236"></a> |
| <FONT color="green">237</FONT> * @exception java.lang.NullPointerException if <code>prefix</code> is<a name="line.237"></a> |
| <FONT color="green">238</FONT> * <code>null</code>.<a name="line.238"></a> |
| <FONT color="green">239</FONT> */<a name="line.239"></a> |
| <FONT color="green">240</FONT> public abstract boolean startsWith(String prefix, int toffset);<a name="line.240"></a> |
| <FONT color="green">241</FONT> <a name="line.241"></a> |
| <FONT color="green">242</FONT> /**<a name="line.242"></a> |
| <FONT color="green">243</FONT> * Tests if this string starts with the specified prefix beginning<a name="line.243"></a> |
| <FONT color="green">244</FONT> * a specified index.<a name="line.244"></a> |
| <FONT color="green">245</FONT> *<a name="line.245"></a> |
| <FONT color="green">246</FONT> * @param prefix the prefix.<a name="line.246"></a> |
| <FONT color="green">247</FONT> * @param toffset where to begin looking in the string.<a name="line.247"></a> |
| <FONT color="green">248</FONT> * @return <code>true</code> if the character sequence represented by the<a name="line.248"></a> |
| <FONT color="green">249</FONT> * argument is a prefix of the substring of this object starting<a name="line.249"></a> |
| <FONT color="green">250</FONT> * at index <code>toffset</code>; <code>false</code> otherwise.<a name="line.250"></a> |
| <FONT color="green">251</FONT> * The result is <code>false</code> if <code>toffset</code> is<a name="line.251"></a> |
| <FONT color="green">252</FONT> * negative or greater than the length of this<a name="line.252"></a> |
| <FONT color="green">253</FONT> * <code>String</code> object; otherwise the result is the same<a name="line.253"></a> |
| <FONT color="green">254</FONT> * as the result of the expression<a name="line.254"></a> |
| <FONT color="green">255</FONT> * <pre><a name="line.255"></a> |
| <FONT color="green">256</FONT> * this.subString(toffset).startsWith(prefix)<a name="line.256"></a> |
| <FONT color="green">257</FONT> * </pre><a name="line.257"></a> |
| <FONT color="green">258</FONT> * @exception java.lang.NullPointerException if <code>prefix</code> is<a name="line.258"></a> |
| <FONT color="green">259</FONT> * <code>null</code>.<a name="line.259"></a> |
| <FONT color="green">260</FONT> */<a name="line.260"></a> |
| <FONT color="green">261</FONT> public abstract boolean startsWith(XMLString prefix, int toffset);<a name="line.261"></a> |
| <FONT color="green">262</FONT> <a name="line.262"></a> |
| <FONT color="green">263</FONT> /**<a name="line.263"></a> |
| <FONT color="green">264</FONT> * Tests if this string starts with the specified prefix.<a name="line.264"></a> |
| <FONT color="green">265</FONT> *<a name="line.265"></a> |
| <FONT color="green">266</FONT> * @param prefix the prefix.<a name="line.266"></a> |
| <FONT color="green">267</FONT> * @return <code>true</code> if the character sequence represented by the<a name="line.267"></a> |
| <FONT color="green">268</FONT> * argument is a prefix of the character sequence represented by<a name="line.268"></a> |
| <FONT color="green">269</FONT> * this string; <code>false</code> otherwise.<a name="line.269"></a> |
| <FONT color="green">270</FONT> * Note also that <code>true</code> will be returned if the<a name="line.270"></a> |
| <FONT color="green">271</FONT> * argument is an empty string or is equal to this<a name="line.271"></a> |
| <FONT color="green">272</FONT> * <code>String</code> object as determined by the<a name="line.272"></a> |
| <FONT color="green">273</FONT> * {@link #equals(Object)} method.<a name="line.273"></a> |
| <FONT color="green">274</FONT> * @exception java.lang.NullPointerException if <code>prefix</code> is<a name="line.274"></a> |
| <FONT color="green">275</FONT> * <code>null</code>.<a name="line.275"></a> |
| <FONT color="green">276</FONT> * @since JDK1. 0<a name="line.276"></a> |
| <FONT color="green">277</FONT> */<a name="line.277"></a> |
| <FONT color="green">278</FONT> public abstract boolean startsWith(String prefix);<a name="line.278"></a> |
| <FONT color="green">279</FONT> <a name="line.279"></a> |
| <FONT color="green">280</FONT> /**<a name="line.280"></a> |
| <FONT color="green">281</FONT> * Tests if this string starts with the specified prefix.<a name="line.281"></a> |
| <FONT color="green">282</FONT> *<a name="line.282"></a> |
| <FONT color="green">283</FONT> * @param prefix the prefix.<a name="line.283"></a> |
| <FONT color="green">284</FONT> * @return <code>true</code> if the character sequence represented by the<a name="line.284"></a> |
| <FONT color="green">285</FONT> * argument is a prefix of the character sequence represented by<a name="line.285"></a> |
| <FONT color="green">286</FONT> * this string; <code>false</code> otherwise.<a name="line.286"></a> |
| <FONT color="green">287</FONT> * Note also that <code>true</code> will be returned if the<a name="line.287"></a> |
| <FONT color="green">288</FONT> * argument is an empty string or is equal to this<a name="line.288"></a> |
| <FONT color="green">289</FONT> * <code>String</code> object as determined by the<a name="line.289"></a> |
| <FONT color="green">290</FONT> * {@link #equals(Object)} method.<a name="line.290"></a> |
| <FONT color="green">291</FONT> * @exception java.lang.NullPointerException if <code>prefix</code> is<a name="line.291"></a> |
| <FONT color="green">292</FONT> * <code>null</code>.<a name="line.292"></a> |
| <FONT color="green">293</FONT> * @since JDK1. 0<a name="line.293"></a> |
| <FONT color="green">294</FONT> */<a name="line.294"></a> |
| <FONT color="green">295</FONT> public abstract boolean startsWith(XMLString prefix);<a name="line.295"></a> |
| <FONT color="green">296</FONT> <a name="line.296"></a> |
| <FONT color="green">297</FONT> /**<a name="line.297"></a> |
| <FONT color="green">298</FONT> * Tests if this string ends with the specified suffix.<a name="line.298"></a> |
| <FONT color="green">299</FONT> *<a name="line.299"></a> |
| <FONT color="green">300</FONT> * @param suffix the suffix.<a name="line.300"></a> |
| <FONT color="green">301</FONT> * @return <code>true</code> if the character sequence represented by the<a name="line.301"></a> |
| <FONT color="green">302</FONT> * argument is a suffix of the character sequence represented by<a name="line.302"></a> |
| <FONT color="green">303</FONT> * this object; <code>false</code> otherwise. Note that the<a name="line.303"></a> |
| <FONT color="green">304</FONT> * result will be <code>true</code> if the argument is the<a name="line.304"></a> |
| <FONT color="green">305</FONT> * empty string or is equal to this <code>String</code> object<a name="line.305"></a> |
| <FONT color="green">306</FONT> * as determined by the {@link #equals(Object)} method.<a name="line.306"></a> |
| <FONT color="green">307</FONT> * @exception java.lang.NullPointerException if <code>suffix</code> is<a name="line.307"></a> |
| <FONT color="green">308</FONT> * <code>null</code>.<a name="line.308"></a> |
| <FONT color="green">309</FONT> */<a name="line.309"></a> |
| <FONT color="green">310</FONT> public abstract boolean endsWith(String suffix);<a name="line.310"></a> |
| <FONT color="green">311</FONT> <a name="line.311"></a> |
| <FONT color="green">312</FONT> /**<a name="line.312"></a> |
| <FONT color="green">313</FONT> * Returns a hashcode for this string. The hashcode for a<a name="line.313"></a> |
| <FONT color="green">314</FONT> * <code>String</code> object is computed as<a name="line.314"></a> |
| <FONT color="green">315</FONT> * <blockquote><pre><a name="line.315"></a> |
| <FONT color="green">316</FONT> * s[0]*31^(n-1) + s[1]*31^(n-2) + ... + s[n-1]<a name="line.316"></a> |
| <FONT color="green">317</FONT> * </pre></blockquote><a name="line.317"></a> |
| <FONT color="green">318</FONT> * using <code>int</code> arithmetic, where <code>s[i]</code> is the<a name="line.318"></a> |
| <FONT color="green">319</FONT> * <i>i</i>th character of the string, <code>n</code> is the length of<a name="line.319"></a> |
| <FONT color="green">320</FONT> * the string, and <code>^</code> indicates exponentiation.<a name="line.320"></a> |
| <FONT color="green">321</FONT> * (The hash value of the empty string is zero.)<a name="line.321"></a> |
| <FONT color="green">322</FONT> *<a name="line.322"></a> |
| <FONT color="green">323</FONT> * @return a hash code value for this object.<a name="line.323"></a> |
| <FONT color="green">324</FONT> */<a name="line.324"></a> |
| <FONT color="green">325</FONT> public abstract int hashCode();<a name="line.325"></a> |
| <FONT color="green">326</FONT> <a name="line.326"></a> |
| <FONT color="green">327</FONT> /**<a name="line.327"></a> |
| <FONT color="green">328</FONT> * Returns the index within this string of the first occurrence of the<a name="line.328"></a> |
| <FONT color="green">329</FONT> * specified character. If a character with value <code>ch</code> occurs<a name="line.329"></a> |
| <FONT color="green">330</FONT> * in the character sequence represented by this <code>String</code><a name="line.330"></a> |
| <FONT color="green">331</FONT> * object, then the index of the first such occurrence is returned --<a name="line.331"></a> |
| <FONT color="green">332</FONT> * that is, the smallest value <i>k</i> such that:<a name="line.332"></a> |
| <FONT color="green">333</FONT> * <blockquote><pre><a name="line.333"></a> |
| <FONT color="green">334</FONT> * this.charAt(<i>k</i>) == ch<a name="line.334"></a> |
| <FONT color="green">335</FONT> * </pre></blockquote><a name="line.335"></a> |
| <FONT color="green">336</FONT> * is <code>true</code>. If no such character occurs in this string,<a name="line.336"></a> |
| <FONT color="green">337</FONT> * then <code>-1</code> is returned.<a name="line.337"></a> |
| <FONT color="green">338</FONT> *<a name="line.338"></a> |
| <FONT color="green">339</FONT> * @param ch a character.<a name="line.339"></a> |
| <FONT color="green">340</FONT> * @return the index of the first occurrence of the character in the<a name="line.340"></a> |
| <FONT color="green">341</FONT> * character sequence represented by this object, or<a name="line.341"></a> |
| <FONT color="green">342</FONT> * <code>-1</code> if the character does not occur.<a name="line.342"></a> |
| <FONT color="green">343</FONT> */<a name="line.343"></a> |
| <FONT color="green">344</FONT> public abstract int indexOf(int ch);<a name="line.344"></a> |
| <FONT color="green">345</FONT> <a name="line.345"></a> |
| <FONT color="green">346</FONT> /**<a name="line.346"></a> |
| <FONT color="green">347</FONT> * Returns the index within this string of the first occurrence of the<a name="line.347"></a> |
| <FONT color="green">348</FONT> * specified character, starting the search at the specified index.<a name="line.348"></a> |
| <FONT color="green">349</FONT> * <p><a name="line.349"></a> |
| <FONT color="green">350</FONT> * If a character with value <code>ch</code> occurs in the character<a name="line.350"></a> |
| <FONT color="green">351</FONT> * sequence represented by this <code>String</code> object at an index<a name="line.351"></a> |
| <FONT color="green">352</FONT> * no smaller than <code>fromIndex</code>, then the index of the first<a name="line.352"></a> |
| <FONT color="green">353</FONT> * such occurrence is returned--that is, the smallest value <i>k</i><a name="line.353"></a> |
| <FONT color="green">354</FONT> * such that:<a name="line.354"></a> |
| <FONT color="green">355</FONT> * <blockquote><pre><a name="line.355"></a> |
| <FONT color="green">356</FONT> * (this.charAt(<i>k</i>) == ch) && (<i>k</i> >= fromIndex)<a name="line.356"></a> |
| <FONT color="green">357</FONT> * </pre></blockquote><a name="line.357"></a> |
| <FONT color="green">358</FONT> * is true. If no such character occurs in this string at or after<a name="line.358"></a> |
| <FONT color="green">359</FONT> * position <code>fromIndex</code>, then <code>-1</code> is returned.<a name="line.359"></a> |
| <FONT color="green">360</FONT> * <p><a name="line.360"></a> |
| <FONT color="green">361</FONT> * There is no restriction on the value of <code>fromIndex</code>. If it<a name="line.361"></a> |
| <FONT color="green">362</FONT> * is negative, it has the same effect as if it were zero: this entire<a name="line.362"></a> |
| <FONT color="green">363</FONT> * string may be searched. If it is greater than the length of this<a name="line.363"></a> |
| <FONT color="green">364</FONT> * string, it has the same effect as if it were equal to the length of<a name="line.364"></a> |
| <FONT color="green">365</FONT> * this string: <code>-1</code> is returned.<a name="line.365"></a> |
| <FONT color="green">366</FONT> *<a name="line.366"></a> |
| <FONT color="green">367</FONT> * @param ch a character.<a name="line.367"></a> |
| <FONT color="green">368</FONT> * @param fromIndex the index to start the search from.<a name="line.368"></a> |
| <FONT color="green">369</FONT> * @return the index of the first occurrence of the character in the<a name="line.369"></a> |
| <FONT color="green">370</FONT> * character sequence represented by this object that is greater<a name="line.370"></a> |
| <FONT color="green">371</FONT> * than or equal to <code>fromIndex</code>, or <code>-1</code><a name="line.371"></a> |
| <FONT color="green">372</FONT> * if the character does not occur.<a name="line.372"></a> |
| <FONT color="green">373</FONT> */<a name="line.373"></a> |
| <FONT color="green">374</FONT> public abstract int indexOf(int ch, int fromIndex);<a name="line.374"></a> |
| <FONT color="green">375</FONT> <a name="line.375"></a> |
| <FONT color="green">376</FONT> /**<a name="line.376"></a> |
| <FONT color="green">377</FONT> * Returns the index within this string of the last occurrence of the<a name="line.377"></a> |
| <FONT color="green">378</FONT> * specified character. That is, the index returned is the largest<a name="line.378"></a> |
| <FONT color="green">379</FONT> * value <i>k</i> such that:<a name="line.379"></a> |
| <FONT color="green">380</FONT> * <blockquote><pre><a name="line.380"></a> |
| <FONT color="green">381</FONT> * this.charAt(<i>k</i>) == ch<a name="line.381"></a> |
| <FONT color="green">382</FONT> * </pre></blockquote><a name="line.382"></a> |
| <FONT color="green">383</FONT> * is true.<a name="line.383"></a> |
| <FONT color="green">384</FONT> * The String is searched backwards starting at the last character.<a name="line.384"></a> |
| <FONT color="green">385</FONT> *<a name="line.385"></a> |
| <FONT color="green">386</FONT> * @param ch a character.<a name="line.386"></a> |
| <FONT color="green">387</FONT> * @return the index of the last occurrence of the character in the<a name="line.387"></a> |
| <FONT color="green">388</FONT> * character sequence represented by this object, or<a name="line.388"></a> |
| <FONT color="green">389</FONT> * <code>-1</code> if the character does not occur.<a name="line.389"></a> |
| <FONT color="green">390</FONT> */<a name="line.390"></a> |
| <FONT color="green">391</FONT> public abstract int lastIndexOf(int ch);<a name="line.391"></a> |
| <FONT color="green">392</FONT> <a name="line.392"></a> |
| <FONT color="green">393</FONT> /**<a name="line.393"></a> |
| <FONT color="green">394</FONT> * Returns the index within this string of the last occurrence of the<a name="line.394"></a> |
| <FONT color="green">395</FONT> * specified character, searching backward starting at the specified<a name="line.395"></a> |
| <FONT color="green">396</FONT> * index. That is, the index returned is the largest value <i>k</i><a name="line.396"></a> |
| <FONT color="green">397</FONT> * such that:<a name="line.397"></a> |
| <FONT color="green">398</FONT> * <blockquote><pre><a name="line.398"></a> |
| <FONT color="green">399</FONT> * this.charAt(k) == ch) && (k <= fromIndex)<a name="line.399"></a> |
| <FONT color="green">400</FONT> * </pre></blockquote><a name="line.400"></a> |
| <FONT color="green">401</FONT> * is true.<a name="line.401"></a> |
| <FONT color="green">402</FONT> *<a name="line.402"></a> |
| <FONT color="green">403</FONT> * @param ch a character.<a name="line.403"></a> |
| <FONT color="green">404</FONT> * @param fromIndex the index to start the search from. There is no<a name="line.404"></a> |
| <FONT color="green">405</FONT> * restriction on the value of <code>fromIndex</code>. If it is<a name="line.405"></a> |
| <FONT color="green">406</FONT> * greater than or equal to the length of this string, it has<a name="line.406"></a> |
| <FONT color="green">407</FONT> * the same effect as if it were equal to one less than the<a name="line.407"></a> |
| <FONT color="green">408</FONT> * length of this string: this entire string may be searched.<a name="line.408"></a> |
| <FONT color="green">409</FONT> * If it is negative, it has the same effect as if it were -1:<a name="line.409"></a> |
| <FONT color="green">410</FONT> * -1 is returned.<a name="line.410"></a> |
| <FONT color="green">411</FONT> * @return the index of the last occurrence of the character in the<a name="line.411"></a> |
| <FONT color="green">412</FONT> * character sequence represented by this object that is less<a name="line.412"></a> |
| <FONT color="green">413</FONT> * than or equal to <code>fromIndex</code>, or <code>-1</code><a name="line.413"></a> |
| <FONT color="green">414</FONT> * if the character does not occur before that point.<a name="line.414"></a> |
| <FONT color="green">415</FONT> */<a name="line.415"></a> |
| <FONT color="green">416</FONT> public abstract int lastIndexOf(int ch, int fromIndex);<a name="line.416"></a> |
| <FONT color="green">417</FONT> <a name="line.417"></a> |
| <FONT color="green">418</FONT> /**<a name="line.418"></a> |
| <FONT color="green">419</FONT> * Returns the index within this string of the first occurrence of the<a name="line.419"></a> |
| <FONT color="green">420</FONT> * specified substring. The integer returned is the smallest value<a name="line.420"></a> |
| <FONT color="green">421</FONT> * <i>k</i> such that:<a name="line.421"></a> |
| <FONT color="green">422</FONT> * <blockquote><pre><a name="line.422"></a> |
| <FONT color="green">423</FONT> * this.startsWith(str, <i>k</i>)<a name="line.423"></a> |
| <FONT color="green">424</FONT> * </pre></blockquote><a name="line.424"></a> |
| <FONT color="green">425</FONT> * is <code>true</code>.<a name="line.425"></a> |
| <FONT color="green">426</FONT> *<a name="line.426"></a> |
| <FONT color="green">427</FONT> * @param str any string.<a name="line.427"></a> |
| <FONT color="green">428</FONT> * @return if the string argument occurs as a substring within this<a name="line.428"></a> |
| <FONT color="green">429</FONT> * object, then the index of the first character of the first<a name="line.429"></a> |
| <FONT color="green">430</FONT> * such substring is returned; if it does not occur as a<a name="line.430"></a> |
| <FONT color="green">431</FONT> * substring, <code>-1</code> is returned.<a name="line.431"></a> |
| <FONT color="green">432</FONT> * @exception java.lang.NullPointerException if <code>str</code> is<a name="line.432"></a> |
| <FONT color="green">433</FONT> * <code>null</code>.<a name="line.433"></a> |
| <FONT color="green">434</FONT> */<a name="line.434"></a> |
| <FONT color="green">435</FONT> public abstract int indexOf(String str);<a name="line.435"></a> |
| <FONT color="green">436</FONT> <a name="line.436"></a> |
| <FONT color="green">437</FONT> /**<a name="line.437"></a> |
| <FONT color="green">438</FONT> * Returns the index within this string of the first occurrence of the<a name="line.438"></a> |
| <FONT color="green">439</FONT> * specified substring. The integer returned is the smallest value<a name="line.439"></a> |
| <FONT color="green">440</FONT> * <i>k</i> such that:<a name="line.440"></a> |
| <FONT color="green">441</FONT> * <blockquote><pre><a name="line.441"></a> |
| <FONT color="green">442</FONT> * this.startsWith(str, <i>k</i>)<a name="line.442"></a> |
| <FONT color="green">443</FONT> * </pre></blockquote><a name="line.443"></a> |
| <FONT color="green">444</FONT> * is <code>true</code>.<a name="line.444"></a> |
| <FONT color="green">445</FONT> *<a name="line.445"></a> |
| <FONT color="green">446</FONT> * @param str any string.<a name="line.446"></a> |
| <FONT color="green">447</FONT> * @return if the string argument occurs as a substring within this<a name="line.447"></a> |
| <FONT color="green">448</FONT> * object, then the index of the first character of the first<a name="line.448"></a> |
| <FONT color="green">449</FONT> * such substring is returned; if it does not occur as a<a name="line.449"></a> |
| <FONT color="green">450</FONT> * substring, <code>-1</code> is returned.<a name="line.450"></a> |
| <FONT color="green">451</FONT> * @exception java.lang.NullPointerException if <code>str</code> is<a name="line.451"></a> |
| <FONT color="green">452</FONT> * <code>null</code>.<a name="line.452"></a> |
| <FONT color="green">453</FONT> */<a name="line.453"></a> |
| <FONT color="green">454</FONT> public abstract int indexOf(XMLString str);<a name="line.454"></a> |
| <FONT color="green">455</FONT> <a name="line.455"></a> |
| <FONT color="green">456</FONT> /**<a name="line.456"></a> |
| <FONT color="green">457</FONT> * Returns the index within this string of the first occurrence of the<a name="line.457"></a> |
| <FONT color="green">458</FONT> * specified substring, starting at the specified index. The integer<a name="line.458"></a> |
| <FONT color="green">459</FONT> * returned is the smallest value <i>k</i> such that:<a name="line.459"></a> |
| <FONT color="green">460</FONT> * <blockquote><pre><a name="line.460"></a> |
| <FONT color="green">461</FONT> * this.startsWith(str, <i>k</i>) && (<i>k</i> >= fromIndex)<a name="line.461"></a> |
| <FONT color="green">462</FONT> * </pre></blockquote><a name="line.462"></a> |
| <FONT color="green">463</FONT> * is <code>true</code>.<a name="line.463"></a> |
| <FONT color="green">464</FONT> * <p><a name="line.464"></a> |
| <FONT color="green">465</FONT> * There is no restriction on the value of <code>fromIndex</code>. If<a name="line.465"></a> |
| <FONT color="green">466</FONT> * it is negative, it has the same effect as if it were zero: this entire<a name="line.466"></a> |
| <FONT color="green">467</FONT> * string may be searched. If it is greater than the length of this<a name="line.467"></a> |
| <FONT color="green">468</FONT> * string, it has the same effect as if it were equal to the length of<a name="line.468"></a> |
| <FONT color="green">469</FONT> * this string: <code>-1</code> is returned.<a name="line.469"></a> |
| <FONT color="green">470</FONT> *<a name="line.470"></a> |
| <FONT color="green">471</FONT> * @param str the substring to search for.<a name="line.471"></a> |
| <FONT color="green">472</FONT> * @param fromIndex the index to start the search from.<a name="line.472"></a> |
| <FONT color="green">473</FONT> * @return If the string argument occurs as a substring within this<a name="line.473"></a> |
| <FONT color="green">474</FONT> * object at a starting index no smaller than<a name="line.474"></a> |
| <FONT color="green">475</FONT> * <code>fromIndex</code>, then the index of the first character<a name="line.475"></a> |
| <FONT color="green">476</FONT> * of the first such substring is returned. If it does not occur<a name="line.476"></a> |
| <FONT color="green">477</FONT> * as a substring starting at <code>fromIndex</code> or beyond,<a name="line.477"></a> |
| <FONT color="green">478</FONT> * <code>-1</code> is returned.<a name="line.478"></a> |
| <FONT color="green">479</FONT> * @exception java.lang.NullPointerException if <code>str</code> is<a name="line.479"></a> |
| <FONT color="green">480</FONT> * <code>null</code><a name="line.480"></a> |
| <FONT color="green">481</FONT> */<a name="line.481"></a> |
| <FONT color="green">482</FONT> public abstract int indexOf(String str, int fromIndex);<a name="line.482"></a> |
| <FONT color="green">483</FONT> <a name="line.483"></a> |
| <FONT color="green">484</FONT> /**<a name="line.484"></a> |
| <FONT color="green">485</FONT> * Returns the index within this string of the rightmost occurrence<a name="line.485"></a> |
| <FONT color="green">486</FONT> * of the specified substring. The rightmost empty string "" is<a name="line.486"></a> |
| <FONT color="green">487</FONT> * considered to occur at the index value <code>this.length()</code>.<a name="line.487"></a> |
| <FONT color="green">488</FONT> * The returned index is the largest value <i>k</i> such that<a name="line.488"></a> |
| <FONT color="green">489</FONT> * <blockquote><pre><a name="line.489"></a> |
| <FONT color="green">490</FONT> * this.startsWith(str, k)<a name="line.490"></a> |
| <FONT color="green">491</FONT> * </pre></blockquote><a name="line.491"></a> |
| <FONT color="green">492</FONT> * is true.<a name="line.492"></a> |
| <FONT color="green">493</FONT> *<a name="line.493"></a> |
| <FONT color="green">494</FONT> * @param str the substring to search for.<a name="line.494"></a> |
| <FONT color="green">495</FONT> * @return if the string argument occurs one or more times as a substring<a name="line.495"></a> |
| <FONT color="green">496</FONT> * within this object, then the index of the first character of<a name="line.496"></a> |
| <FONT color="green">497</FONT> * the last such substring is returned. If it does not occur as<a name="line.497"></a> |
| <FONT color="green">498</FONT> * a substring, <code>-1</code> is returned.<a name="line.498"></a> |
| <FONT color="green">499</FONT> * @exception java.lang.NullPointerException if <code>str</code> is<a name="line.499"></a> |
| <FONT color="green">500</FONT> * <code>null</code>.<a name="line.500"></a> |
| <FONT color="green">501</FONT> */<a name="line.501"></a> |
| <FONT color="green">502</FONT> public abstract int lastIndexOf(String str);<a name="line.502"></a> |
| <FONT color="green">503</FONT> <a name="line.503"></a> |
| <FONT color="green">504</FONT> /**<a name="line.504"></a> |
| <FONT color="green">505</FONT> * Returns the index within this string of the last occurrence of<a name="line.505"></a> |
| <FONT color="green">506</FONT> * the specified substring.<a name="line.506"></a> |
| <FONT color="green">507</FONT> *<a name="line.507"></a> |
| <FONT color="green">508</FONT> * @param str the substring to search for.<a name="line.508"></a> |
| <FONT color="green">509</FONT> * @param fromIndex the index to start the search from. There is no<a name="line.509"></a> |
| <FONT color="green">510</FONT> * restriction on the value of fromIndex. If it is greater than<a name="line.510"></a> |
| <FONT color="green">511</FONT> * the length of this string, it has the same effect as if it<a name="line.511"></a> |
| <FONT color="green">512</FONT> * were equal to the length of this string: this entire string<a name="line.512"></a> |
| <FONT color="green">513</FONT> * may be searched. If it is negative, it has the same effect<a name="line.513"></a> |
| <FONT color="green">514</FONT> * as if it were -1: -1 is returned.<a name="line.514"></a> |
| <FONT color="green">515</FONT> * @return If the string argument occurs one or more times as a substring<a name="line.515"></a> |
| <FONT color="green">516</FONT> * within this object at a starting index no greater than<a name="line.516"></a> |
| <FONT color="green">517</FONT> * <code>fromIndex</code>, then the index of the first character of<a name="line.517"></a> |
| <FONT color="green">518</FONT> * the last such substring is returned. If it does not occur as a<a name="line.518"></a> |
| <FONT color="green">519</FONT> * substring starting at <code>fromIndex</code> or earlier,<a name="line.519"></a> |
| <FONT color="green">520</FONT> * <code>-1</code> is returned.<a name="line.520"></a> |
| <FONT color="green">521</FONT> * @exception java.lang.NullPointerException if <code>str</code> is<a name="line.521"></a> |
| <FONT color="green">522</FONT> * <code>null</code>.<a name="line.522"></a> |
| <FONT color="green">523</FONT> */<a name="line.523"></a> |
| <FONT color="green">524</FONT> public abstract int lastIndexOf(String str, int fromIndex);<a name="line.524"></a> |
| <FONT color="green">525</FONT> <a name="line.525"></a> |
| <FONT color="green">526</FONT> /**<a name="line.526"></a> |
| <FONT color="green">527</FONT> * Returns a new string that is a substring of this string. The<a name="line.527"></a> |
| <FONT color="green">528</FONT> * substring begins with the character at the specified index and<a name="line.528"></a> |
| <FONT color="green">529</FONT> * extends to the end of this string. <p><a name="line.529"></a> |
| <FONT color="green">530</FONT> * Examples:<a name="line.530"></a> |
| <FONT color="green">531</FONT> * <blockquote><pre><a name="line.531"></a> |
| <FONT color="green">532</FONT> * "unhappy".substring(2) returns "happy"<a name="line.532"></a> |
| <FONT color="green">533</FONT> * "Harbison".substring(3) returns "bison"<a name="line.533"></a> |
| <FONT color="green">534</FONT> * "emptiness".substring(9) returns "" (an empty string)<a name="line.534"></a> |
| <FONT color="green">535</FONT> * </pre></blockquote><a name="line.535"></a> |
| <FONT color="green">536</FONT> *<a name="line.536"></a> |
| <FONT color="green">537</FONT> * @param beginIndex the beginning index, inclusive.<a name="line.537"></a> |
| <FONT color="green">538</FONT> * @return the specified substring.<a name="line.538"></a> |
| <FONT color="green">539</FONT> * @exception IndexOutOfBoundsException if<a name="line.539"></a> |
| <FONT color="green">540</FONT> * <code>beginIndex</code> is negative or larger than the<a name="line.540"></a> |
| <FONT color="green">541</FONT> * length of this <code>String</code> object.<a name="line.541"></a> |
| <FONT color="green">542</FONT> */<a name="line.542"></a> |
| <FONT color="green">543</FONT> public abstract XMLString substring(int beginIndex);<a name="line.543"></a> |
| <FONT color="green">544</FONT> <a name="line.544"></a> |
| <FONT color="green">545</FONT> /**<a name="line.545"></a> |
| <FONT color="green">546</FONT> * Returns a new string that is a substring of this string. The<a name="line.546"></a> |
| <FONT color="green">547</FONT> * substring begins at the specified <code>beginIndex</code> and<a name="line.547"></a> |
| <FONT color="green">548</FONT> * extends to the character at index <code>endIndex - 1</code>.<a name="line.548"></a> |
| <FONT color="green">549</FONT> * Thus the length of the substring is <code>endIndex-beginIndex</code>.<a name="line.549"></a> |
| <FONT color="green">550</FONT> *<a name="line.550"></a> |
| <FONT color="green">551</FONT> * @param beginIndex the beginning index, inclusive.<a name="line.551"></a> |
| <FONT color="green">552</FONT> * @param endIndex the ending index, exclusive.<a name="line.552"></a> |
| <FONT color="green">553</FONT> * @return the specified substring.<a name="line.553"></a> |
| <FONT color="green">554</FONT> * @exception IndexOutOfBoundsException if the<a name="line.554"></a> |
| <FONT color="green">555</FONT> * <code>beginIndex</code> is negative, or<a name="line.555"></a> |
| <FONT color="green">556</FONT> * <code>endIndex</code> is larger than the length of<a name="line.556"></a> |
| <FONT color="green">557</FONT> * this <code>String</code> object, or<a name="line.557"></a> |
| <FONT color="green">558</FONT> * <code>beginIndex</code> is larger than<a name="line.558"></a> |
| <FONT color="green">559</FONT> * <code>endIndex</code>.<a name="line.559"></a> |
| <FONT color="green">560</FONT> */<a name="line.560"></a> |
| <FONT color="green">561</FONT> public abstract XMLString substring(int beginIndex, int endIndex);<a name="line.561"></a> |
| <FONT color="green">562</FONT> <a name="line.562"></a> |
| <FONT color="green">563</FONT> /**<a name="line.563"></a> |
| <FONT color="green">564</FONT> * Concatenates the specified string to the end of this string.<a name="line.564"></a> |
| <FONT color="green">565</FONT> *<a name="line.565"></a> |
| <FONT color="green">566</FONT> * @param str the <code>String</code> that is concatenated to the end<a name="line.566"></a> |
| <FONT color="green">567</FONT> * of this <code>String</code>.<a name="line.567"></a> |
| <FONT color="green">568</FONT> * @return a string that represents the concatenation of this object's<a name="line.568"></a> |
| <FONT color="green">569</FONT> * characters followed by the string argument's characters.<a name="line.569"></a> |
| <FONT color="green">570</FONT> * @exception java.lang.NullPointerException if <code>str</code> is<a name="line.570"></a> |
| <FONT color="green">571</FONT> * <code>null</code>.<a name="line.571"></a> |
| <FONT color="green">572</FONT> */<a name="line.572"></a> |
| <FONT color="green">573</FONT> public abstract XMLString concat(String str);<a name="line.573"></a> |
| <FONT color="green">574</FONT> <a name="line.574"></a> |
| <FONT color="green">575</FONT> /**<a name="line.575"></a> |
| <FONT color="green">576</FONT> * Converts all of the characters in this <code>String</code> to lower<a name="line.576"></a> |
| <FONT color="green">577</FONT> * case using the rules of the given <code>Locale</code>.<a name="line.577"></a> |
| <FONT color="green">578</FONT> *<a name="line.578"></a> |
| <FONT color="green">579</FONT> * @param locale use the case transformation rules for this locale<a name="line.579"></a> |
| <FONT color="green">580</FONT> * @return the String, converted to lowercase.<a name="line.580"></a> |
| <FONT color="green">581</FONT> * @see java.lang.Character#toLowerCase(char)<a name="line.581"></a> |
| <FONT color="green">582</FONT> * @see java.lang.String#toUpperCase(Locale)<a name="line.582"></a> |
| <FONT color="green">583</FONT> */<a name="line.583"></a> |
| <FONT color="green">584</FONT> public abstract XMLString toLowerCase(Locale locale);<a name="line.584"></a> |
| <FONT color="green">585</FONT> <a name="line.585"></a> |
| <FONT color="green">586</FONT> /**<a name="line.586"></a> |
| <FONT color="green">587</FONT> * Converts all of the characters in this <code>String</code> to lower<a name="line.587"></a> |
| <FONT color="green">588</FONT> * case using the rules of the default locale, which is returned<a name="line.588"></a> |
| <FONT color="green">589</FONT> * by <code>Locale.getDefault</code>.<a name="line.589"></a> |
| <FONT color="green">590</FONT> * <p><a name="line.590"></a> |
| <FONT color="green">591</FONT> *<a name="line.591"></a> |
| <FONT color="green">592</FONT> * @return the string, converted to lowercase.<a name="line.592"></a> |
| <FONT color="green">593</FONT> * @see java.lang.Character#toLowerCase(char)<a name="line.593"></a> |
| <FONT color="green">594</FONT> * @see java.lang.String#toLowerCase(Locale)<a name="line.594"></a> |
| <FONT color="green">595</FONT> */<a name="line.595"></a> |
| <FONT color="green">596</FONT> public abstract XMLString toLowerCase();<a name="line.596"></a> |
| <FONT color="green">597</FONT> <a name="line.597"></a> |
| <FONT color="green">598</FONT> /**<a name="line.598"></a> |
| <FONT color="green">599</FONT> * Converts all of the characters in this <code>String</code> to upper<a name="line.599"></a> |
| <FONT color="green">600</FONT> * case using the rules of the given locale.<a name="line.600"></a> |
| <FONT color="green">601</FONT> * @param locale use the case transformation rules for this locale<a name="line.601"></a> |
| <FONT color="green">602</FONT> * @return the String, converted to uppercase.<a name="line.602"></a> |
| <FONT color="green">603</FONT> * @see java.lang.Character#toUpperCase(char)<a name="line.603"></a> |
| <FONT color="green">604</FONT> * @see java.lang.String#toLowerCase(Locale)<a name="line.604"></a> |
| <FONT color="green">605</FONT> */<a name="line.605"></a> |
| <FONT color="green">606</FONT> public abstract XMLString toUpperCase(Locale locale);<a name="line.606"></a> |
| <FONT color="green">607</FONT> <a name="line.607"></a> |
| <FONT color="green">608</FONT> /**<a name="line.608"></a> |
| <FONT color="green">609</FONT> * Converts all of the characters in this <code>String</code> to upper<a name="line.609"></a> |
| <FONT color="green">610</FONT> * case using the rules of the default locale, which is returned<a name="line.610"></a> |
| <FONT color="green">611</FONT> * by <code>Locale.getDefault</code>.<a name="line.611"></a> |
| <FONT color="green">612</FONT> *<a name="line.612"></a> |
| <FONT color="green">613</FONT> * <p><a name="line.613"></a> |
| <FONT color="green">614</FONT> * If no character in this string has a different uppercase version,<a name="line.614"></a> |
| <FONT color="green">615</FONT> * based on calling the <code>toUpperCase</code> method defined by<a name="line.615"></a> |
| <FONT color="green">616</FONT> * <code>Character</code>, then the original string is returned.<a name="line.616"></a> |
| <FONT color="green">617</FONT> * <p><a name="line.617"></a> |
| <FONT color="green">618</FONT> * Otherwise, this method creates a new <code>String</code> object<a name="line.618"></a> |
| <FONT color="green">619</FONT> * representing a character sequence identical in length to the<a name="line.619"></a> |
| <FONT color="green">620</FONT> * character sequence represented by this <code>String</code> object and<a name="line.620"></a> |
| <FONT color="green">621</FONT> * with every character equal to the result of applying the method<a name="line.621"></a> |
| <FONT color="green">622</FONT> * <code>Character.toUpperCase</code> to the corresponding character of<a name="line.622"></a> |
| <FONT color="green">623</FONT> * this <code>String</code> object. <p><a name="line.623"></a> |
| <FONT color="green">624</FONT> * Examples:<a name="line.624"></a> |
| <FONT color="green">625</FONT> * <blockquote><pre><a name="line.625"></a> |
| <FONT color="green">626</FONT> * "Fahrvergn&uuml;gen".toUpperCase() returns "FAHRVERGN&Uuml;GEN"<a name="line.626"></a> |
| <FONT color="green">627</FONT> * "Visit Ljubinje!".toUpperCase() returns "VISIT LJUBINJE!"<a name="line.627"></a> |
| <FONT color="green">628</FONT> * </pre></blockquote><a name="line.628"></a> |
| <FONT color="green">629</FONT> *<a name="line.629"></a> |
| <FONT color="green">630</FONT> * @return the string, converted to uppercase.<a name="line.630"></a> |
| <FONT color="green">631</FONT> * @see java.lang.Character#toUpperCase(char)<a name="line.631"></a> |
| <FONT color="green">632</FONT> * @see java.lang.String#toUpperCase(Locale)<a name="line.632"></a> |
| <FONT color="green">633</FONT> */<a name="line.633"></a> |
| <FONT color="green">634</FONT> public abstract XMLString toUpperCase();<a name="line.634"></a> |
| <FONT color="green">635</FONT> <a name="line.635"></a> |
| <FONT color="green">636</FONT> /**<a name="line.636"></a> |
| <FONT color="green">637</FONT> * Removes white space from both ends of this string.<a name="line.637"></a> |
| <FONT color="green">638</FONT> * <p><a name="line.638"></a> |
| <FONT color="green">639</FONT> * If this <code>String</code> object represents an empty character<a name="line.639"></a> |
| <FONT color="green">640</FONT> * sequence, or the first and last characters of character sequence<a name="line.640"></a> |
| <FONT color="green">641</FONT> * represented by this <code>String</code> object both have codes<a name="line.641"></a> |
| <FONT color="green">642</FONT> * greater than <code>'&#92;u0020'</code> (the space character), then a<a name="line.642"></a> |
| <FONT color="green">643</FONT> * reference to this <code>String</code> object is returned.<a name="line.643"></a> |
| <FONT color="green">644</FONT> * <p><a name="line.644"></a> |
| <FONT color="green">645</FONT> * Otherwise, if there is no character with a code greater than<a name="line.645"></a> |
| <FONT color="green">646</FONT> * <code>'&#92;u0020'</code> in the string, then a new<a name="line.646"></a> |
| <FONT color="green">647</FONT> * <code>String</code> object representing an empty string is created<a name="line.647"></a> |
| <FONT color="green">648</FONT> * and returned.<a name="line.648"></a> |
| <FONT color="green">649</FONT> * <p><a name="line.649"></a> |
| <FONT color="green">650</FONT> * Otherwise, let <i>k</i> be the index of the first character in the<a name="line.650"></a> |
| <FONT color="green">651</FONT> * string whose code is greater than <code>'&#92;u0020'</code>, and let<a name="line.651"></a> |
| <FONT color="green">652</FONT> * <i>m</i> be the index of the last character in the string whose code<a name="line.652"></a> |
| <FONT color="green">653</FONT> * is greater than <code>'&#92;u0020'</code>. A new <code>String</code><a name="line.653"></a> |
| <FONT color="green">654</FONT> * object is created, representing the substring of this string that<a name="line.654"></a> |
| <FONT color="green">655</FONT> * begins with the character at index <i>k</i> and ends with the<a name="line.655"></a> |
| <FONT color="green">656</FONT> * character at index <i>m</i>-that is, the result of<a name="line.656"></a> |
| <FONT color="green">657</FONT> * <code>this.substring(<i>k</i>,&nbsp;<i>m</i>+1)</code>.<a name="line.657"></a> |
| <FONT color="green">658</FONT> * <p><a name="line.658"></a> |
| <FONT color="green">659</FONT> * This method may be used to trim<a name="line.659"></a> |
| <FONT color="green">660</FONT> * {@link Character#isSpace(char) whitespace} from the beginning and end<a name="line.660"></a> |
| <FONT color="green">661</FONT> * of a string; in fact, it trims all ASCII control characters as well.<a name="line.661"></a> |
| <FONT color="green">662</FONT> *<a name="line.662"></a> |
| <FONT color="green">663</FONT> * @return this string, with white space removed from the front and end.<a name="line.663"></a> |
| <FONT color="green">664</FONT> */<a name="line.664"></a> |
| <FONT color="green">665</FONT> public abstract XMLString trim();<a name="line.665"></a> |
| <FONT color="green">666</FONT> <a name="line.666"></a> |
| <FONT color="green">667</FONT> /**<a name="line.667"></a> |
| <FONT color="green">668</FONT> * This object (which is already a string!) is itself returned.<a name="line.668"></a> |
| <FONT color="green">669</FONT> *<a name="line.669"></a> |
| <FONT color="green">670</FONT> * @return the string itself.<a name="line.670"></a> |
| <FONT color="green">671</FONT> */<a name="line.671"></a> |
| <FONT color="green">672</FONT> public abstract String toString();<a name="line.672"></a> |
| <FONT color="green">673</FONT> <a name="line.673"></a> |
| <FONT color="green">674</FONT> /**<a name="line.674"></a> |
| <FONT color="green">675</FONT> * Tell if this object contains a java String object.<a name="line.675"></a> |
| <FONT color="green">676</FONT> * <a name="line.676"></a> |
| <FONT color="green">677</FONT> * @return true if this XMLString can return a string without creating one.<a name="line.677"></a> |
| <FONT color="green">678</FONT> */<a name="line.678"></a> |
| <FONT color="green">679</FONT> public abstract boolean hasString();<a name="line.679"></a> |
| <FONT color="green">680</FONT> <a name="line.680"></a> |
| <FONT color="green">681</FONT> /**<a name="line.681"></a> |
| <FONT color="green">682</FONT> * Convert a string to a double -- Allowed input is in fixed<a name="line.682"></a> |
| <FONT color="green">683</FONT> * notation ddd.fff.<a name="line.683"></a> |
| <FONT color="green">684</FONT> *<a name="line.684"></a> |
| <FONT color="green">685</FONT> * @return A double value representation of the string, or return Double.NaN <a name="line.685"></a> |
| <FONT color="green">686</FONT> * if the string can not be converted.<a name="line.686"></a> |
| <FONT color="green">687</FONT> */<a name="line.687"></a> |
| <FONT color="green">688</FONT> public double toDouble();<a name="line.688"></a> |
| <FONT color="green">689</FONT> }<a name="line.689"></a> |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| </PRE> |
| </BODY> |
| </HTML> |
