1<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
2<!--NewPage-->
3<HTML>
4<HEAD>
5<!-- Generated by javadoc (build 1.6.0) on Sat Dec 29 16:44:58 EST 2007 -->
6<TITLE>
7AbstractRope
8</TITLE>
9
10<META NAME="date" CONTENT="2007-12-29">
11
12<LINK REL ="stylesheet" TYPE="text/css" HREF="/stylesheet.css" TITLE="Style">
13
14<SCRIPT type="text/javascript">
15function windowTitle()
16{
17    if (location.href.indexOf('is-external=true') == -1) {
18        parent.document.title="AbstractRope";
19    }
20}
21</SCRIPT>
22<NOSCRIPT>
23</NOSCRIPT>
24
25</HEAD>
26
27<BODY BGCOLOR="white" onload="windowTitle();">
28<HR>
29
30
31<!-- ========= START OF TOP NAVBAR ======= -->
32<A NAME="navbar_top"><!-- --></A>
33<A HREF="#skip-navbar_top" title="Skip navigation links"></A>
34<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
35<TR>
36<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
37<A NAME="navbar_top_firstrow"><!-- --></A>
38<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
39  <TR ALIGN="center" VALIGN="top">
40  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
41  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
42  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
43  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
44  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
45  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
46  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
47  </TR>
48</TABLE>
49</TD>
50<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
51</EM>
52</TD>
53</TR>
54
55<TR>
56<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57&nbsp;PREV CLASS&nbsp;
58&nbsp;<A HREF="/org/ahmadsoft/ropes/impl/ConcatenationRope.html" title="class in org.ahmadsoft.ropes.impl"><B>NEXT CLASS</B></A></FONT></TD>
59<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
60  <A HREF="/index.html?org/ahmadsoft/ropes/impl/AbstractRope.html" target="_top"><B>FRAMES</B></A>  &nbsp;
61&nbsp;<A HREF="AbstractRope.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
62&nbsp;<SCRIPT type="text/javascript">
63  <!--
64  if(window==top) {
65    document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>');
66  }
67  //-->
68</SCRIPT>
69<NOSCRIPT>
70  <A HREF="/allclasses-noframe.html"><B>All Classes</B></A>
71</NOSCRIPT>
72
73
74</FONT></TD>
75</TR>
76<TR>
77<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
78  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
79<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
80DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
81</TR>
82</TABLE>
83<A NAME="skip-navbar_top"></A>
84<!-- ========= END OF TOP NAVBAR ========= -->
85
86<HR>
87<!-- ======== START OF CLASS DATA ======== -->
88<H2>
89<FONT SIZE="-1">
90org.ahmadsoft.ropes.impl</FONT>
91<BR>
92Class AbstractRope</H2>
93<PRE>
94java.lang.Object
95  <IMG SRC="/resources/inherit.gif" ALT="extended by "><B>org.ahmadsoft.ropes.impl.AbstractRope</B>
96</PRE>
97<DL>
98<DT><B>All Implemented Interfaces:</B> <DD>java.io.Serializable, java.lang.CharSequence, java.lang.Comparable&lt;java.lang.CharSequence&gt;, java.lang.Iterable&lt;java.lang.Character&gt;, <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></DD>
99</DL>
100<DL>
101<DT><B>Direct Known Subclasses:</B> <DD><A HREF="/org/ahmadsoft/ropes/impl/ConcatenationRope.html" title="class in org.ahmadsoft.ropes.impl">ConcatenationRope</A>, <A HREF="/org/ahmadsoft/ropes/impl/FlatCharArrayRope.html" title="class in org.ahmadsoft.ropes.impl">FlatCharArrayRope</A>, <A HREF="/org/ahmadsoft/ropes/impl/FlatCharSequenceRope.html" title="class in org.ahmadsoft.ropes.impl">FlatCharSequenceRope</A>, <A HREF="/org/ahmadsoft/ropes/impl/ReverseRope.html" title="class in org.ahmadsoft.ropes.impl">ReverseRope</A>, <A HREF="/org/ahmadsoft/ropes/impl/SubstringRope.html" title="class in org.ahmadsoft.ropes.impl">SubstringRope</A></DD>
102</DL>
103<HR>
104<DL>
105<DT><PRE>public abstract class <B>AbstractRope</B><DT>extends java.lang.Object<DT>implements <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></DL>
106</PRE>
107
108<P>
109Abstract base class for ropes that implements many of the common operations.
110<P>
111
112<P>
113<DL>
114<DT><B>Author:</B></DT>
115  <DD>Amin Ahmad</DD>
116<DT><B>See Also:</B><DD><A HREF="/serialized-form.html#org.ahmadsoft.ropes.impl.AbstractRope">Serialized Form</A></DL>
117<HR>
118
119<P>
120<!-- =========== FIELD SUMMARY =========== -->
121
122<A NAME="field_summary"><!-- --></A>
123<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
124<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
125<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
126<B>Field Summary</B></FONT></TH>
127</TR>
128</TABLE>
129&nbsp;<A NAME="fields_inherited_from_class_org.ahmadsoft.ropes.Rope"><!-- --></A>
130<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
131<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
132<TH ALIGN="left"><B>Fields inherited from interface org.ahmadsoft.ropes.<A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></B></TH>
133</TR>
134<TR BGCOLOR="white" CLASS="TableRowColor">
135<TD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#BUILDER">BUILDER</A></CODE></TD>
136</TR>
137</TABLE>
138&nbsp;
139<!-- ======== CONSTRUCTOR SUMMARY ======== -->
140
141<A NAME="constructor_summary"><!-- --></A>
142<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
143<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
144<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
145<B>Constructor Summary</B></FONT></TH>
146</TR>
147<TR BGCOLOR="white" CLASS="TableRowColor">
148<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#AbstractRope()">AbstractRope</A></B>()</CODE>
149
150<BR>
151&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
152</TR>
153</TABLE>
154&nbsp;
155<!-- ========== METHOD SUMMARY =========== -->
156
157<A NAME="method_summary"><!-- --></A>
158<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
159<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
160<TH ALIGN="left" COLSPAN="2"><FONT SIZE="+2">
161<B>Method Summary</B></FONT></TH>
162</TR>
163<TR BGCOLOR="white" CLASS="TableRowColor">
164<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
165<CODE>&nbsp;<A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></FONT></TD>
166<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#append(char)">append</A></B>(char&nbsp;c)</CODE>
167
168<BR>
169&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a new rope created by appending the specified character to
170 this rope.</TD>
171</TR>
172<TR BGCOLOR="white" CLASS="TableRowColor">
173<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
174<CODE>&nbsp;<A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></FONT></TD>
175<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#append(java.lang.CharSequence)">append</A></B>(java.lang.CharSequence&nbsp;suffix)</CODE>
176
177<BR>
178&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a new rope created by appending the specified character sequence to
179 this rope.</TD>
180</TR>
181<TR BGCOLOR="white" CLASS="TableRowColor">
182<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
183<CODE>&nbsp;<A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></FONT></TD>
184<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#append(java.lang.CharSequence, int, int)">append</A></B>(java.lang.CharSequence&nbsp;csq,
185       int&nbsp;start,
186       int&nbsp;end)</CODE>
187
188<BR>
189&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a new rope created by appending the specified character range to
190 this rope.</TD>
191</TR>
192<TR BGCOLOR="white" CLASS="TableRowColor">
193<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
194<CODE>&nbsp;int</CODE></FONT></TD>
195<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#compareTo(java.lang.CharSequence)">compareTo</A></B>(java.lang.CharSequence&nbsp;sequence)</CODE>
196
197<BR>
198&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
199</TR>
200<TR BGCOLOR="white" CLASS="TableRowColor">
201<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
202<CODE>&nbsp;<A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></FONT></TD>
203<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#delete(int, int)">delete</A></B>(int&nbsp;start,
204       int&nbsp;end)</CODE>
205
206<BR>
207&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creats a new rope by delete the specified character substring.</TD>
208</TR>
209<TR BGCOLOR="white" CLASS="TableRowColor">
210<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
211<CODE>abstract &nbsp;byte</CODE></FONT></TD>
212<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#depth()">depth</A></B>()</CODE>
213
214<BR>
215&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
216</TR>
217<TR BGCOLOR="white" CLASS="TableRowColor">
218<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
219<CODE>&nbsp;boolean</CODE></FONT></TD>
220<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object&nbsp;other)</CODE>
221
222<BR>
223&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
224</TR>
225<TR BGCOLOR="white" CLASS="TableRowColor">
226<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
227<CODE>&nbsp;int</CODE></FONT></TD>
228<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#hashCode()">hashCode</A></B>()</CODE>
229
230<BR>
231&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
232</TR>
233<TR BGCOLOR="white" CLASS="TableRowColor">
234<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
235<CODE>&nbsp;int</CODE></FONT></TD>
236<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#indexOf(char)">indexOf</A></B>(char&nbsp;ch)</CODE>
237
238<BR>
239&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the index within this rope of the first occurrence of the
240 specified character.</TD>
241</TR>
242<TR BGCOLOR="white" CLASS="TableRowColor">
243<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
244<CODE>&nbsp;int</CODE></FONT></TD>
245<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#indexOf(char, int)">indexOf</A></B>(char&nbsp;ch,
246        int&nbsp;fromIndex)</CODE>
247
248<BR>
249&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the index within this rope of the first occurrence of the
250 specified character, beginning at the specified index.</TD>
251</TR>
252<TR BGCOLOR="white" CLASS="TableRowColor">
253<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
254<CODE>&nbsp;int</CODE></FONT></TD>
255<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#indexOf(java.lang.CharSequence)">indexOf</A></B>(java.lang.CharSequence&nbsp;sequence)</CODE>
256
257<BR>
258&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the index within this rope of the first occurrence of the
259 specified string.</TD>
260</TR>
261<TR BGCOLOR="white" CLASS="TableRowColor">
262<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
263<CODE>&nbsp;int</CODE></FONT></TD>
264<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#indexOf(java.lang.CharSequence, int)">indexOf</A></B>(java.lang.CharSequence&nbsp;sequence,
265        int&nbsp;fromIndex)</CODE>
266
267<BR>
268&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the index within this rope of the first occurrence of the
269 specified string, beginning at the specified index.</TD>
270</TR>
271<TR BGCOLOR="white" CLASS="TableRowColor">
272<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
273<CODE>&nbsp;<A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></FONT></TD>
274<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#insert(int, java.lang.CharSequence)">insert</A></B>(int&nbsp;dstOffset,
275       java.lang.CharSequence&nbsp;s)</CODE>
276
277<BR>
278&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new rope by inserting the specified <code>CharSequence</code>
279 into this rope.</TD>
280</TR>
281<TR BGCOLOR="white" CLASS="TableRowColor">
282<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
283<CODE>&nbsp;java.util.Iterator&lt;java.lang.Character&gt;</CODE></FONT></TD>
284<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#iterator()">iterator</A></B>()</CODE>
285
286<BR>
287&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
288</TR>
289<TR BGCOLOR="white" CLASS="TableRowColor">
290<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
291<CODE>&nbsp;<A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></FONT></TD>
292<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#ltrim()">ltrim</A></B>()</CODE>
293
294<BR>
295&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Trims all whitespace as well as characters less than 0x20 from
296 the beginning of this string.</TD>
297</TR>
298<TR BGCOLOR="white" CLASS="TableRowColor">
299<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
300<CODE>&nbsp;java.util.regex.Matcher</CODE></FONT></TD>
301<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#matcher(java.util.regex.Pattern)">matcher</A></B>(java.util.regex.Pattern&nbsp;pattern)</CODE>
302
303<BR>
304&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a matcher that will match this rope against the
305 specified pattern.</TD>
306</TR>
307<TR BGCOLOR="white" CLASS="TableRowColor">
308<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
309<CODE>&nbsp;boolean</CODE></FONT></TD>
310<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#matches(java.util.regex.Pattern)">matches</A></B>(java.util.regex.Pattern&nbsp;regex)</CODE>
311
312<BR>
313&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if this rope matches the specified
314 <code>Pattern</code>, or <code>false</code> otherwise.</TD>
315</TR>
316<TR BGCOLOR="white" CLASS="TableRowColor">
317<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
318<CODE>&nbsp;boolean</CODE></FONT></TD>
319<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#matches(java.lang.String)">matches</A></B>(java.lang.String&nbsp;regex)</CODE>
320
321<BR>
322&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if this rope matches the specified
323 regular expression, or <code>false</code> otherwise.</TD>
324</TR>
325<TR BGCOLOR="white" CLASS="TableRowColor">
326<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
327<CODE>&nbsp;<A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></FONT></TD>
328<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#rebalance()">rebalance</A></B>()</CODE>
329
330<BR>
331&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Rebalances the current rope, returning the rebalanced rope.</TD>
332</TR>
333<TR BGCOLOR="white" CLASS="TableRowColor">
334<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
335<CODE>&nbsp;java.util.Iterator&lt;java.lang.Character&gt;</CODE></FONT></TD>
336<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#reverseIterator()">reverseIterator</A></B>()</CODE>
337
338<BR>
339&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a reverse iterator positioned to start at the end of this
340 rope.</TD>
341</TR>
342<TR BGCOLOR="white" CLASS="TableRowColor">
343<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
344<CODE>&nbsp;<A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></FONT></TD>
345<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#rtrim()">rtrim</A></B>()</CODE>
346
347<BR>
348&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Trims all whitespace as well as characters less than <code>0x20</code> from
349 the end of this string.</TD>
350</TR>
351<TR BGCOLOR="white" CLASS="TableRowColor">
352<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
353<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
354<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#toString()">toString</A></B>()</CODE>
355
356<BR>
357&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
358</TR>
359<TR BGCOLOR="white" CLASS="TableRowColor">
360<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
361<CODE>&nbsp;<A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></FONT></TD>
362<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#trim()">trim</A></B>()</CODE>
363
364<BR>
365&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Trims all whitespace as well as characters less than <code>0x20</code> from
366 the beginnning and end of this string.</TD>
367</TR>
368<TR BGCOLOR="white" CLASS="TableRowColor">
369<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
370<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
371<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#writeReplace()">writeReplace</A></B>()</CODE>
372
373<BR>
374&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
375</TR>
376</TABLE>
377&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
378<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
379<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
380<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
381</TR>
382<TR BGCOLOR="white" CLASS="TableRowColor">
383<TD><CODE>getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
384</TR>
385</TABLE>
386&nbsp;<A NAME="methods_inherited_from_class_org.ahmadsoft.ropes.Rope"><!-- --></A>
387<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
388<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
389<TH ALIGN="left"><B>Methods inherited from interface org.ahmadsoft.ropes.<A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></B></TH>
390</TR>
391<TR BGCOLOR="white" CLASS="TableRowColor">
392<TD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#iterator(int)">iterator</A>, <A HREF="/org/ahmadsoft/ropes/Rope.html#reverse()">reverse</A>, <A HREF="/org/ahmadsoft/ropes/Rope.html#reverseIterator(int)">reverseIterator</A>, <A HREF="/org/ahmadsoft/ropes/Rope.html#subSequence(int, int)">subSequence</A>, <A HREF="/org/ahmadsoft/ropes/Rope.html#write(java.io.Writer)">write</A>, <A HREF="/org/ahmadsoft/ropes/Rope.html#write(java.io.Writer, int, int)">write</A></CODE></TD>
393</TR>
394</TABLE>
395&nbsp;<A NAME="methods_inherited_from_class_java.lang.CharSequence"><!-- --></A>
396<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
397<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
398<TH ALIGN="left"><B>Methods inherited from interface java.lang.CharSequence</B></TH>
399</TR>
400<TR BGCOLOR="white" CLASS="TableRowColor">
401<TD><CODE>charAt, length</CODE></TD>
402</TR>
403</TABLE>
404&nbsp;
405<P>
406
407<!-- ========= CONSTRUCTOR DETAIL ======== -->
408
409<A NAME="constructor_detail"><!-- --></A>
410<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
411<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
412<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
413<B>Constructor Detail</B></FONT></TH>
414</TR>
415</TABLE>
416
417<A NAME="AbstractRope()"><!-- --></A><H3>
418AbstractRope</H3>
419<PRE>
420public <B>AbstractRope</B>()</PRE>
421<DL>
422</DL>
423
424<!-- ============ METHOD DETAIL ========== -->
425
426<A NAME="method_detail"><!-- --></A>
427<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
428<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
429<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
430<B>Method Detail</B></FONT></TH>
431</TR>
432</TABLE>
433
434<A NAME="append(char)"><!-- --></A><H3>
435append</H3>
436<PRE>
437public <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A> <B>append</B>(char&nbsp;c)</PRE>
438<DL>
439<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#append(char)">Rope</A></CODE></B></DD>
440<DD>Returns a new rope created by appending the specified character to
441 this rope.
442<P>
443<DD><DL>
444<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#append(char)">append</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
445</DD>
446<DD><DL>
447<DT><B>Parameters:</B><DD><CODE>c</CODE> - the specified character.
448<DT><B>Returns:</B><DD>a new rope.</DL>
449</DD>
450</DL>
451<HR>
452
453<A NAME="append(java.lang.CharSequence)"><!-- --></A><H3>
454append</H3>
455<PRE>
456public <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A> <B>append</B>(java.lang.CharSequence&nbsp;suffix)</PRE>
457<DL>
458<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#append(java.lang.CharSequence)">Rope</A></CODE></B></DD>
459<DD>Returns a new rope created by appending the specified character sequence to
460 this rope.
461<P>
462<DD><DL>
463<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#append(java.lang.CharSequence)">append</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
464</DD>
465<DD><DL>
466<DT><B>Parameters:</B><DD><CODE>suffix</CODE> - the specified suffix.
467<DT><B>Returns:</B><DD>a new rope.</DL>
468</DD>
469</DL>
470<HR>
471
472<A NAME="append(java.lang.CharSequence, int, int)"><!-- --></A><H3>
473append</H3>
474<PRE>
475public <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A> <B>append</B>(java.lang.CharSequence&nbsp;csq,
476                   int&nbsp;start,
477                   int&nbsp;end)</PRE>
478<DL>
479<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#append(java.lang.CharSequence, int, int)">Rope</A></CODE></B></DD>
480<DD>Returns a new rope created by appending the specified character range to
481 this rope.
482<P>
483<DD><DL>
484<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#append(java.lang.CharSequence, int, int)">append</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
485</DD>
486<DD><DL>
487<DT><B>Parameters:</B><DD><CODE>csq</CODE> - the specified character.<DD><CODE>start</CODE> - the start index, inclusive.<DD><CODE>end</CODE> - the end index, non-inclusive.
488<DT><B>Returns:</B><DD>a new rope.</DL>
489</DD>
490</DL>
491<HR>
492
493<A NAME="compareTo(java.lang.CharSequence)"><!-- --></A><H3>
494compareTo</H3>
495<PRE>
496public int <B>compareTo</B>(java.lang.CharSequence&nbsp;sequence)</PRE>
497<DL>
498<DD><DL>
499<DT><B>Specified by:</B><DD><CODE>compareTo</CODE> in interface <CODE>java.lang.Comparable&lt;java.lang.CharSequence&gt;</CODE></DL>
500</DD>
501<DD><DL>
502</DL>
503</DD>
504</DL>
505<HR>
506
507<A NAME="delete(int, int)"><!-- --></A><H3>
508delete</H3>
509<PRE>
510public <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A> <B>delete</B>(int&nbsp;start,
511                   int&nbsp;end)</PRE>
512<DL>
513<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#delete(int, int)">Rope</A></CODE></B></DD>
514<DD>Creats a new rope by delete the specified character substring.
515 The substring begins at the specified <code>start</code> and extends to
516 the character at index <code>end - 1</code> or to the end of the
517 sequence if no such character exists. If
518 <code>start</code> is equal to <code>end</code>, no changes are made.
519<P>
520<DD><DL>
521<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#delete(int, int)">delete</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
522</DD>
523<DD><DL>
524<DT><B>Parameters:</B><DD><CODE>start</CODE> - The beginning index, inclusive.<DD><CODE>end</CODE> - The ending index, exclusive.
525<DT><B>Returns:</B><DD>This object.</DL>
526</DD>
527</DL>
528<HR>
529
530<A NAME="depth()"><!-- --></A><H3>
531depth</H3>
532<PRE>
533public abstract byte <B>depth</B>()</PRE>
534<DL>
535<DD><DL>
536</DL>
537</DD>
538<DD><DL>
539</DL>
540</DD>
541</DL>
542<HR>
543
544<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
545equals</H3>
546<PRE>
547public boolean <B>equals</B>(java.lang.Object&nbsp;other)</PRE>
548<DL>
549<DD><DL>
550<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>
551</DD>
552<DD><DL>
553</DL>
554</DD>
555</DL>
556<HR>
557
558<A NAME="hashCode()"><!-- --></A><H3>
559hashCode</H3>
560<PRE>
561public int <B>hashCode</B>()</PRE>
562<DL>
563<DD><DL>
564<DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL>
565</DD>
566<DD><DL>
567</DL>
568</DD>
569</DL>
570<HR>
571
572<A NAME="indexOf(char)"><!-- --></A><H3>
573indexOf</H3>
574<PRE>
575public int <B>indexOf</B>(char&nbsp;ch)</PRE>
576<DL>
577<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#indexOf(char)">Rope</A></CODE></B></DD>
578<DD>Returns the index within this rope of the first occurrence of the
579 specified character. If a character with value <code>ch</code> occurs
580 in the character sequence represented by this <code>Rope</code>
581 object, then the index of the first such occurrence is returned --
582 that is, the smallest value k such that:
583 <p>
584 <code>this.charAt(k) == ch</code>
585 <p>
586 is <code>true</code>. If no such character occurs in this string, then
587 <code>-1</code> is returned.
588<P>
589<DD><DL>
590<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#indexOf(char)">indexOf</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
591</DD>
592<DD><DL>
593<DT><B>Parameters:</B><DD><CODE>ch</CODE> - a character.
594<DT><B>Returns:</B><DD>the index of the first occurrence of the character in the character
595 sequence represented by this object, or <code>-1</code> if the character
596 does not occur.</DL>
597</DD>
598</DL>
599<HR>
600
601<A NAME="indexOf(char, int)"><!-- --></A><H3>
602indexOf</H3>
603<PRE>
604public int <B>indexOf</B>(char&nbsp;ch,
605                   int&nbsp;fromIndex)</PRE>
606<DL>
607<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#indexOf(char, int)">Rope</A></CODE></B></DD>
608<DD>Returns the index within this rope of the first occurrence of the
609 specified character, beginning at the specified index. If a character
610 with value <code>ch</code> occurs in the character sequence
611 represented by this <code>Rope</code> object, then the index of the
612 first such occurrence is returned&#8212;that is, the smallest value k
613 such that:
614 <p>
615 <code>this.charAt(k) == ch</code>
616 <p>
617 is <code>true</code>. If no such character occurs in this string, then
618 <code>-1</code> is returned.
619<P>
620<DD><DL>
621<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#indexOf(char, int)">indexOf</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
622</DD>
623<DD><DL>
624<DT><B>Parameters:</B><DD><CODE>ch</CODE> - a character.<DD><CODE>fromIndex</CODE> - the index to start searching from.
625<DT><B>Returns:</B><DD>the index of the first occurrence of the character in the character
626 sequence represented by this object, or -1 if the character does not occur.</DL>
627</DD>
628</DL>
629<HR>
630
631<A NAME="indexOf(java.lang.CharSequence)"><!-- --></A><H3>
632indexOf</H3>
633<PRE>
634public int <B>indexOf</B>(java.lang.CharSequence&nbsp;sequence)</PRE>
635<DL>
636<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#indexOf(java.lang.CharSequence)">Rope</A></CODE></B></DD>
637<DD>Returns the index within this rope of the first occurrence of the
638 specified string. The value returned is the smallest <i>k</i> such
639 that:
640 <pre>
641     this.startsWith(str, k)
642 </pre>
643 If no such <i>k</i> exists, then -1 is returned.
644<P>
645<DD><DL>
646<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#indexOf(java.lang.CharSequence)">indexOf</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
647</DD>
648<DD><DL>
649<DT><B>Parameters:</B><DD><CODE>sequence</CODE> - the string to find.
650<DT><B>Returns:</B><DD>the index of the first occurrence of the specified string, or
651 -1 if the specified string does not occur.</DL>
652</DD>
653</DL>
654<HR>
655
656<A NAME="indexOf(java.lang.CharSequence, int)"><!-- --></A><H3>
657indexOf</H3>
658<PRE>
659public int <B>indexOf</B>(java.lang.CharSequence&nbsp;sequence,
660                   int&nbsp;fromIndex)</PRE>
661<DL>
662<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#indexOf(java.lang.CharSequence, int)">Rope</A></CODE></B></DD>
663<DD>Returns the index within this rope of the first occurrence of the
664 specified string, beginning at the specified index. The value returned
665 is the smallest <i>k</i> such that:
666 <pre>
667     k >= fromIndex && this.startsWith(str, k)
668 </pre>
669 If no such <i>k</i> exists, then -1 is returned.
670<P>
671<DD><DL>
672<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#indexOf(java.lang.CharSequence, int)">indexOf</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
673</DD>
674<DD><DL>
675<DT><B>Parameters:</B><DD><CODE>sequence</CODE> - the string to find.<DD><CODE>fromIndex</CODE> - the index to start searching from.
676<DT><B>Returns:</B><DD>the index of the first occurrence of the specified string, or
677 -1 if the specified string does not occur.</DL>
678</DD>
679</DL>
680<HR>
681
682<A NAME="insert(int, java.lang.CharSequence)"><!-- --></A><H3>
683insert</H3>
684<PRE>
685public <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A> <B>insert</B>(int&nbsp;dstOffset,
686                   java.lang.CharSequence&nbsp;s)</PRE>
687<DL>
688<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#insert(int, java.lang.CharSequence)">Rope</A></CODE></B></DD>
689<DD>Creates a new rope by inserting the specified <code>CharSequence</code>
690 into this rope.
691 <p>
692 The characters of the <code>CharSequence</code> argument are inserted,
693 in order, into this rope at the indicated offset.
694
695 <p>If <code>s</code> is <code>null</code>, then the four characters
696 <code>"null"</code> are inserted into this sequence.
697<P>
698<DD><DL>
699<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#insert(int, java.lang.CharSequence)">insert</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
700</DD>
701<DD><DL>
702<DT><B>Parameters:</B><DD><CODE>dstOffset</CODE> - the offset.<DD><CODE>s</CODE> - the sequence to be inserted
703<DT><B>Returns:</B><DD>a reference to the new Rope.</DL>
704</DD>
705</DL>
706<HR>
707
708<A NAME="iterator()"><!-- --></A><H3>
709iterator</H3>
710<PRE>
711public java.util.Iterator&lt;java.lang.Character&gt; <B>iterator</B>()</PRE>
712<DL>
713<DD><DL>
714<DT><B>Specified by:</B><DD><CODE>iterator</CODE> in interface <CODE>java.lang.Iterable&lt;java.lang.Character&gt;</CODE></DL>
715</DD>
716<DD><DL>
717</DL>
718</DD>
719</DL>
720<HR>
721
722<A NAME="ltrim()"><!-- --></A><H3>
723ltrim</H3>
724<PRE>
725public <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A> <B>ltrim</B>()</PRE>
726<DL>
727<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#ltrim()">Rope</A></CODE></B></DD>
728<DD>Trims all whitespace as well as characters less than 0x20 from
729 the beginning of this string.
730<P>
731<DD><DL>
732<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#ltrim()">ltrim</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
733</DD>
734<DD><DL>
735
736<DT><B>Returns:</B><DD>a rope with all leading whitespace trimmed.</DL>
737</DD>
738</DL>
739<HR>
740
741<A NAME="matcher(java.util.regex.Pattern)"><!-- --></A><H3>
742matcher</H3>
743<PRE>
744public java.util.regex.Matcher <B>matcher</B>(java.util.regex.Pattern&nbsp;pattern)</PRE>
745<DL>
746<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#matcher(java.util.regex.Pattern)">Rope</A></CODE></B></DD>
747<DD>Creates a matcher that will match this rope against the
748 specified pattern. This method produces a higher performance
749 matcher than:
750 <pre>
751 Matcher m = pattern.matcher(this);
752 </pre>
753 The difference may be asymptotically better in many cases.
754<P>
755<DD><DL>
756<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#matcher(java.util.regex.Pattern)">matcher</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
757</DD>
758<DD><DL>
759<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - the pattern to match this rope against.
760<DT><B>Returns:</B><DD>a matcher.</DL>
761</DD>
762</DL>
763<HR>
764
765<A NAME="matches(java.util.regex.Pattern)"><!-- --></A><H3>
766matches</H3>
767<PRE>
768public boolean <B>matches</B>(java.util.regex.Pattern&nbsp;regex)</PRE>
769<DL>
770<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#matches(java.util.regex.Pattern)">Rope</A></CODE></B></DD>
771<DD>Returns <code>true</code> if this rope matches the specified
772 <code>Pattern</code>, or <code>false</code> otherwise.
773<P>
774<DD><DL>
775<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#matches(java.util.regex.Pattern)">matches</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
776</DD>
777<DD><DL>
778<DT><B>Parameters:</B><DD><CODE>regex</CODE> - the specified regular expression.
779<DT><B>Returns:</B><DD><code>true</code> if this rope matches the specified
780 <code>Pattern</code>, or <code>false</code> otherwise.<DT><B>See Also:</B><DD><CODE>Pattern</CODE></DL>
781</DD>
782</DL>
783<HR>
784
785<A NAME="matches(java.lang.String)"><!-- --></A><H3>
786matches</H3>
787<PRE>
788public boolean <B>matches</B>(java.lang.String&nbsp;regex)</PRE>
789<DL>
790<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#matches(java.lang.String)">Rope</A></CODE></B></DD>
791<DD>Returns <code>true</code> if this rope matches the specified
792 regular expression, or <code>false</code> otherwise.
793<P>
794<DD><DL>
795<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#matches(java.lang.String)">matches</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
796</DD>
797<DD><DL>
798<DT><B>Parameters:</B><DD><CODE>regex</CODE> - the specified regular expression.
799<DT><B>Returns:</B><DD><code>true</code> if this rope matches the specified
800 regular expression, or <code>false</code> otherwise.<DT><B>See Also:</B><DD><CODE>Pattern</CODE></DL>
801</DD>
802</DL>
803<HR>
804
805<A NAME="rebalance()"><!-- --></A><H3>
806rebalance</H3>
807<PRE>
808public <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A> <B>rebalance</B>()</PRE>
809<DL>
810<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#rebalance()">Rope</A></CODE></B></DD>
811<DD>Rebalances the current rope, returning the rebalanced rope. In general,
812 rope rebalancing is handled automatically, but this method is provided
813 to give users more control.
814<P>
815<DD><DL>
816<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#rebalance()">rebalance</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
817</DD>
818<DD><DL>
819
820<DT><B>Returns:</B><DD>a rebalanced rope.</DL>
821</DD>
822</DL>
823<HR>
824
825<A NAME="reverseIterator()"><!-- --></A><H3>
826reverseIterator</H3>
827<PRE>
828public java.util.Iterator&lt;java.lang.Character&gt; <B>reverseIterator</B>()</PRE>
829<DL>
830<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#reverseIterator()">Rope</A></CODE></B></DD>
831<DD>Returns a reverse iterator positioned to start at the end of this
832 rope. A reverse iterator moves backwards instead of forwards through
833 a rope.
834<P>
835<DD><DL>
836<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#reverseIterator()">reverseIterator</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
837</DD>
838<DD><DL>
839
840<DT><B>Returns:</B><DD>A reverse iterator positioned at the end of this rope.<DT><B>See Also:</B><DD><A HREF="/org/ahmadsoft/ropes/Rope.html#reverseIterator(int)"><CODE>Rope.reverseIterator(int)</CODE></A></DL>
841</DD>
842</DL>
843<HR>
844
845<A NAME="rtrim()"><!-- --></A><H3>
846rtrim</H3>
847<PRE>
848public <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A> <B>rtrim</B>()</PRE>
849<DL>
850<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#rtrim()">Rope</A></CODE></B></DD>
851<DD>Trims all whitespace as well as characters less than <code>0x20</code> from
852 the end of this string.
853<P>
854<DD><DL>
855<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#rtrim()">rtrim</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
856</DD>
857<DD><DL>
858
859<DT><B>Returns:</B><DD>a rope with all trailing whitespace trimmed.</DL>
860</DD>
861</DL>
862<HR>
863
864<A NAME="toString()"><!-- --></A><H3>
865toString</H3>
866<PRE>
867public java.lang.String <B>toString</B>()</PRE>
868<DL>
869<DD><DL>
870<DT><B>Specified by:</B><DD><CODE>toString</CODE> in interface <CODE>java.lang.CharSequence</CODE><DT><B>Overrides:</B><DD><CODE>toString</CODE> in class <CODE>java.lang.Object</CODE></DL>
871</DD>
872<DD><DL>
873</DL>
874</DD>
875</DL>
876<HR>
877
878<A NAME="trim()"><!-- --></A><H3>
879trim</H3>
880<PRE>
881public <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A> <B>trim</B>()</PRE>
882<DL>
883<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#trim()">Rope</A></CODE></B></DD>
884<DD>Trims all whitespace as well as characters less than <code>0x20</code> from
885 the beginnning and end of this string.
886<P>
887<DD><DL>
888<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#trim()">trim</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
889</DD>
890<DD><DL>
891
892<DT><B>Returns:</B><DD>a rope with all leading and trailing whitespace trimmed.</DL>
893</DD>
894</DL>
895<HR>
896
897<A NAME="writeReplace()"><!-- --></A><H3>
898writeReplace</H3>
899<PRE>
900public java.lang.Object <B>writeReplace</B>()
901                              throws java.io.ObjectStreamException</PRE>
902<DL>
903<DD><DL>
904</DL>
905</DD>
906<DD><DL>
907
908<DT><B>Throws:</B>
909<DD><CODE>java.io.ObjectStreamException</CODE></DL>
910</DD>
911</DL>
912<!-- ========= END OF CLASS DATA ========= -->
913<HR>
914
915
916<!-- ======= START OF BOTTOM NAVBAR ====== -->
917<A NAME="navbar_bottom"><!-- --></A>
918<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
919<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
920<TR>
921<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
922<A NAME="navbar_bottom_firstrow"><!-- --></A>
923<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
924  <TR ALIGN="center" VALIGN="top">
925  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
926  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
927  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
928  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
929  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
930  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
931  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
932  </TR>
933</TABLE>
934</TD>
935<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
936</EM>
937</TD>
938</TR>
939
940<TR>
941<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
942&nbsp;PREV CLASS&nbsp;
943&nbsp;<A HREF="/org/ahmadsoft/ropes/impl/ConcatenationRope.html" title="class in org.ahmadsoft.ropes.impl"><B>NEXT CLASS</B></A></FONT></TD>
944<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
945  <A HREF="/index.html?org/ahmadsoft/ropes/impl/AbstractRope.html" target="_top"><B>FRAMES</B></A>  &nbsp;
946&nbsp;<A HREF="AbstractRope.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
947&nbsp;<SCRIPT type="text/javascript">
948  <!--
949  if(window==top) {
950    document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>');
951  }
952  //-->
953</SCRIPT>
954<NOSCRIPT>
955  <A HREF="/allclasses-noframe.html"><B>All Classes</B></A>
956</NOSCRIPT>
957
958
959</FONT></TD>
960</TR>
961<TR>
962<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
963  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
964<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
965DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
966</TR>
967</TABLE>
968<A NAME="skip-navbar_bottom"></A>
969<!-- ======== END OF BOTTOM NAVBAR ======= -->
970
971<HR>
972<i>Copyright &#169; 2007 Amin Ahmad. All Rights Reserved.</i>
973</BODY>
974</HTML>
975