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_03) on Tue Jan 20 08:29:53 EST 2009 -->
6<TITLE>
7AbstractRope
8</TITLE>
9
10<META NAME="date" CONTENT="2009-01-20">
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#endsWith(java.lang.CharSequence)">endsWith</A></B>(java.lang.CharSequence&nbsp;suffix)</CODE>
221
222<BR>
223&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if this rope ends with the specified 
224 suffix.</TD>
225</TR>
226<TR BGCOLOR="white" CLASS="TableRowColor">
227<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
228<CODE>&nbsp;boolean</CODE></FONT></TD>
229<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#endsWith(java.lang.CharSequence, int)">endsWith</A></B>(java.lang.CharSequence&nbsp;suffix,
230         int&nbsp;offset)</CODE>
231
232<BR>
233&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if this rope, terminated at a specified
234 offset, ends with the specified suffix.</TD>
235</TR>
236<TR BGCOLOR="white" CLASS="TableRowColor">
237<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
238<CODE>&nbsp;boolean</CODE></FONT></TD>
239<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object&nbsp;other)</CODE>
240
241<BR>
242&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
243</TR>
244<TR BGCOLOR="white" CLASS="TableRowColor">
245<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
246<CODE>&nbsp;int</CODE></FONT></TD>
247<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#hashCode()">hashCode</A></B>()</CODE>
248
249<BR>
250&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</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(char)">indexOf</A></B>(char&nbsp;ch)</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 character.</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(char, int)">indexOf</A></B>(char&nbsp;ch,
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 character, 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;int</CODE></FONT></TD>
274<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#indexOf(java.lang.CharSequence)">indexOf</A></B>(java.lang.CharSequence&nbsp;sequence)</CODE>
275
276<BR>
277&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the index within this rope of the first occurrence of the
278 specified string.</TD>
279</TR>
280<TR BGCOLOR="white" CLASS="TableRowColor">
281<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
282<CODE>&nbsp;int</CODE></FONT></TD>
283<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#indexOf(java.lang.CharSequence, int)">indexOf</A></B>(java.lang.CharSequence&nbsp;sequence,
284        int&nbsp;fromIndex)</CODE>
285
286<BR>
287&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns the index within this rope of the first occurrence of the
288 specified string, beginning at the specified index.</TD>
289</TR>
290<TR BGCOLOR="white" CLASS="TableRowColor">
291<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
292<CODE>&nbsp;<A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></FONT></TD>
293<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#insert(int, java.lang.CharSequence)">insert</A></B>(int&nbsp;dstOffset,
294       java.lang.CharSequence&nbsp;s)</CODE>
295
296<BR>
297&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a new rope by inserting the specified <code>CharSequence</code>
298 into this rope.</TD>
299</TR>
300<TR BGCOLOR="white" CLASS="TableRowColor">
301<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
302<CODE>&nbsp;boolean</CODE></FONT></TD>
303<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#isEmpty()">isEmpty</A></B>()</CODE>
304
305<BR>
306&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns true if and only if the length of this rope is zero.</TD>
307</TR>
308<TR BGCOLOR="white" CLASS="TableRowColor">
309<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
310<CODE>&nbsp;java.util.Iterator&lt;java.lang.Character&gt;</CODE></FONT></TD>
311<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#iterator()">iterator</A></B>()</CODE>
312
313<BR>
314&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
315</TR>
316<TR BGCOLOR="white" CLASS="TableRowColor">
317<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
318<CODE>&nbsp;java.util.regex.Matcher</CODE></FONT></TD>
319<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>
320
321<BR>
322&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a matcher that will match this rope against the
323 specified pattern.</TD>
324</TR>
325<TR BGCOLOR="white" CLASS="TableRowColor">
326<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
327<CODE>&nbsp;boolean</CODE></FONT></TD>
328<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>
329
330<BR>
331&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if this rope matches the specified
332 <code>Pattern</code>, or <code>false</code> otherwise.</TD>
333</TR>
334<TR BGCOLOR="white" CLASS="TableRowColor">
335<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
336<CODE>&nbsp;boolean</CODE></FONT></TD>
337<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#matches(java.lang.String)">matches</A></B>(java.lang.String&nbsp;regex)</CODE>
338
339<BR>
340&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if this rope matches the specified
341 regular expression, or <code>false</code> otherwise.</TD>
342</TR>
343<TR BGCOLOR="white" CLASS="TableRowColor">
344<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
345<CODE>&nbsp;<A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></FONT></TD>
346<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#padEnd(int)">padEnd</A></B>(int&nbsp;toWidth)</CODE>
347
348<BR>
349&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Increase the length of this rope to the specified length by appending
350 spaces to this rope.</TD>
351</TR>
352<TR BGCOLOR="white" CLASS="TableRowColor">
353<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
354<CODE>&nbsp;<A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></FONT></TD>
355<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#padEnd(int, char)">padEnd</A></B>(int&nbsp;toWidth,
356       char&nbsp;padChar)</CODE>
357
358<BR>
359&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Increase the length of this rope to the specified length by repeatedly 
360 appending the specified character to this rope.</TD>
361</TR>
362<TR BGCOLOR="white" CLASS="TableRowColor">
363<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
364<CODE>&nbsp;<A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></FONT></TD>
365<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#padStart(int)">padStart</A></B>(int&nbsp;toWidth)</CODE>
366
367<BR>
368&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Increase the length of this rope to the specified length by prepending 
369 spaces to this rope.</TD>
370</TR>
371<TR BGCOLOR="white" CLASS="TableRowColor">
372<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
373<CODE>&nbsp;<A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></FONT></TD>
374<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#padStart(int, char)">padStart</A></B>(int&nbsp;toWidth,
375         char&nbsp;padChar)</CODE>
376
377<BR>
378&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Increase the length of this rope to the specified length by repeatedly 
379 prepending the specified character to this rope.</TD>
380</TR>
381<TR BGCOLOR="white" CLASS="TableRowColor">
382<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
383<CODE>&nbsp;<A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></FONT></TD>
384<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#rebalance()">rebalance</A></B>()</CODE>
385
386<BR>
387&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Rebalances the current rope, returning the rebalanced rope.</TD>
388</TR>
389<TR BGCOLOR="white" CLASS="TableRowColor">
390<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
391<CODE>&nbsp;java.util.Iterator&lt;java.lang.Character&gt;</CODE></FONT></TD>
392<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#reverseIterator()">reverseIterator</A></B>()</CODE>
393
394<BR>
395&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns a reverse iterator positioned to start at the end of this
396 rope.</TD>
397</TR>
398<TR BGCOLOR="white" CLASS="TableRowColor">
399<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
400<CODE>&nbsp;boolean</CODE></FONT></TD>
401<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#startsWith(java.lang.CharSequence)">startsWith</A></B>(java.lang.CharSequence&nbsp;prefix)</CODE>
402
403<BR>
404&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if this rope starts with the specified 
405 prefix.</TD>
406</TR>
407<TR BGCOLOR="white" CLASS="TableRowColor">
408<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
409<CODE>&nbsp;boolean</CODE></FONT></TD>
410<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#startsWith(java.lang.CharSequence, int)">startsWith</A></B>(java.lang.CharSequence&nbsp;prefix,
411           int&nbsp;offset)</CODE>
412
413<BR>
414&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Returns <code>true</code> if this rope, beginning from a specified
415 offset, starts with the specified prefix.</TD>
416</TR>
417<TR BGCOLOR="white" CLASS="TableRowColor">
418<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
419<CODE>&nbsp;java.lang.String</CODE></FONT></TD>
420<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#toString()">toString</A></B>()</CODE>
421
422<BR>
423&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
424</TR>
425<TR BGCOLOR="white" CLASS="TableRowColor">
426<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
427<CODE>&nbsp;<A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></FONT></TD>
428<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#trim()">trim</A></B>()</CODE>
429
430<BR>
431&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Trims all whitespace as well as characters less than <code>0x20</code> from
432 the beginning and end of this string.</TD>
433</TR>
434<TR BGCOLOR="white" CLASS="TableRowColor">
435<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
436<CODE>&nbsp;<A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></FONT></TD>
437<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#trimEnd()">trimEnd</A></B>()</CODE>
438
439<BR>
440&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Trims all whitespace as well as characters less than <code>0x20</code> from
441 the end of this rope.</TD>
442</TR>
443<TR BGCOLOR="white" CLASS="TableRowColor">
444<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
445<CODE>&nbsp;<A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></FONT></TD>
446<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#trimStart()">trimStart</A></B>()</CODE>
447
448<BR>
449&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Trims all whitespace as well as characters less than 0x20 from
450 the beginning of this string.</TD>
451</TR>
452<TR BGCOLOR="white" CLASS="TableRowColor">
453<TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
454<CODE>&nbsp;java.lang.Object</CODE></FONT></TD>
455<TD><CODE><B><A HREF="/org/ahmadsoft/ropes/impl/AbstractRope.html#writeReplace()">writeReplace</A></B>()</CODE>
456
457<BR>
458&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</TD>
459</TR>
460</TABLE>
461&nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
462<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
463<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
464<TH ALIGN="left"><B>Methods inherited from class java.lang.Object</B></TH>
465</TR>
466<TR BGCOLOR="white" CLASS="TableRowColor">
467<TD><CODE>getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
468</TR>
469</TABLE>
470&nbsp;<A NAME="methods_inherited_from_class_org.ahmadsoft.ropes.Rope"><!-- --></A>
471<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
472<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
473<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>
474</TR>
475<TR BGCOLOR="white" CLASS="TableRowColor">
476<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>
477</TR>
478</TABLE>
479&nbsp;<A NAME="methods_inherited_from_class_java.lang.CharSequence"><!-- --></A>
480<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
481<TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
482<TH ALIGN="left"><B>Methods inherited from interface java.lang.CharSequence</B></TH>
483</TR>
484<TR BGCOLOR="white" CLASS="TableRowColor">
485<TD><CODE>charAt, length</CODE></TD>
486</TR>
487</TABLE>
488&nbsp;
489<P>
490
491<!-- ========= CONSTRUCTOR DETAIL ======== -->
492
493<A NAME="constructor_detail"><!-- --></A>
494<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
495<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
496<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
497<B>Constructor Detail</B></FONT></TH>
498</TR>
499</TABLE>
500
501<A NAME="AbstractRope()"><!-- --></A><H3>
502AbstractRope</H3>
503<PRE>
504public <B>AbstractRope</B>()</PRE>
505<DL>
506</DL>
507
508<!-- ============ METHOD DETAIL ========== -->
509
510<A NAME="method_detail"><!-- --></A>
511<TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
512<TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
513<TH ALIGN="left" COLSPAN="1"><FONT SIZE="+2">
514<B>Method Detail</B></FONT></TH>
515</TR>
516</TABLE>
517
518<A NAME="append(char)"><!-- --></A><H3>
519append</H3>
520<PRE>
521public <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A> <B>append</B>(char&nbsp;c)</PRE>
522<DL>
523<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#append(char)">Rope</A></CODE></B></DD>
524<DD>Returns a new rope created by appending the specified character to
525 this rope.
526<P>
527<DD><DL>
528<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>
529</DD>
530<DD><DL>
531<DT><B>Parameters:</B><DD><CODE>c</CODE> - the specified character.
532<DT><B>Returns:</B><DD>a new rope.</DL>
533</DD>
534</DL>
535<HR>
536
537<A NAME="append(java.lang.CharSequence)"><!-- --></A><H3>
538append</H3>
539<PRE>
540public <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A> <B>append</B>(java.lang.CharSequence&nbsp;suffix)</PRE>
541<DL>
542<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#append(java.lang.CharSequence)">Rope</A></CODE></B></DD>
543<DD>Returns a new rope created by appending the specified character sequence to
544 this rope.
545<P>
546<DD><DL>
547<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>
548</DD>
549<DD><DL>
550<DT><B>Parameters:</B><DD><CODE>suffix</CODE> - the specified suffix.
551<DT><B>Returns:</B><DD>a new rope.</DL>
552</DD>
553</DL>
554<HR>
555
556<A NAME="append(java.lang.CharSequence, int, int)"><!-- --></A><H3>
557append</H3>
558<PRE>
559public <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A> <B>append</B>(java.lang.CharSequence&nbsp;csq,
560                   int&nbsp;start,
561                   int&nbsp;end)</PRE>
562<DL>
563<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>
564<DD>Returns a new rope created by appending the specified character range to
565 this rope.
566<P>
567<DD><DL>
568<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>
569</DD>
570<DD><DL>
571<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.
572<DT><B>Returns:</B><DD>a new rope.</DL>
573</DD>
574</DL>
575<HR>
576
577<A NAME="compareTo(java.lang.CharSequence)"><!-- --></A><H3>
578compareTo</H3>
579<PRE>
580public int <B>compareTo</B>(java.lang.CharSequence&nbsp;sequence)</PRE>
581<DL>
582<DD><DL>
583<DT><B>Specified by:</B><DD><CODE>compareTo</CODE> in interface <CODE>java.lang.Comparable&lt;java.lang.CharSequence&gt;</CODE></DL>
584</DD>
585<DD><DL>
586</DL>
587</DD>
588</DL>
589<HR>
590
591<A NAME="delete(int, int)"><!-- --></A><H3>
592delete</H3>
593<PRE>
594public <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A> <B>delete</B>(int&nbsp;start,
595                   int&nbsp;end)</PRE>
596<DL>
597<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#delete(int, int)">Rope</A></CODE></B></DD>
598<DD>Creats a new rope by delete the specified character substring.
599 The substring begins at the specified <code>start</code> and extends to
600 the character at index <code>end - 1</code> or to the end of the
601 sequence if no such character exists. If
602 <code>start</code> is equal to <code>end</code>, no changes are made.
603<P>
604<DD><DL>
605<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>
606</DD>
607<DD><DL>
608<DT><B>Parameters:</B><DD><CODE>start</CODE> - The beginning index, inclusive.<DD><CODE>end</CODE> - The ending index, exclusive.
609<DT><B>Returns:</B><DD>This object.</DL>
610</DD>
611</DL>
612<HR>
613
614<A NAME="depth()"><!-- --></A><H3>
615depth</H3>
616<PRE>
617public abstract byte <B>depth</B>()</PRE>
618<DL>
619<DD><DL>
620</DL>
621</DD>
622<DD><DL>
623</DL>
624</DD>
625</DL>
626<HR>
627
628<A NAME="equals(java.lang.Object)"><!-- --></A><H3>
629equals</H3>
630<PRE>
631public boolean <B>equals</B>(java.lang.Object&nbsp;other)</PRE>
632<DL>
633<DD><DL>
634<DT><B>Overrides:</B><DD><CODE>equals</CODE> in class <CODE>java.lang.Object</CODE></DL>
635</DD>
636<DD><DL>
637</DL>
638</DD>
639</DL>
640<HR>
641
642<A NAME="hashCode()"><!-- --></A><H3>
643hashCode</H3>
644<PRE>
645public int <B>hashCode</B>()</PRE>
646<DL>
647<DD><DL>
648<DT><B>Overrides:</B><DD><CODE>hashCode</CODE> in class <CODE>java.lang.Object</CODE></DL>
649</DD>
650<DD><DL>
651</DL>
652</DD>
653</DL>
654<HR>
655
656<A NAME="indexOf(char)"><!-- --></A><H3>
657indexOf</H3>
658<PRE>
659public int <B>indexOf</B>(char&nbsp;ch)</PRE>
660<DL>
661<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#indexOf(char)">Rope</A></CODE></B></DD>
662<DD>Returns the index within this rope of the first occurrence of the
663 specified character. If a character with value <code>ch</code> occurs
664 in the character sequence represented by this <code>Rope</code>
665 object, then the index of the first such occurrence is returned --
666 that is, the smallest value k such that:
667 <p>
668 <code>this.charAt(k) == ch</code>
669 <p>
670 is <code>true</code>. If no such character occurs in this string, then
671 <code>-1</code> is returned.
672<P>
673<DD><DL>
674<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>
675</DD>
676<DD><DL>
677<DT><B>Parameters:</B><DD><CODE>ch</CODE> - a character.
678<DT><B>Returns:</B><DD>the index of the first occurrence of the character in the character
679 sequence represented by this object, or <code>-1</code> if the character
680 does not occur.</DL>
681</DD>
682</DL>
683<HR>
684
685<A NAME="startsWith(java.lang.CharSequence)"><!-- --></A><H3>
686startsWith</H3>
687<PRE>
688public boolean <B>startsWith</B>(java.lang.CharSequence&nbsp;prefix)</PRE>
689<DL>
690<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#startsWith(java.lang.CharSequence)">Rope</A></CODE></B></DD>
691<DD>Returns <code>true</code> if this rope starts with the specified 
692 prefix.
693<P>
694<DD><DL>
695<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#startsWith(java.lang.CharSequence)">startsWith</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
696</DD>
697<DD><DL>
698<DT><B>Parameters:</B><DD><CODE>prefix</CODE> - the prefix to test.
699<DT><B>Returns:</B><DD><code>true</code> if this rope starts with the 
700 specified prefix and <code>false</code> otherwise.<DT><B>See Also:</B><DD><A HREF="/org/ahmadsoft/ropes/Rope.html#startsWith(java.lang.CharSequence, int)"><CODE>Rope.startsWith(CharSequence, int)</CODE></A></DL>
701</DD>
702</DL>
703<HR>
704
705<A NAME="startsWith(java.lang.CharSequence, int)"><!-- --></A><H3>
706startsWith</H3>
707<PRE>
708public boolean <B>startsWith</B>(java.lang.CharSequence&nbsp;prefix,
709                          int&nbsp;offset)</PRE>
710<DL>
711<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#startsWith(java.lang.CharSequence, int)">Rope</A></CODE></B></DD>
712<DD>Returns <code>true</code> if this rope, beginning from a specified
713 offset, starts with the specified prefix.
714<P>
715<DD><DL>
716<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#startsWith(java.lang.CharSequence, int)">startsWith</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
717</DD>
718<DD><DL>
719<DT><B>Parameters:</B><DD><CODE>prefix</CODE> - the prefix to test.<DD><CODE>offset</CODE> - the start offset.
720<DT><B>Returns:</B><DD><code>true</code> if this rope starts with the 
721 specified prefix and <code>false</code> otherwise.</DL>
722</DD>
723</DL>
724<HR>
725
726<A NAME="endsWith(java.lang.CharSequence)"><!-- --></A><H3>
727endsWith</H3>
728<PRE>
729public boolean <B>endsWith</B>(java.lang.CharSequence&nbsp;suffix)</PRE>
730<DL>
731<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#endsWith(java.lang.CharSequence)">Rope</A></CODE></B></DD>
732<DD>Returns <code>true</code> if this rope ends with the specified 
733 suffix.
734<P>
735<DD><DL>
736<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#endsWith(java.lang.CharSequence)">endsWith</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
737</DD>
738<DD><DL>
739<DT><B>Parameters:</B><DD><CODE>suffix</CODE> - the suffix to test.
740<DT><B>Returns:</B><DD><code>true</code> if this rope starts with the 
741 specified suffix and <code>false</code> otherwise.<DT><B>See Also:</B><DD><A HREF="/org/ahmadsoft/ropes/Rope.html#endsWith(java.lang.CharSequence, int)"><CODE>Rope.endsWith(CharSequence, int)</CODE></A></DL>
742</DD>
743</DL>
744<HR>
745
746<A NAME="endsWith(java.lang.CharSequence, int)"><!-- --></A><H3>
747endsWith</H3>
748<PRE>
749public boolean <B>endsWith</B>(java.lang.CharSequence&nbsp;suffix,
750                        int&nbsp;offset)</PRE>
751<DL>
752<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#endsWith(java.lang.CharSequence, int)">Rope</A></CODE></B></DD>
753<DD>Returns <code>true</code> if this rope, terminated at a specified
754 offset, ends with the specified suffix.
755<P>
756<DD><DL>
757<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#endsWith(java.lang.CharSequence, int)">endsWith</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
758</DD>
759<DD><DL>
760<DT><B>Parameters:</B><DD><CODE>suffix</CODE> - the suffix to test.<DD><CODE>offset</CODE> - the termination offset, counted from the end of the 
761 rope.
762<DT><B>Returns:</B><DD><code>true</code> if this rope starts with the 
763 specified prefix and <code>false</code> otherwise.</DL>
764</DD>
765</DL>
766<HR>
767
768<A NAME="indexOf(char, int)"><!-- --></A><H3>
769indexOf</H3>
770<PRE>
771public int <B>indexOf</B>(char&nbsp;ch,
772                   int&nbsp;fromIndex)</PRE>
773<DL>
774<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#indexOf(char, int)">Rope</A></CODE></B></DD>
775<DD>Returns the index within this rope of the first occurrence of the
776 specified character, beginning at the specified index. If a character
777 with value <code>ch</code> occurs in the character sequence
778 represented by this <code>Rope</code> object, then the index of the
779 first such occurrence is returned&#8212;that is, the smallest value k
780 such that:
781 <p>
782 <code>this.charAt(k) == ch</code>
783 <p>
784 is <code>true</code>. If no such character occurs in this string, then
785 <code>-1</code> is returned.
786<P>
787<DD><DL>
788<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>
789</DD>
790<DD><DL>
791<DT><B>Parameters:</B><DD><CODE>ch</CODE> - a character.<DD><CODE>fromIndex</CODE> - the index to start searching from.
792<DT><B>Returns:</B><DD>the index of the first occurrence of the character in the character
793 sequence represented by this object, or -1 if the character does not occur.</DL>
794</DD>
795</DL>
796<HR>
797
798<A NAME="indexOf(java.lang.CharSequence)"><!-- --></A><H3>
799indexOf</H3>
800<PRE>
801public int <B>indexOf</B>(java.lang.CharSequence&nbsp;sequence)</PRE>
802<DL>
803<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#indexOf(java.lang.CharSequence)">Rope</A></CODE></B></DD>
804<DD>Returns the index within this rope of the first occurrence of the
805 specified string. The value returned is the smallest <i>k</i> such
806 that:
807 <pre>
808     this.startsWith(str, k)
809 </pre>
810 If no such <i>k</i> exists, then -1 is returned.
811<P>
812<DD><DL>
813<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>
814</DD>
815<DD><DL>
816<DT><B>Parameters:</B><DD><CODE>sequence</CODE> - the string to find.
817<DT><B>Returns:</B><DD>the index of the first occurrence of the specified string, or
818 -1 if the specified string does not occur.</DL>
819</DD>
820</DL>
821<HR>
822
823<A NAME="indexOf(java.lang.CharSequence, int)"><!-- --></A><H3>
824indexOf</H3>
825<PRE>
826public int <B>indexOf</B>(java.lang.CharSequence&nbsp;sequence,
827                   int&nbsp;fromIndex)</PRE>
828<DL>
829<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#indexOf(java.lang.CharSequence, int)">Rope</A></CODE></B></DD>
830<DD>Returns the index within this rope of the first occurrence of the
831 specified string, beginning at the specified index. The value returned
832 is the smallest <i>k</i> such that:
833 <pre>
834     k >= fromIndex && this.startsWith(str, k)
835 </pre>
836 If no such <i>k</i> exists, then -1 is returned.
837<P>
838<DD><DL>
839<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>
840</DD>
841<DD><DL>
842<DT><B>Parameters:</B><DD><CODE>sequence</CODE> - the string to find.<DD><CODE>fromIndex</CODE> - the index to start searching from.
843<DT><B>Returns:</B><DD>the index of the first occurrence of the specified string, or
844 -1 if the specified string does not occur.</DL>
845</DD>
846</DL>
847<HR>
848
849<A NAME="insert(int, java.lang.CharSequence)"><!-- --></A><H3>
850insert</H3>
851<PRE>
852public <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A> <B>insert</B>(int&nbsp;dstOffset,
853                   java.lang.CharSequence&nbsp;s)</PRE>
854<DL>
855<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#insert(int, java.lang.CharSequence)">Rope</A></CODE></B></DD>
856<DD>Creates a new rope by inserting the specified <code>CharSequence</code>
857 into this rope.
858 <p>
859 The characters of the <code>CharSequence</code> argument are inserted,
860 in order, into this rope at the indicated offset.
861
862 <p>If <code>s</code> is <code>null</code>, then the four characters
863 <code>"null"</code> are inserted into this sequence.
864<P>
865<DD><DL>
866<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>
867</DD>
868<DD><DL>
869<DT><B>Parameters:</B><DD><CODE>dstOffset</CODE> - the offset.<DD><CODE>s</CODE> - the sequence to be inserted
870<DT><B>Returns:</B><DD>a reference to the new Rope.</DL>
871</DD>
872</DL>
873<HR>
874
875<A NAME="iterator()"><!-- --></A><H3>
876iterator</H3>
877<PRE>
878public java.util.Iterator&lt;java.lang.Character&gt; <B>iterator</B>()</PRE>
879<DL>
880<DD><DL>
881<DT><B>Specified by:</B><DD><CODE>iterator</CODE> in interface <CODE>java.lang.Iterable&lt;java.lang.Character&gt;</CODE></DL>
882</DD>
883<DD><DL>
884</DL>
885</DD>
886</DL>
887<HR>
888
889<A NAME="trimStart()"><!-- --></A><H3>
890trimStart</H3>
891<PRE>
892public <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A> <B>trimStart</B>()</PRE>
893<DL>
894<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#trimStart()">Rope</A></CODE></B></DD>
895<DD>Trims all whitespace as well as characters less than 0x20 from
896 the beginning of this string.
897<P>
898<DD><DL>
899<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#trimStart()">trimStart</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
900</DD>
901<DD><DL>
902
903<DT><B>Returns:</B><DD>a rope with all leading whitespace trimmed.</DL>
904</DD>
905</DL>
906<HR>
907
908<A NAME="matcher(java.util.regex.Pattern)"><!-- --></A><H3>
909matcher</H3>
910<PRE>
911public java.util.regex.Matcher <B>matcher</B>(java.util.regex.Pattern&nbsp;pattern)</PRE>
912<DL>
913<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#matcher(java.util.regex.Pattern)">Rope</A></CODE></B></DD>
914<DD>Creates a matcher that will match this rope against the
915 specified pattern. This method produces a higher performance
916 matcher than:
917 <pre>
918 Matcher m = pattern.matcher(this);
919 </pre>
920 The difference may be asymptotically better in some cases.
921<P>
922<DD><DL>
923<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>
924</DD>
925<DD><DL>
926<DT><B>Parameters:</B><DD><CODE>pattern</CODE> - the pattern to match this rope against.
927<DT><B>Returns:</B><DD>a matcher.</DL>
928</DD>
929</DL>
930<HR>
931
932<A NAME="matches(java.util.regex.Pattern)"><!-- --></A><H3>
933matches</H3>
934<PRE>
935public boolean <B>matches</B>(java.util.regex.Pattern&nbsp;regex)</PRE>
936<DL>
937<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#matches(java.util.regex.Pattern)">Rope</A></CODE></B></DD>
938<DD>Returns <code>true</code> if this rope matches the specified
939 <code>Pattern</code>, or <code>false</code> otherwise.
940<P>
941<DD><DL>
942<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>
943</DD>
944<DD><DL>
945<DT><B>Parameters:</B><DD><CODE>regex</CODE> - the specified regular expression.
946<DT><B>Returns:</B><DD><code>true</code> if this rope matches the specified
947 <code>Pattern</code>, or <code>false</code> otherwise.<DT><B>See Also:</B><DD><CODE>Pattern</CODE></DL>
948</DD>
949</DL>
950<HR>
951
952<A NAME="matches(java.lang.String)"><!-- --></A><H3>
953matches</H3>
954<PRE>
955public boolean <B>matches</B>(java.lang.String&nbsp;regex)</PRE>
956<DL>
957<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#matches(java.lang.String)">Rope</A></CODE></B></DD>
958<DD>Returns <code>true</code> if this rope matches the specified
959 regular expression, or <code>false</code> otherwise.
960<P>
961<DD><DL>
962<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>
963</DD>
964<DD><DL>
965<DT><B>Parameters:</B><DD><CODE>regex</CODE> - the specified regular expression.
966<DT><B>Returns:</B><DD><code>true</code> if this rope matches the specified
967 regular expression, or <code>false</code> otherwise.<DT><B>See Also:</B><DD><CODE>Pattern</CODE></DL>
968</DD>
969</DL>
970<HR>
971
972<A NAME="rebalance()"><!-- --></A><H3>
973rebalance</H3>
974<PRE>
975public <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A> <B>rebalance</B>()</PRE>
976<DL>
977<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#rebalance()">Rope</A></CODE></B></DD>
978<DD>Rebalances the current rope, returning the rebalanced rope. In general,
979 rope rebalancing is handled automatically, but this method is provided
980 to give users more control.
981<P>
982<DD><DL>
983<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>
984</DD>
985<DD><DL>
986
987<DT><B>Returns:</B><DD>a rebalanced rope.</DL>
988</DD>
989</DL>
990<HR>
991
992<A NAME="reverseIterator()"><!-- --></A><H3>
993reverseIterator</H3>
994<PRE>
995public java.util.Iterator&lt;java.lang.Character&gt; <B>reverseIterator</B>()</PRE>
996<DL>
997<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#reverseIterator()">Rope</A></CODE></B></DD>
998<DD>Returns a reverse iterator positioned to start at the end of this
999 rope. A reverse iterator moves backwards instead of forwards through
1000 a rope.
1001<P>
1002<DD><DL>
1003<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>
1004</DD>
1005<DD><DL>
1006
1007<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>
1008</DD>
1009</DL>
1010<HR>
1011
1012<A NAME="trimEnd()"><!-- --></A><H3>
1013trimEnd</H3>
1014<PRE>
1015public <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A> <B>trimEnd</B>()</PRE>
1016<DL>
1017<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#trimEnd()">Rope</A></CODE></B></DD>
1018<DD>Trims all whitespace as well as characters less than <code>0x20</code> from
1019 the end of this rope.
1020<P>
1021<DD><DL>
1022<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#trimEnd()">trimEnd</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
1023</DD>
1024<DD><DL>
1025
1026<DT><B>Returns:</B><DD>a rope with all trailing whitespace trimmed.</DL>
1027</DD>
1028</DL>
1029<HR>
1030
1031<A NAME="toString()"><!-- --></A><H3>
1032toString</H3>
1033<PRE>
1034public java.lang.String <B>toString</B>()</PRE>
1035<DL>
1036<DD><DL>
1037<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>
1038</DD>
1039<DD><DL>
1040</DL>
1041</DD>
1042</DL>
1043<HR>
1044
1045<A NAME="trim()"><!-- --></A><H3>
1046trim</H3>
1047<PRE>
1048public <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A> <B>trim</B>()</PRE>
1049<DL>
1050<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#trim()">Rope</A></CODE></B></DD>
1051<DD>Trims all whitespace as well as characters less than <code>0x20</code> from
1052 the beginning and end of this string.
1053<P>
1054<DD><DL>
1055<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>
1056</DD>
1057<DD><DL>
1058
1059<DT><B>Returns:</B><DD>a rope with all leading and trailing whitespace trimmed.</DL>
1060</DD>
1061</DL>
1062<HR>
1063
1064<A NAME="writeReplace()"><!-- --></A><H3>
1065writeReplace</H3>
1066<PRE>
1067public java.lang.Object <B>writeReplace</B>()
1068                              throws java.io.ObjectStreamException</PRE>
1069<DL>
1070<DD><DL>
1071</DL>
1072</DD>
1073<DD><DL>
1074
1075<DT><B>Throws:</B>
1076<DD><CODE>java.io.ObjectStreamException</CODE></DL>
1077</DD>
1078</DL>
1079<HR>
1080
1081<A NAME="padStart(int)"><!-- --></A><H3>
1082padStart</H3>
1083<PRE>
1084public <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A> <B>padStart</B>(int&nbsp;toWidth)</PRE>
1085<DL>
1086<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#padStart(int)">Rope</A></CODE></B></DD>
1087<DD>Increase the length of this rope to the specified length by prepending 
1088 spaces to this rope. If the specified length is less than or equal to 
1089 the current length of the rope, the rope is returned unmodified.
1090<P>
1091<DD><DL>
1092<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#padStart(int)">padStart</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
1093</DD>
1094<DD><DL>
1095<DT><B>Parameters:</B><DD><CODE>toWidth</CODE> - the desired length.
1096<DT><B>Returns:</B><DD>the padded rope.<DT><B>See Also:</B><DD><A HREF="/org/ahmadsoft/ropes/Rope.html#padStart(int, char)"><CODE>Rope.padStart(int, char)</CODE></A></DL>
1097</DD>
1098</DL>
1099<HR>
1100
1101<A NAME="padStart(int, char)"><!-- --></A><H3>
1102padStart</H3>
1103<PRE>
1104public <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A> <B>padStart</B>(int&nbsp;toWidth,
1105                     char&nbsp;padChar)</PRE>
1106<DL>
1107<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#padStart(int, char)">Rope</A></CODE></B></DD>
1108<DD>Increase the length of this rope to the specified length by repeatedly 
1109 prepending the specified character to this rope. If the specified length 
1110 is less than or equal to the current length of the rope, the rope is 
1111 returned unmodified.
1112<P>
1113<DD><DL>
1114<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#padStart(int, char)">padStart</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
1115</DD>
1116<DD><DL>
1117<DT><B>Parameters:</B><DD><CODE>toWidth</CODE> - the desired length.<DD><CODE>padChar</CODE> - the character to use for padding.
1118<DT><B>Returns:</B><DD>the padded rope.<DT><B>See Also:</B><DD><A HREF="/org/ahmadsoft/ropes/Rope.html#padStart(int, char)"><CODE>Rope.padStart(int, char)</CODE></A></DL>
1119</DD>
1120</DL>
1121<HR>
1122
1123<A NAME="padEnd(int)"><!-- --></A><H3>
1124padEnd</H3>
1125<PRE>
1126public <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A> <B>padEnd</B>(int&nbsp;toWidth)</PRE>
1127<DL>
1128<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#padEnd(int)">Rope</A></CODE></B></DD>
1129<DD>Increase the length of this rope to the specified length by appending
1130 spaces to this rope. If the specified length is less than or equal to 
1131 the current length of the rope, the rope is returned unmodified.
1132<P>
1133<DD><DL>
1134<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#padEnd(int)">padEnd</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
1135</DD>
1136<DD><DL>
1137<DT><B>Parameters:</B><DD><CODE>toWidth</CODE> - the desired length.
1138<DT><B>Returns:</B><DD>the padded rope.<DT><B>See Also:</B><DD><A HREF="/org/ahmadsoft/ropes/Rope.html#padStart(int, char)"><CODE>Rope.padStart(int, char)</CODE></A></DL>
1139</DD>
1140</DL>
1141<HR>
1142
1143<A NAME="padEnd(int, char)"><!-- --></A><H3>
1144padEnd</H3>
1145<PRE>
1146public <A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A> <B>padEnd</B>(int&nbsp;toWidth,
1147                   char&nbsp;padChar)</PRE>
1148<DL>
1149<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#padEnd(int, char)">Rope</A></CODE></B></DD>
1150<DD>Increase the length of this rope to the specified length by repeatedly 
1151 appending the specified character to this rope. If the specified length 
1152 is less than or equal to the current length of the rope, the rope is 
1153 returned unmodified.
1154<P>
1155<DD><DL>
1156<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#padEnd(int, char)">padEnd</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
1157</DD>
1158<DD><DL>
1159<DT><B>Parameters:</B><DD><CODE>toWidth</CODE> - the desired length.<DD><CODE>padChar</CODE> - the character to use for padding.
1160<DT><B>Returns:</B><DD>the padded rope.<DT><B>See Also:</B><DD><A HREF="/org/ahmadsoft/ropes/Rope.html#padStart(int, char)"><CODE>Rope.padStart(int, char)</CODE></A></DL>
1161</DD>
1162</DL>
1163<HR>
1164
1165<A NAME="isEmpty()"><!-- --></A><H3>
1166isEmpty</H3>
1167<PRE>
1168public boolean <B>isEmpty</B>()</PRE>
1169<DL>
1170<DD><B>Description copied from interface: <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#isEmpty()">Rope</A></CODE></B></DD>
1171<DD>Returns true if and only if the length of this rope is zero.
1172<P>
1173<DD><DL>
1174<DT><B>Specified by:</B><DD><CODE><A HREF="/org/ahmadsoft/ropes/Rope.html#isEmpty()">isEmpty</A></CODE> in interface <CODE><A HREF="/org/ahmadsoft/ropes/Rope.html" title="interface in org.ahmadsoft.ropes">Rope</A></CODE></DL>
1175</DD>
1176<DD><DL>
1177
1178<DT><B>Returns:</B><DD><code>true</code> if and only if the length of this
1179 rope is zero, and <code>false</code> otherwise.</DL>
1180</DD>
1181</DL>
1182<!-- ========= END OF CLASS DATA ========= -->
1183<HR>
1184
1185
1186<!-- ======= START OF BOTTOM NAVBAR ====== -->
1187<A NAME="navbar_bottom"><!-- --></A>
1188<A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
1189<TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
1190<TR>
1191<TD COLSPAN=2 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
1192<A NAME="navbar_bottom_firstrow"><!-- --></A>
1193<TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
1194  <TR ALIGN="center" VALIGN="top">
1195  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
1196  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
1197  <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
1198  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
1199  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
1200  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
1201  <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1">    <A HREF="/help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
1202  </TR>
1203</TABLE>
1204</TD>
1205<TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
1206</EM>
1207</TD>
1208</TR>
1209
1210<TR>
1211<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1212&nbsp;PREV CLASS&nbsp;
1213&nbsp;<A HREF="/org/ahmadsoft/ropes/impl/ConcatenationRope.html" title="class in org.ahmadsoft.ropes.impl"><B>NEXT CLASS</B></A></FONT></TD>
1214<TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
1215  <A HREF="/index.html?org/ahmadsoft/ropes/impl/AbstractRope.html" target="_top"><B>FRAMES</B></A>  &nbsp;
1216&nbsp;<A HREF="AbstractRope.html" target="_top"><B>NO FRAMES</B></A>  &nbsp;
1217&nbsp;<SCRIPT type="text/javascript">
1218  <!--
1219  if(window==top) {
1220    document.writeln('<A HREF="/allclasses-noframe.html"><B>All Classes</B></A>');
1221  }
1222  //-->
1223</SCRIPT>
1224<NOSCRIPT>
1225  <A HREF="/allclasses-noframe.html"><B>All Classes</B></A>
1226</NOSCRIPT>
1227
1228
1229</FONT></TD>
1230</TR>
1231<TR>
1232<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1233  SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
1234<TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
1235DETAIL:&nbsp;FIELD&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
1236</TR>
1237</TABLE>
1238<A NAME="skip-navbar_bottom"></A>
1239<!-- ======== END OF BOTTOM NAVBAR ======= -->
1240
1241<HR>
1242<i>Copyright &#169; 2008 Amin Ahmad. All Rights Reserved.</i>
1243</BODY>
1244</HTML>
1245