a whole bunch of stuff
[ephemerata.git] / Toady / lib / commons-lang-2.4 / apidocs / org / apache / commons / lang / text / StrBuilder.html
blobbcd57822c9216e3a67686b941f8d64908ed0ec3a
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.4.2_16) on Sat Mar 15 20:43:48 PDT 2008 -->
6 <META http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
7 <TITLE>
8 StrBuilder (Commons Lang 2.4 API)
9 </TITLE>
11 <META NAME="keywords" CONTENT="org.apache.commons.lang.text.StrBuilder class">
13 <LINK REL ="stylesheet" TYPE="text/css" HREF="../../../../../stylesheet.css" TITLE="Style">
15 <SCRIPT type="text/javascript">
16 function windowTitle()
18 parent.document.title="StrBuilder (Commons Lang 2.4 API)";
20 </SCRIPT>
22 </HEAD>
24 <BODY BGCOLOR="white" onload="windowTitle();">
27 <!-- ========= START OF TOP NAVBAR ======= -->
28 <A NAME="navbar_top"><!-- --></A>
29 <A HREF="#skip-navbar_top" title="Skip navigation links"></A>
30 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
31 <TR>
32 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
33 <A NAME="navbar_top_firstrow"><!-- --></A>
34 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
35 <TR ALIGN="center" VALIGN="top">
36 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
37 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
38 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
39 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/StrBuilder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
40 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
41 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
42 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
43 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
44 </TR>
45 </TABLE>
46 </TD>
47 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
48 </EM>
49 </TD>
50 </TR>
52 <TR>
53 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
54 &nbsp;<A HREF="../../../../../org/apache/commons/lang/text/ExtendedMessageFormat.html" title="class in org.apache.commons.lang.text"><B>PREV CLASS</B></A>&nbsp;
55 &nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrLookup.html" title="class in org.apache.commons.lang.text"><B>NEXT CLASS</B></A></FONT></TD>
56 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
57 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
58 &nbsp;<A HREF="StrBuilder.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
59 &nbsp;<SCRIPT type="text/javascript">
60 <!--
61 if(window==top) {
62 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
64 //-->
65 </SCRIPT>
66 <NOSCRIPT>
67 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
68 </NOSCRIPT>
70 </FONT></TD>
71 </TR>
72 <TR>
73 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
74 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
75 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
76 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
77 </TR>
78 </TABLE>
79 <A NAME="skip-navbar_top"></A>
80 <!-- ========= END OF TOP NAVBAR ========= -->
82 <HR>
83 <!-- ======== START OF CLASS DATA ======== -->
84 <H2>
85 <FONT SIZE="-1">
86 org.apache.commons.lang.text</FONT>
87 <BR>
88 Class StrBuilder</H2>
89 <PRE>
90 java.lang.Object
91 <IMG SRC="../../../../../resources/inherit.gif" ALT="extended by"><B>org.apache.commons.lang.text.StrBuilder</B>
92 </PRE>
93 <DL>
94 <DT><B>All Implemented Interfaces:</B> <DD>java.lang.Cloneable</DD>
95 </DL>
96 <HR>
97 <DL>
98 <DT>public class <B>StrBuilder</B><DT>extends java.lang.Object<DT>implements java.lang.Cloneable</DL>
101 Builds a string from constituent parts providing a more flexible and powerful API
102 than StringBuffer.
104 The main differences from StringBuffer/StringBuilder are:
105 <ul>
106 <li>Not synchronized</li>
107 <li>Not final</li>
108 <li>Subclasses have direct access to character array</li>
109 <li>Additional methods
110 <ul>
111 <li>appendWithSeparators - adds an array of values, with a separator</li>
112 <li>appendPadding - adds a length padding characters</li>
113 <li>appendFixedLength - adds a fixed width field to the builder</li>
114 <li>toCharArray/getChars - simpler ways to get a range of the character array</li>
115 <li>delete - delete char or string</li>
116 <li>replace - search and replace for a char or string</li>
117 <li>leftString/rightString/midString - substring without exceptions</li>
118 <li>contains - whether the builder contains a char or string</li>
119 <li>size/clear/isEmpty - collections style API methods</li>
120 </ul>
121 </li>
122 </ul>
123 <li>Views
124 <ul>
125 <li>asTokenizer - uses the internal buffer as the source of a StrTokenizer</li>
126 <li>asReader - uses the internal buffer as the source of a Reader</li>
127 <li>asWriter - allows a Writer to write directly to the internal buffer</li>
128 </ul>
129 </li>
130 </ul>
132 The aim has been to provide an API that mimics very closely what StringBuffer
133 provides, but with additional methods. It should be noted that some edge cases,
134 with invalid indices or null input, have been altered - see individual methods.
135 The biggest of these changes is that by default, null will not output the text
136 'null'. This can be controlled by a property, <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#setNullText(java.lang.String)"><CODE>setNullText(String)</CODE></A>.
140 <DL>
141 <DT><B>Since:</B></DT>
142 <DD>2.2</DD>
143 <DT><B>Version:</B></DT>
144 <DD>$Id: StrBuilder.java 627248 2008-02-13 05:44:46Z bayard $</DD>
145 <DT><B>Author:</B></DT>
146 <DD>Stephen Colebourne</DD>
147 </DL>
148 <HR>
151 <!-- ======== NESTED CLASS SUMMARY ======== -->
154 <!-- =========== FIELD SUMMARY =========== -->
156 <A NAME="field_summary"><!-- --></A>
157 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
158 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
159 <TD COLSPAN=2><FONT SIZE="+2">
160 <B>Field Summary</B></FONT></TD>
161 </TR>
162 <TR BGCOLOR="white" CLASS="TableRowColor">
163 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
164 <CODE>protected &nbsp;char[]</CODE></FONT></TD>
165 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#buffer">buffer</A></B></CODE>
167 <BR>
168 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Internal data storage.</TD>
169 </TR>
170 <TR BGCOLOR="white" CLASS="TableRowColor">
171 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
172 <CODE>protected &nbsp;int</CODE></FONT></TD>
173 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#size">size</A></B></CODE>
175 <BR>
176 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Current size of the buffer.</TD>
177 </TR>
178 </TABLE>
179 &nbsp;
180 <!-- ======== CONSTRUCTOR SUMMARY ======== -->
182 <A NAME="constructor_summary"><!-- --></A>
183 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
184 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
185 <TD COLSPAN=2><FONT SIZE="+2">
186 <B>Constructor Summary</B></FONT></TD>
187 </TR>
188 <TR BGCOLOR="white" CLASS="TableRowColor">
189 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#StrBuilder()">StrBuilder</A></B>()</CODE>
191 <BR>
192 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor that creates an empty builder initial capacity 32 characters.</TD>
193 </TR>
194 <TR BGCOLOR="white" CLASS="TableRowColor">
195 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#StrBuilder(int)">StrBuilder</A></B>(int&nbsp;initialCapacity)</CODE>
197 <BR>
198 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor that creates an empty builder the specified initial capacity.</TD>
199 </TR>
200 <TR BGCOLOR="white" CLASS="TableRowColor">
201 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#StrBuilder(java.lang.String)">StrBuilder</A></B>(java.lang.String&nbsp;str)</CODE>
203 <BR>
204 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Constructor that creates a builder from the string, allocating
205 32 extra characters for growth.</TD>
206 </TR>
207 </TABLE>
208 &nbsp;
209 <!-- ========== METHOD SUMMARY =========== -->
211 <A NAME="method_summary"><!-- --></A>
212 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
213 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
214 <TD COLSPAN=2><FONT SIZE="+2">
215 <B>Method Summary</B></FONT></TD>
216 </TR>
217 <TR BGCOLOR="white" CLASS="TableRowColor">
218 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
219 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
220 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(boolean)">append</A></B>(boolean&nbsp;value)</CODE>
222 <BR>
223 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a boolean value to the string builder.</TD>
224 </TR>
225 <TR BGCOLOR="white" CLASS="TableRowColor">
226 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
227 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
228 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(char)">append</A></B>(char&nbsp;ch)</CODE>
230 <BR>
231 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a char value to the string builder.</TD>
232 </TR>
233 <TR BGCOLOR="white" CLASS="TableRowColor">
234 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
235 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
236 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(char[])">append</A></B>(char[]&nbsp;chars)</CODE>
238 <BR>
239 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a char array to the string builder.</TD>
240 </TR>
241 <TR BGCOLOR="white" CLASS="TableRowColor">
242 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
243 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
244 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(char[], int, int)">append</A></B>(char[]&nbsp;chars,
245 int&nbsp;startIndex,
246 int&nbsp;length)</CODE>
248 <BR>
249 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a char array to the string builder.</TD>
250 </TR>
251 <TR BGCOLOR="white" CLASS="TableRowColor">
252 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
253 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
254 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(double)">append</A></B>(double&nbsp;value)</CODE>
256 <BR>
257 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a double value to the string builder using <code>String.valueOf</code>.</TD>
258 </TR>
259 <TR BGCOLOR="white" CLASS="TableRowColor">
260 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
261 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
262 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(float)">append</A></B>(float&nbsp;value)</CODE>
264 <BR>
265 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a float value to the string builder using <code>String.valueOf</code>.</TD>
266 </TR>
267 <TR BGCOLOR="white" CLASS="TableRowColor">
268 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
269 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
270 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(int)">append</A></B>(int&nbsp;value)</CODE>
272 <BR>
273 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends an int value to the string builder using <code>String.valueOf</code>.</TD>
274 </TR>
275 <TR BGCOLOR="white" CLASS="TableRowColor">
276 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
277 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
278 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(long)">append</A></B>(long&nbsp;value)</CODE>
280 <BR>
281 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a long value to the string builder using <code>String.valueOf</code>.</TD>
282 </TR>
283 <TR BGCOLOR="white" CLASS="TableRowColor">
284 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
285 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
286 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(java.lang.Object)">append</A></B>(java.lang.Object&nbsp;obj)</CODE>
288 <BR>
289 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends an object to this string builder.</TD>
290 </TR>
291 <TR BGCOLOR="white" CLASS="TableRowColor">
292 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
293 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
294 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(org.apache.commons.lang.text.StrBuilder)">append</A></B>(<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A>&nbsp;str)</CODE>
296 <BR>
297 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends another string builder to this string builder.</TD>
298 </TR>
299 <TR BGCOLOR="white" CLASS="TableRowColor">
300 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
301 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
302 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(org.apache.commons.lang.text.StrBuilder, int, int)">append</A></B>(<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A>&nbsp;str,
303 int&nbsp;startIndex,
304 int&nbsp;length)</CODE>
306 <BR>
307 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends part of a string builder to this string builder.</TD>
308 </TR>
309 <TR BGCOLOR="white" CLASS="TableRowColor">
310 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
311 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
312 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(java.lang.String)">append</A></B>(java.lang.String&nbsp;str)</CODE>
314 <BR>
315 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a string to this string builder.</TD>
316 </TR>
317 <TR BGCOLOR="white" CLASS="TableRowColor">
318 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
319 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
320 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(java.lang.StringBuffer)">append</A></B>(java.lang.StringBuffer&nbsp;str)</CODE>
322 <BR>
323 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a string buffer to this string builder.</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/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
328 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(java.lang.StringBuffer, int, int)">append</A></B>(java.lang.StringBuffer&nbsp;str,
329 int&nbsp;startIndex,
330 int&nbsp;length)</CODE>
332 <BR>
333 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends part of a string buffer to this string builder.</TD>
334 </TR>
335 <TR BGCOLOR="white" CLASS="TableRowColor">
336 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
337 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
338 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(java.lang.String, int, int)">append</A></B>(java.lang.String&nbsp;str,
339 int&nbsp;startIndex,
340 int&nbsp;length)</CODE>
342 <BR>
343 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends part of a string to this string builder.</TD>
344 </TR>
345 <TR BGCOLOR="white" CLASS="TableRowColor">
346 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
347 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
348 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendAll(java.util.Collection)">appendAll</A></B>(java.util.Collection&nbsp;coll)</CODE>
350 <BR>
351 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends each item in a collection to the builder without any separators.</TD>
352 </TR>
353 <TR BGCOLOR="white" CLASS="TableRowColor">
354 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
355 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
356 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendAll(java.util.Iterator)">appendAll</A></B>(java.util.Iterator&nbsp;it)</CODE>
358 <BR>
359 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends each item in an iterator to the builder without any separators.</TD>
360 </TR>
361 <TR BGCOLOR="white" CLASS="TableRowColor">
362 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
363 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
364 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendAll(java.lang.Object[])">appendAll</A></B>(java.lang.Object[]&nbsp;array)</CODE>
366 <BR>
367 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends each item in an array to the builder without any separators.</TD>
368 </TR>
369 <TR BGCOLOR="white" CLASS="TableRowColor">
370 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
371 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
372 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendFixedWidthPadLeft(int, int, char)">appendFixedWidthPadLeft</A></B>(int&nbsp;value,
373 int&nbsp;width,
374 char&nbsp;padChar)</CODE>
376 <BR>
377 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends an object to the builder padding on the left to a fixed width.</TD>
378 </TR>
379 <TR BGCOLOR="white" CLASS="TableRowColor">
380 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
381 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
382 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendFixedWidthPadLeft(java.lang.Object, int, char)">appendFixedWidthPadLeft</A></B>(java.lang.Object&nbsp;obj,
383 int&nbsp;width,
384 char&nbsp;padChar)</CODE>
386 <BR>
387 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends an object to the builder padding on the left to a fixed width.</TD>
388 </TR>
389 <TR BGCOLOR="white" CLASS="TableRowColor">
390 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
391 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
392 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendFixedWidthPadRight(int, int, char)">appendFixedWidthPadRight</A></B>(int&nbsp;value,
393 int&nbsp;width,
394 char&nbsp;padChar)</CODE>
396 <BR>
397 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends an object to the builder padding on the right to a fixed length.</TD>
398 </TR>
399 <TR BGCOLOR="white" CLASS="TableRowColor">
400 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
401 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
402 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendFixedWidthPadRight(java.lang.Object, int, char)">appendFixedWidthPadRight</A></B>(java.lang.Object&nbsp;obj,
403 int&nbsp;width,
404 char&nbsp;padChar)</CODE>
406 <BR>
407 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends an object to the builder padding on the right to a fixed length.</TD>
408 </TR>
409 <TR BGCOLOR="white" CLASS="TableRowColor">
410 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
411 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
412 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendln(boolean)">appendln</A></B>(boolean&nbsp;value)</CODE>
414 <BR>
415 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a boolean value followed by a new line to the string builder.</TD>
416 </TR>
417 <TR BGCOLOR="white" CLASS="TableRowColor">
418 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
419 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
420 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendln(char)">appendln</A></B>(char&nbsp;ch)</CODE>
422 <BR>
423 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a char value followed by a new line to the string builder.</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/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
428 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendln(char[])">appendln</A></B>(char[]&nbsp;chars)</CODE>
430 <BR>
431 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a char array followed by a new line to the string builder.</TD>
432 </TR>
433 <TR BGCOLOR="white" CLASS="TableRowColor">
434 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
435 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
436 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendln(char[], int, int)">appendln</A></B>(char[]&nbsp;chars,
437 int&nbsp;startIndex,
438 int&nbsp;length)</CODE>
440 <BR>
441 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a char array followed by a new line to the string builder.</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/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
446 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendln(double)">appendln</A></B>(double&nbsp;value)</CODE>
448 <BR>
449 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a double value followed by a new line to the string builder using <code>String.valueOf</code>.</TD>
450 </TR>
451 <TR BGCOLOR="white" CLASS="TableRowColor">
452 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
453 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
454 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendln(float)">appendln</A></B>(float&nbsp;value)</CODE>
456 <BR>
457 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a float value followed by a new line to the string builder using <code>String.valueOf</code>.</TD>
458 </TR>
459 <TR BGCOLOR="white" CLASS="TableRowColor">
460 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
461 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
462 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendln(int)">appendln</A></B>(int&nbsp;value)</CODE>
464 <BR>
465 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends an int value followed by a new line to the string builder using <code>String.valueOf</code>.</TD>
466 </TR>
467 <TR BGCOLOR="white" CLASS="TableRowColor">
468 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
469 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
470 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendln(long)">appendln</A></B>(long&nbsp;value)</CODE>
472 <BR>
473 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a long value followed by a new line to the string builder using <code>String.valueOf</code>.</TD>
474 </TR>
475 <TR BGCOLOR="white" CLASS="TableRowColor">
476 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
477 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
478 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendln(java.lang.Object)">appendln</A></B>(java.lang.Object&nbsp;obj)</CODE>
480 <BR>
481 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends an object followed by a new line to this string builder.</TD>
482 </TR>
483 <TR BGCOLOR="white" CLASS="TableRowColor">
484 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
485 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
486 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendln(org.apache.commons.lang.text.StrBuilder)">appendln</A></B>(<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A>&nbsp;str)</CODE>
488 <BR>
489 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends another string builder followed by a new line to this string builder.</TD>
490 </TR>
491 <TR BGCOLOR="white" CLASS="TableRowColor">
492 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
493 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
494 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendln(org.apache.commons.lang.text.StrBuilder, int, int)">appendln</A></B>(<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A>&nbsp;str,
495 int&nbsp;startIndex,
496 int&nbsp;length)</CODE>
498 <BR>
499 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends part of a string builder followed by a new line to this string builder.</TD>
500 </TR>
501 <TR BGCOLOR="white" CLASS="TableRowColor">
502 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
503 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
504 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendln(java.lang.String)">appendln</A></B>(java.lang.String&nbsp;str)</CODE>
506 <BR>
507 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a string followed by a new line to this string builder.</TD>
508 </TR>
509 <TR BGCOLOR="white" CLASS="TableRowColor">
510 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
511 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
512 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendln(java.lang.StringBuffer)">appendln</A></B>(java.lang.StringBuffer&nbsp;str)</CODE>
514 <BR>
515 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a string buffer followed by a new line to this string builder.</TD>
516 </TR>
517 <TR BGCOLOR="white" CLASS="TableRowColor">
518 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
519 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
520 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendln(java.lang.StringBuffer, int, int)">appendln</A></B>(java.lang.StringBuffer&nbsp;str,
521 int&nbsp;startIndex,
522 int&nbsp;length)</CODE>
524 <BR>
525 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends part of a string buffer followed by a new line to this string builder.</TD>
526 </TR>
527 <TR BGCOLOR="white" CLASS="TableRowColor">
528 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
529 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
530 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendln(java.lang.String, int, int)">appendln</A></B>(java.lang.String&nbsp;str,
531 int&nbsp;startIndex,
532 int&nbsp;length)</CODE>
534 <BR>
535 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends part of a string followed by a new line to this string builder.</TD>
536 </TR>
537 <TR BGCOLOR="white" CLASS="TableRowColor">
538 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
539 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
540 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendNewLine()">appendNewLine</A></B>()</CODE>
542 <BR>
543 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends the new line string to this string builder.</TD>
544 </TR>
545 <TR BGCOLOR="white" CLASS="TableRowColor">
546 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
547 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
548 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendNull()">appendNull</A></B>()</CODE>
550 <BR>
551 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends the text representing <code>null</code> to this string builder.</TD>
552 </TR>
553 <TR BGCOLOR="white" CLASS="TableRowColor">
554 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
555 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
556 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendPadding(int, char)">appendPadding</A></B>(int&nbsp;length,
557 char&nbsp;padChar)</CODE>
559 <BR>
560 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends the pad character to the builder the specified number of times.</TD>
561 </TR>
562 <TR BGCOLOR="white" CLASS="TableRowColor">
563 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
564 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
565 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendSeparator(char)">appendSeparator</A></B>(char&nbsp;separator)</CODE>
567 <BR>
568 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a separator if the builder is currently non-empty.</TD>
569 </TR>
570 <TR BGCOLOR="white" CLASS="TableRowColor">
571 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
572 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
573 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendSeparator(char, int)">appendSeparator</A></B>(char&nbsp;separator,
574 int&nbsp;loopIndex)</CODE>
576 <BR>
577 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a separator to the builder if the loop index is greater than zero.</TD>
578 </TR>
579 <TR BGCOLOR="white" CLASS="TableRowColor">
580 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
581 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
582 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendSeparator(java.lang.String)">appendSeparator</A></B>(java.lang.String&nbsp;separator)</CODE>
584 <BR>
585 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a separator if the builder is currently non-empty.</TD>
586 </TR>
587 <TR BGCOLOR="white" CLASS="TableRowColor">
588 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
589 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
590 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendSeparator(java.lang.String, int)">appendSeparator</A></B>(java.lang.String&nbsp;separator,
591 int&nbsp;loopIndex)</CODE>
593 <BR>
594 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a separator to the builder if the loop index is greater than zero.</TD>
595 </TR>
596 <TR BGCOLOR="white" CLASS="TableRowColor">
597 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
598 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
599 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendWithSeparators(java.util.Collection, java.lang.String)">appendWithSeparators</A></B>(java.util.Collection&nbsp;coll,
600 java.lang.String&nbsp;separator)</CODE>
602 <BR>
603 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends a collection placing separators between each value, but
604 not before the first or after the last.</TD>
605 </TR>
606 <TR BGCOLOR="white" CLASS="TableRowColor">
607 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
608 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
609 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendWithSeparators(java.util.Iterator, java.lang.String)">appendWithSeparators</A></B>(java.util.Iterator&nbsp;it,
610 java.lang.String&nbsp;separator)</CODE>
612 <BR>
613 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends an iterator placing separators between each value, but
614 not before the first or after the last.</TD>
615 </TR>
616 <TR BGCOLOR="white" CLASS="TableRowColor">
617 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
618 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
619 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendWithSeparators(java.lang.Object[], java.lang.String)">appendWithSeparators</A></B>(java.lang.Object[]&nbsp;array,
620 java.lang.String&nbsp;separator)</CODE>
622 <BR>
623 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Appends an array placing separators between each value, but
624 not before the first or after the last.</TD>
625 </TR>
626 <TR BGCOLOR="white" CLASS="TableRowColor">
627 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
628 <CODE>&nbsp;java.io.Reader</CODE></FONT></TD>
629 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#asReader()">asReader</A></B>()</CODE>
631 <BR>
632 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the contents of this builder as a Reader.</TD>
633 </TR>
634 <TR BGCOLOR="white" CLASS="TableRowColor">
635 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
636 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrTokenizer.html" title="class in org.apache.commons.lang.text">StrTokenizer</A></CODE></FONT></TD>
637 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#asTokenizer()">asTokenizer</A></B>()</CODE>
639 <BR>
640 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Creates a tokenizer that can tokenize the contents of this builder.</TD>
641 </TR>
642 <TR BGCOLOR="white" CLASS="TableRowColor">
643 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
644 <CODE>&nbsp;java.io.Writer</CODE></FONT></TD>
645 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#asWriter()">asWriter</A></B>()</CODE>
647 <BR>
648 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets this builder as a Writer that can be written to.</TD>
649 </TR>
650 <TR BGCOLOR="white" CLASS="TableRowColor">
651 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
652 <CODE>&nbsp;int</CODE></FONT></TD>
653 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#capacity()">capacity</A></B>()</CODE>
655 <BR>
656 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the current size of the internal character array buffer.</TD>
657 </TR>
658 <TR BGCOLOR="white" CLASS="TableRowColor">
659 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
660 <CODE>&nbsp;char</CODE></FONT></TD>
661 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#charAt(int)">charAt</A></B>(int&nbsp;index)</CODE>
663 <BR>
664 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the character at the specified index.</TD>
665 </TR>
666 <TR BGCOLOR="white" CLASS="TableRowColor">
667 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
668 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
669 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#clear()">clear</A></B>()</CODE>
671 <BR>
672 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Clears the string builder (convenience Collections API style method).</TD>
673 </TR>
674 <TR BGCOLOR="white" CLASS="TableRowColor">
675 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
676 <CODE>&nbsp;boolean</CODE></FONT></TD>
677 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#contains(char)">contains</A></B>(char&nbsp;ch)</CODE>
679 <BR>
680 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks if the string builder contains the specified char.</TD>
681 </TR>
682 <TR BGCOLOR="white" CLASS="TableRowColor">
683 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
684 <CODE>&nbsp;boolean</CODE></FONT></TD>
685 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#contains(java.lang.String)">contains</A></B>(java.lang.String&nbsp;str)</CODE>
687 <BR>
688 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks if the string builder contains the specified string.</TD>
689 </TR>
690 <TR BGCOLOR="white" CLASS="TableRowColor">
691 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
692 <CODE>&nbsp;boolean</CODE></FONT></TD>
693 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#contains(org.apache.commons.lang.text.StrMatcher)">contains</A></B>(<A HREF="../../../../../org/apache/commons/lang/text/StrMatcher.html" title="class in org.apache.commons.lang.text">StrMatcher</A>&nbsp;matcher)</CODE>
695 <BR>
696 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks if the string builder contains a string matched using the
697 specified matcher.</TD>
698 </TR>
699 <TR BGCOLOR="white" CLASS="TableRowColor">
700 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
701 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
702 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#delete(int, int)">delete</A></B>(int&nbsp;startIndex,
703 int&nbsp;endIndex)</CODE>
705 <BR>
706 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deletes the characters between the two specified indices.</TD>
707 </TR>
708 <TR BGCOLOR="white" CLASS="TableRowColor">
709 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
710 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
711 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#deleteAll(char)">deleteAll</A></B>(char&nbsp;ch)</CODE>
713 <BR>
714 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deletes the character wherever it occurs in the builder.</TD>
715 </TR>
716 <TR BGCOLOR="white" CLASS="TableRowColor">
717 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
718 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
719 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#deleteAll(java.lang.String)">deleteAll</A></B>(java.lang.String&nbsp;str)</CODE>
721 <BR>
722 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deletes the string wherever it occurs in the builder.</TD>
723 </TR>
724 <TR BGCOLOR="white" CLASS="TableRowColor">
725 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
726 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
727 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#deleteAll(org.apache.commons.lang.text.StrMatcher)">deleteAll</A></B>(<A HREF="../../../../../org/apache/commons/lang/text/StrMatcher.html" title="class in org.apache.commons.lang.text">StrMatcher</A>&nbsp;matcher)</CODE>
729 <BR>
730 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deletes all parts of the builder that the matcher matches.</TD>
731 </TR>
732 <TR BGCOLOR="white" CLASS="TableRowColor">
733 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
734 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
735 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#deleteCharAt(int)">deleteCharAt</A></B>(int&nbsp;index)</CODE>
737 <BR>
738 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deletes the character at the specified index.</TD>
739 </TR>
740 <TR BGCOLOR="white" CLASS="TableRowColor">
741 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
742 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
743 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#deleteFirst(char)">deleteFirst</A></B>(char&nbsp;ch)</CODE>
745 <BR>
746 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deletes the character wherever it occurs in the builder.</TD>
747 </TR>
748 <TR BGCOLOR="white" CLASS="TableRowColor">
749 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
750 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
751 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#deleteFirst(java.lang.String)">deleteFirst</A></B>(java.lang.String&nbsp;str)</CODE>
753 <BR>
754 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deletes the string wherever it occurs in the builder.</TD>
755 </TR>
756 <TR BGCOLOR="white" CLASS="TableRowColor">
757 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
758 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
759 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#deleteFirst(org.apache.commons.lang.text.StrMatcher)">deleteFirst</A></B>(<A HREF="../../../../../org/apache/commons/lang/text/StrMatcher.html" title="class in org.apache.commons.lang.text">StrMatcher</A>&nbsp;matcher)</CODE>
761 <BR>
762 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Deletes the first match within the builder using the specified matcher.</TD>
763 </TR>
764 <TR BGCOLOR="white" CLASS="TableRowColor">
765 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
766 <CODE>&nbsp;boolean</CODE></FONT></TD>
767 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#endsWith(java.lang.String)">endsWith</A></B>(java.lang.String&nbsp;str)</CODE>
769 <BR>
770 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks whether this builder ends with the specified string.</TD>
771 </TR>
772 <TR BGCOLOR="white" CLASS="TableRowColor">
773 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
774 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
775 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#ensureCapacity(int)">ensureCapacity</A></B>(int&nbsp;capacity)</CODE>
777 <BR>
778 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks the capacity and ensures that it is at least the size specified.</TD>
779 </TR>
780 <TR BGCOLOR="white" CLASS="TableRowColor">
781 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
782 <CODE>&nbsp;boolean</CODE></FONT></TD>
783 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#equals(java.lang.Object)">equals</A></B>(java.lang.Object&nbsp;obj)</CODE>
785 <BR>
786 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks the contents of this builder against another to see if they
787 contain the same character content.</TD>
788 </TR>
789 <TR BGCOLOR="white" CLASS="TableRowColor">
790 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
791 <CODE>&nbsp;boolean</CODE></FONT></TD>
792 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#equals(org.apache.commons.lang.text.StrBuilder)">equals</A></B>(<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A>&nbsp;other)</CODE>
794 <BR>
795 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks the contents of this builder against another to see if they
796 contain the same character content.</TD>
797 </TR>
798 <TR BGCOLOR="white" CLASS="TableRowColor">
799 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
800 <CODE>&nbsp;boolean</CODE></FONT></TD>
801 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#equalsIgnoreCase(org.apache.commons.lang.text.StrBuilder)">equalsIgnoreCase</A></B>(<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A>&nbsp;other)</CODE>
803 <BR>
804 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks the contents of this builder against another to see if they
805 contain the same character content ignoring case.</TD>
806 </TR>
807 <TR BGCOLOR="white" CLASS="TableRowColor">
808 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
809 <CODE>&nbsp;char[]</CODE></FONT></TD>
810 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#getChars(char[])">getChars</A></B>(char[]&nbsp;destination)</CODE>
812 <BR>
813 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Copies the character array into the specified array.</TD>
814 </TR>
815 <TR BGCOLOR="white" CLASS="TableRowColor">
816 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
817 <CODE>&nbsp;void</CODE></FONT></TD>
818 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#getChars(int, int, char[], int)">getChars</A></B>(int&nbsp;startIndex,
819 int&nbsp;endIndex,
820 char[]&nbsp;destination,
821 int&nbsp;destinationIndex)</CODE>
823 <BR>
824 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Copies the character array into the specified array.</TD>
825 </TR>
826 <TR BGCOLOR="white" CLASS="TableRowColor">
827 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
828 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
829 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#getNewLineText()">getNewLineText</A></B>()</CODE>
831 <BR>
832 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the text to be appended when a new line is added.</TD>
833 </TR>
834 <TR BGCOLOR="white" CLASS="TableRowColor">
835 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
836 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
837 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#getNullText()">getNullText</A></B>()</CODE>
839 <BR>
840 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the text to be appended when null is added.</TD>
841 </TR>
842 <TR BGCOLOR="white" CLASS="TableRowColor">
843 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
844 <CODE>&nbsp;int</CODE></FONT></TD>
845 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#hashCode()">hashCode</A></B>()</CODE>
847 <BR>
848 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets a suitable hash code for this builder.</TD>
849 </TR>
850 <TR BGCOLOR="white" CLASS="TableRowColor">
851 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
852 <CODE>&nbsp;int</CODE></FONT></TD>
853 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#indexOf(char)">indexOf</A></B>(char&nbsp;ch)</CODE>
855 <BR>
856 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Searches the string builder to find the first reference to the specified char.</TD>
857 </TR>
858 <TR BGCOLOR="white" CLASS="TableRowColor">
859 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
860 <CODE>&nbsp;int</CODE></FONT></TD>
861 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#indexOf(char, int)">indexOf</A></B>(char&nbsp;ch,
862 int&nbsp;startIndex)</CODE>
864 <BR>
865 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Searches the string builder to find the first reference to the specified char.</TD>
866 </TR>
867 <TR BGCOLOR="white" CLASS="TableRowColor">
868 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
869 <CODE>&nbsp;int</CODE></FONT></TD>
870 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#indexOf(java.lang.String)">indexOf</A></B>(java.lang.String&nbsp;str)</CODE>
872 <BR>
873 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Searches the string builder to find the first reference to the specified string.</TD>
874 </TR>
875 <TR BGCOLOR="white" CLASS="TableRowColor">
876 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
877 <CODE>&nbsp;int</CODE></FONT></TD>
878 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#indexOf(java.lang.String, int)">indexOf</A></B>(java.lang.String&nbsp;str,
879 int&nbsp;startIndex)</CODE>
881 <BR>
882 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Searches the string builder to find the first reference to the specified
883 string starting searching from the given index.</TD>
884 </TR>
885 <TR BGCOLOR="white" CLASS="TableRowColor">
886 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
887 <CODE>&nbsp;int</CODE></FONT></TD>
888 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#indexOf(org.apache.commons.lang.text.StrMatcher)">indexOf</A></B>(<A HREF="../../../../../org/apache/commons/lang/text/StrMatcher.html" title="class in org.apache.commons.lang.text">StrMatcher</A>&nbsp;matcher)</CODE>
890 <BR>
891 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Searches the string builder using the matcher to find the first match.</TD>
892 </TR>
893 <TR BGCOLOR="white" CLASS="TableRowColor">
894 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
895 <CODE>&nbsp;int</CODE></FONT></TD>
896 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#indexOf(org.apache.commons.lang.text.StrMatcher, int)">indexOf</A></B>(<A HREF="../../../../../org/apache/commons/lang/text/StrMatcher.html" title="class in org.apache.commons.lang.text">StrMatcher</A>&nbsp;matcher,
897 int&nbsp;startIndex)</CODE>
899 <BR>
900 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Searches the string builder using the matcher to find the first
901 match searching from the given index.</TD>
902 </TR>
903 <TR BGCOLOR="white" CLASS="TableRowColor">
904 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
905 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
906 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#insert(int, boolean)">insert</A></B>(int&nbsp;index,
907 boolean&nbsp;value)</CODE>
909 <BR>
910 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Inserts the value into this builder.</TD>
911 </TR>
912 <TR BGCOLOR="white" CLASS="TableRowColor">
913 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
914 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
915 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#insert(int, char)">insert</A></B>(int&nbsp;index,
916 char&nbsp;value)</CODE>
918 <BR>
919 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Inserts the value into this builder.</TD>
920 </TR>
921 <TR BGCOLOR="white" CLASS="TableRowColor">
922 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
923 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
924 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#insert(int, char[])">insert</A></B>(int&nbsp;index,
925 char[]&nbsp;chars)</CODE>
927 <BR>
928 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Inserts the character array into this builder.</TD>
929 </TR>
930 <TR BGCOLOR="white" CLASS="TableRowColor">
931 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
932 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
933 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#insert(int, char[], int, int)">insert</A></B>(int&nbsp;index,
934 char[]&nbsp;chars,
935 int&nbsp;offset,
936 int&nbsp;length)</CODE>
938 <BR>
939 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Inserts part of the character array into this builder.</TD>
940 </TR>
941 <TR BGCOLOR="white" CLASS="TableRowColor">
942 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
943 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
944 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#insert(int, double)">insert</A></B>(int&nbsp;index,
945 double&nbsp;value)</CODE>
947 <BR>
948 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Inserts the value into this builder.</TD>
949 </TR>
950 <TR BGCOLOR="white" CLASS="TableRowColor">
951 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
952 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
953 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#insert(int, float)">insert</A></B>(int&nbsp;index,
954 float&nbsp;value)</CODE>
956 <BR>
957 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Inserts the value into this builder.</TD>
958 </TR>
959 <TR BGCOLOR="white" CLASS="TableRowColor">
960 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
961 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
962 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#insert(int, int)">insert</A></B>(int&nbsp;index,
963 int&nbsp;value)</CODE>
965 <BR>
966 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Inserts the value into this builder.</TD>
967 </TR>
968 <TR BGCOLOR="white" CLASS="TableRowColor">
969 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
970 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
971 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#insert(int, long)">insert</A></B>(int&nbsp;index,
972 long&nbsp;value)</CODE>
974 <BR>
975 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Inserts the value into this builder.</TD>
976 </TR>
977 <TR BGCOLOR="white" CLASS="TableRowColor">
978 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
979 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
980 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#insert(int, java.lang.Object)">insert</A></B>(int&nbsp;index,
981 java.lang.Object&nbsp;obj)</CODE>
983 <BR>
984 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Inserts the string representation of an object into this builder.</TD>
985 </TR>
986 <TR BGCOLOR="white" CLASS="TableRowColor">
987 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
988 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
989 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#insert(int, java.lang.String)">insert</A></B>(int&nbsp;index,
990 java.lang.String&nbsp;str)</CODE>
992 <BR>
993 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Inserts the string into this builder.</TD>
994 </TR>
995 <TR BGCOLOR="white" CLASS="TableRowColor">
996 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
997 <CODE>&nbsp;boolean</CODE></FONT></TD>
998 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#isEmpty()">isEmpty</A></B>()</CODE>
1000 <BR>
1001 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks is the string builder is empty (convenience Collections API style method).</TD>
1002 </TR>
1003 <TR BGCOLOR="white" CLASS="TableRowColor">
1004 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1005 <CODE>&nbsp;int</CODE></FONT></TD>
1006 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#lastIndexOf(char)">lastIndexOf</A></B>(char&nbsp;ch)</CODE>
1008 <BR>
1009 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Searches the string builder to find the last reference to the specified char.</TD>
1010 </TR>
1011 <TR BGCOLOR="white" CLASS="TableRowColor">
1012 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1013 <CODE>&nbsp;int</CODE></FONT></TD>
1014 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#lastIndexOf(char, int)">lastIndexOf</A></B>(char&nbsp;ch,
1015 int&nbsp;startIndex)</CODE>
1017 <BR>
1018 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Searches the string builder to find the last reference to the specified char.</TD>
1019 </TR>
1020 <TR BGCOLOR="white" CLASS="TableRowColor">
1021 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1022 <CODE>&nbsp;int</CODE></FONT></TD>
1023 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#lastIndexOf(java.lang.String)">lastIndexOf</A></B>(java.lang.String&nbsp;str)</CODE>
1025 <BR>
1026 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Searches the string builder to find the last reference to the specified string.</TD>
1027 </TR>
1028 <TR BGCOLOR="white" CLASS="TableRowColor">
1029 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1030 <CODE>&nbsp;int</CODE></FONT></TD>
1031 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#lastIndexOf(java.lang.String, int)">lastIndexOf</A></B>(java.lang.String&nbsp;str,
1032 int&nbsp;startIndex)</CODE>
1034 <BR>
1035 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Searches the string builder to find the last reference to the specified
1036 string starting searching from the given index.</TD>
1037 </TR>
1038 <TR BGCOLOR="white" CLASS="TableRowColor">
1039 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1040 <CODE>&nbsp;int</CODE></FONT></TD>
1041 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#lastIndexOf(org.apache.commons.lang.text.StrMatcher)">lastIndexOf</A></B>(<A HREF="../../../../../org/apache/commons/lang/text/StrMatcher.html" title="class in org.apache.commons.lang.text">StrMatcher</A>&nbsp;matcher)</CODE>
1043 <BR>
1044 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Searches the string builder using the matcher to find the last match.</TD>
1045 </TR>
1046 <TR BGCOLOR="white" CLASS="TableRowColor">
1047 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1048 <CODE>&nbsp;int</CODE></FONT></TD>
1049 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#lastIndexOf(org.apache.commons.lang.text.StrMatcher, int)">lastIndexOf</A></B>(<A HREF="../../../../../org/apache/commons/lang/text/StrMatcher.html" title="class in org.apache.commons.lang.text">StrMatcher</A>&nbsp;matcher,
1050 int&nbsp;startIndex)</CODE>
1052 <BR>
1053 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Searches the string builder using the matcher to find the last
1054 match searching from the given index.</TD>
1055 </TR>
1056 <TR BGCOLOR="white" CLASS="TableRowColor">
1057 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1058 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
1059 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#leftString(int)">leftString</A></B>(int&nbsp;length)</CODE>
1061 <BR>
1062 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Extracts the leftmost characters from the string builder without
1063 throwing an exception.</TD>
1064 </TR>
1065 <TR BGCOLOR="white" CLASS="TableRowColor">
1066 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1067 <CODE>&nbsp;int</CODE></FONT></TD>
1068 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#length()">length</A></B>()</CODE>
1070 <BR>
1071 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the length of the string builder.</TD>
1072 </TR>
1073 <TR BGCOLOR="white" CLASS="TableRowColor">
1074 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1075 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
1076 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#midString(int, int)">midString</A></B>(int&nbsp;index,
1077 int&nbsp;length)</CODE>
1079 <BR>
1080 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Extracts some characters from the middle of the string builder without
1081 throwing an exception.</TD>
1082 </TR>
1083 <TR BGCOLOR="white" CLASS="TableRowColor">
1084 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1085 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
1086 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#minimizeCapacity()">minimizeCapacity</A></B>()</CODE>
1088 <BR>
1089 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Minimizes the capacity to the actual length of the string.</TD>
1090 </TR>
1091 <TR BGCOLOR="white" CLASS="TableRowColor">
1092 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1093 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
1094 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#replace(int, int, java.lang.String)">replace</A></B>(int&nbsp;startIndex,
1095 int&nbsp;endIndex,
1096 java.lang.String&nbsp;replaceStr)</CODE>
1098 <BR>
1099 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Replaces a portion of the string builder with another string.</TD>
1100 </TR>
1101 <TR BGCOLOR="white" CLASS="TableRowColor">
1102 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1103 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
1104 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#replace(org.apache.commons.lang.text.StrMatcher, java.lang.String, int, int, int)">replace</A></B>(<A HREF="../../../../../org/apache/commons/lang/text/StrMatcher.html" title="class in org.apache.commons.lang.text">StrMatcher</A>&nbsp;matcher,
1105 java.lang.String&nbsp;replaceStr,
1106 int&nbsp;startIndex,
1107 int&nbsp;endIndex,
1108 int&nbsp;replaceCount)</CODE>
1110 <BR>
1111 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Advanced search and replaces within the builder using a matcher.</TD>
1112 </TR>
1113 <TR BGCOLOR="white" CLASS="TableRowColor">
1114 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1115 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
1116 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#replaceAll(char, char)">replaceAll</A></B>(char&nbsp;search,
1117 char&nbsp;replace)</CODE>
1119 <BR>
1120 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Replaces the search character with the replace character
1121 throughout the builder.</TD>
1122 </TR>
1123 <TR BGCOLOR="white" CLASS="TableRowColor">
1124 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1125 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
1126 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#replaceAll(java.lang.String, java.lang.String)">replaceAll</A></B>(java.lang.String&nbsp;searchStr,
1127 java.lang.String&nbsp;replaceStr)</CODE>
1129 <BR>
1130 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Replaces the search string with the replace string throughout the builder.</TD>
1131 </TR>
1132 <TR BGCOLOR="white" CLASS="TableRowColor">
1133 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1134 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
1135 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#replaceAll(org.apache.commons.lang.text.StrMatcher, java.lang.String)">replaceAll</A></B>(<A HREF="../../../../../org/apache/commons/lang/text/StrMatcher.html" title="class in org.apache.commons.lang.text">StrMatcher</A>&nbsp;matcher,
1136 java.lang.String&nbsp;replaceStr)</CODE>
1138 <BR>
1139 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Replaces all matches within the builder with the replace string.</TD>
1140 </TR>
1141 <TR BGCOLOR="white" CLASS="TableRowColor">
1142 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1143 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
1144 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#replaceFirst(char, char)">replaceFirst</A></B>(char&nbsp;search,
1145 char&nbsp;replace)</CODE>
1147 <BR>
1148 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Replaces the first instance of the search character with the
1149 replace character in the builder.</TD>
1150 </TR>
1151 <TR BGCOLOR="white" CLASS="TableRowColor">
1152 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1153 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
1154 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#replaceFirst(java.lang.String, java.lang.String)">replaceFirst</A></B>(java.lang.String&nbsp;searchStr,
1155 java.lang.String&nbsp;replaceStr)</CODE>
1157 <BR>
1158 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Replaces the first instance of the search string with the replace string.</TD>
1159 </TR>
1160 <TR BGCOLOR="white" CLASS="TableRowColor">
1161 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1162 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
1163 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#replaceFirst(org.apache.commons.lang.text.StrMatcher, java.lang.String)">replaceFirst</A></B>(<A HREF="../../../../../org/apache/commons/lang/text/StrMatcher.html" title="class in org.apache.commons.lang.text">StrMatcher</A>&nbsp;matcher,
1164 java.lang.String&nbsp;replaceStr)</CODE>
1166 <BR>
1167 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Replaces the first match within the builder with the replace string.</TD>
1168 </TR>
1169 <TR BGCOLOR="white" CLASS="TableRowColor">
1170 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1171 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
1172 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#reverse()">reverse</A></B>()</CODE>
1174 <BR>
1175 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Reverses the string builder placing each character in the opposite index.</TD>
1176 </TR>
1177 <TR BGCOLOR="white" CLASS="TableRowColor">
1178 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1179 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
1180 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#rightString(int)">rightString</A></B>(int&nbsp;length)</CODE>
1182 <BR>
1183 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Extracts the rightmost characters from the string builder without
1184 throwing an exception.</TD>
1185 </TR>
1186 <TR BGCOLOR="white" CLASS="TableRowColor">
1187 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1188 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
1189 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#setCharAt(int, char)">setCharAt</A></B>(int&nbsp;index,
1190 char&nbsp;ch)</CODE>
1192 <BR>
1193 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the character at the specified index.</TD>
1194 </TR>
1195 <TR BGCOLOR="white" CLASS="TableRowColor">
1196 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1197 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
1198 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#setLength(int)">setLength</A></B>(int&nbsp;length)</CODE>
1200 <BR>
1201 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Updates the length of the builder by either dropping the last characters
1202 or adding filler of unicode zero.</TD>
1203 </TR>
1204 <TR BGCOLOR="white" CLASS="TableRowColor">
1205 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1206 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
1207 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#setNewLineText(java.lang.String)">setNewLineText</A></B>(java.lang.String&nbsp;newLine)</CODE>
1209 <BR>
1210 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the text to be appended when a new line is added.</TD>
1211 </TR>
1212 <TR BGCOLOR="white" CLASS="TableRowColor">
1213 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1214 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
1215 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#setNullText(java.lang.String)">setNullText</A></B>(java.lang.String&nbsp;nullText)</CODE>
1217 <BR>
1218 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Sets the text to be appended when null is added.</TD>
1219 </TR>
1220 <TR BGCOLOR="white" CLASS="TableRowColor">
1221 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1222 <CODE>&nbsp;int</CODE></FONT></TD>
1223 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#size()">size</A></B>()</CODE>
1225 <BR>
1226 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets the length of the string builder.</TD>
1227 </TR>
1228 <TR BGCOLOR="white" CLASS="TableRowColor">
1229 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1230 <CODE>&nbsp;boolean</CODE></FONT></TD>
1231 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#startsWith(java.lang.String)">startsWith</A></B>(java.lang.String&nbsp;str)</CODE>
1233 <BR>
1234 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Checks whether this builder starts with the specified string.</TD>
1235 </TR>
1236 <TR BGCOLOR="white" CLASS="TableRowColor">
1237 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1238 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
1239 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#substring(int)">substring</A></B>(int&nbsp;start)</CODE>
1241 <BR>
1242 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Extracts a portion of this string builder as a string.</TD>
1243 </TR>
1244 <TR BGCOLOR="white" CLASS="TableRowColor">
1245 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1246 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
1247 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#substring(int, int)">substring</A></B>(int&nbsp;startIndex,
1248 int&nbsp;endIndex)</CODE>
1250 <BR>
1251 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Extracts a portion of this string builder as a string.</TD>
1252 </TR>
1253 <TR BGCOLOR="white" CLASS="TableRowColor">
1254 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1255 <CODE>&nbsp;char[]</CODE></FONT></TD>
1256 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#toCharArray()">toCharArray</A></B>()</CODE>
1258 <BR>
1259 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Copies the builder's character array into a new character array.</TD>
1260 </TR>
1261 <TR BGCOLOR="white" CLASS="TableRowColor">
1262 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1263 <CODE>&nbsp;char[]</CODE></FONT></TD>
1264 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#toCharArray(int, int)">toCharArray</A></B>(int&nbsp;startIndex,
1265 int&nbsp;endIndex)</CODE>
1267 <BR>
1268 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Copies part of the builder's character array into a new character array.</TD>
1269 </TR>
1270 <TR BGCOLOR="white" CLASS="TableRowColor">
1271 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1272 <CODE>&nbsp;java.lang.String</CODE></FONT></TD>
1273 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#toString()">toString</A></B>()</CODE>
1275 <BR>
1276 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets a String version of the string builder, creating a new instance
1277 each time the method is called.</TD>
1278 </TR>
1279 <TR BGCOLOR="white" CLASS="TableRowColor">
1280 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1281 <CODE>&nbsp;java.lang.StringBuffer</CODE></FONT></TD>
1282 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#toStringBuffer()">toStringBuffer</A></B>()</CODE>
1284 <BR>
1285 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Gets a StringBuffer version of the string builder, creating a
1286 new instance each time the method is called.</TD>
1287 </TR>
1288 <TR BGCOLOR="white" CLASS="TableRowColor">
1289 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1290 <CODE>&nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A></CODE></FONT></TD>
1291 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#trim()">trim</A></B>()</CODE>
1293 <BR>
1294 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Trims the builder by removing characters less than or equal to a space
1295 from the beginning and end.</TD>
1296 </TR>
1297 <TR BGCOLOR="white" CLASS="TableRowColor">
1298 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1299 <CODE>protected &nbsp;void</CODE></FONT></TD>
1300 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#validateIndex(int)">validateIndex</A></B>(int&nbsp;index)</CODE>
1302 <BR>
1303 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Validates parameters defining a single index in the builder.</TD>
1304 </TR>
1305 <TR BGCOLOR="white" CLASS="TableRowColor">
1306 <TD ALIGN="right" VALIGN="top" WIDTH="1%"><FONT SIZE="-1">
1307 <CODE>protected &nbsp;int</CODE></FONT></TD>
1308 <TD><CODE><B><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#validateRange(int, int)">validateRange</A></B>(int&nbsp;startIndex,
1309 int&nbsp;endIndex)</CODE>
1311 <BR>
1312 &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Validates parameters defining a range of the builder.</TD>
1313 </TR>
1314 </TABLE>
1315 &nbsp;<A NAME="methods_inherited_from_class_java.lang.Object"><!-- --></A>
1316 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
1317 <TR BGCOLOR="#EEEEFF" CLASS="TableSubHeadingColor">
1318 <TD><B>Methods inherited from class java.lang.Object</B></TD>
1319 </TR>
1320 <TR BGCOLOR="white" CLASS="TableRowColor">
1321 <TD><CODE>clone, finalize, getClass, notify, notifyAll, wait, wait, wait</CODE></TD>
1322 </TR>
1323 </TABLE>
1324 &nbsp;
1327 <!-- ============ FIELD DETAIL =========== -->
1329 <A NAME="field_detail"><!-- --></A>
1330 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
1331 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
1332 <TD COLSPAN=1><FONT SIZE="+2">
1333 <B>Field Detail</B></FONT></TD>
1334 </TR>
1335 </TABLE>
1337 <A NAME="buffer"><!-- --></A><H3>
1338 buffer</H3>
1339 <PRE>
1340 protected char[] <B>buffer</B></PRE>
1341 <DL>
1342 <DD>Internal data storage.
1344 <DL>
1345 </DL>
1346 </DL>
1347 <HR>
1349 <A NAME="size"><!-- --></A><H3>
1350 size</H3>
1351 <PRE>
1352 protected int <B>size</B></PRE>
1353 <DL>
1354 <DD>Current size of the buffer.
1356 <DL>
1357 </DL>
1358 </DL>
1360 <!-- ========= CONSTRUCTOR DETAIL ======== -->
1362 <A NAME="constructor_detail"><!-- --></A>
1363 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
1364 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
1365 <TD COLSPAN=1><FONT SIZE="+2">
1366 <B>Constructor Detail</B></FONT></TD>
1367 </TR>
1368 </TABLE>
1370 <A NAME="StrBuilder()"><!-- --></A><H3>
1371 StrBuilder</H3>
1372 <PRE>
1373 public <B>StrBuilder</B>()</PRE>
1374 <DL>
1375 <DD>Constructor that creates an empty builder initial capacity 32 characters.
1377 </DL>
1378 <HR>
1380 <A NAME="StrBuilder(int)"><!-- --></A><H3>
1381 StrBuilder</H3>
1382 <PRE>
1383 public <B>StrBuilder</B>(int&nbsp;initialCapacity)</PRE>
1384 <DL>
1385 <DD>Constructor that creates an empty builder the specified initial capacity.
1387 <DT><B>Parameters:</B><DD><CODE>initialCapacity</CODE> - the initial capacity, zero or less will be converted to 32</DL>
1388 <HR>
1390 <A NAME="StrBuilder(java.lang.String)"><!-- --></A><H3>
1391 StrBuilder</H3>
1392 <PRE>
1393 public <B>StrBuilder</B>(java.lang.String&nbsp;str)</PRE>
1394 <DL>
1395 <DD>Constructor that creates a builder from the string, allocating
1396 32 extra characters for growth.
1398 <DT><B>Parameters:</B><DD><CODE>str</CODE> - the string to copy, null treated as blank string</DL>
1400 <!-- ============ METHOD DETAIL ========== -->
1402 <A NAME="method_detail"><!-- --></A>
1403 <TABLE BORDER="1" WIDTH="100%" CELLPADDING="3" CELLSPACING="0" SUMMARY="">
1404 <TR BGCOLOR="#CCCCFF" CLASS="TableHeadingColor">
1405 <TD COLSPAN=1><FONT SIZE="+2">
1406 <B>Method Detail</B></FONT></TD>
1407 </TR>
1408 </TABLE>
1410 <A NAME="getNewLineText()"><!-- --></A><H3>
1411 getNewLineText</H3>
1412 <PRE>
1413 public java.lang.String <B>getNewLineText</B>()</PRE>
1414 <DL>
1415 <DD>Gets the text to be appended when a new line is added.
1417 <DD><DL>
1418 </DL>
1419 </DD>
1420 <DD><DL>
1422 <DT><B>Returns:</B><DD>the new line text, null means use system default</DL>
1423 </DD>
1424 </DL>
1425 <HR>
1427 <A NAME="setNewLineText(java.lang.String)"><!-- --></A><H3>
1428 setNewLineText</H3>
1429 <PRE>
1430 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>setNewLineText</B>(java.lang.String&nbsp;newLine)</PRE>
1431 <DL>
1432 <DD>Sets the text to be appended when a new line is added.
1434 <DD><DL>
1435 </DL>
1436 </DD>
1437 <DD><DL>
1438 <DT><B>Parameters:</B><DD><CODE>newLine</CODE> - the new line text, null means use system default
1439 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
1440 </DD>
1441 </DL>
1442 <HR>
1444 <A NAME="getNullText()"><!-- --></A><H3>
1445 getNullText</H3>
1446 <PRE>
1447 public java.lang.String <B>getNullText</B>()</PRE>
1448 <DL>
1449 <DD>Gets the text to be appended when null is added.
1451 <DD><DL>
1452 </DL>
1453 </DD>
1454 <DD><DL>
1456 <DT><B>Returns:</B><DD>the null text, null means no append</DL>
1457 </DD>
1458 </DL>
1459 <HR>
1461 <A NAME="setNullText(java.lang.String)"><!-- --></A><H3>
1462 setNullText</H3>
1463 <PRE>
1464 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>setNullText</B>(java.lang.String&nbsp;nullText)</PRE>
1465 <DL>
1466 <DD>Sets the text to be appended when null is added.
1468 <DD><DL>
1469 </DL>
1470 </DD>
1471 <DD><DL>
1472 <DT><B>Parameters:</B><DD><CODE>nullText</CODE> - the null text, null means no append
1473 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
1474 </DD>
1475 </DL>
1476 <HR>
1478 <A NAME="length()"><!-- --></A><H3>
1479 length</H3>
1480 <PRE>
1481 public int <B>length</B>()</PRE>
1482 <DL>
1483 <DD>Gets the length of the string builder.
1485 <DD><DL>
1486 </DL>
1487 </DD>
1488 <DD><DL>
1490 <DT><B>Returns:</B><DD>the length</DL>
1491 </DD>
1492 </DL>
1493 <HR>
1495 <A NAME="setLength(int)"><!-- --></A><H3>
1496 setLength</H3>
1497 <PRE>
1498 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>setLength</B>(int&nbsp;length)</PRE>
1499 <DL>
1500 <DD>Updates the length of the builder by either dropping the last characters
1501 or adding filler of unicode zero.
1503 <DD><DL>
1504 </DL>
1505 </DD>
1506 <DD><DL>
1507 <DT><B>Parameters:</B><DD><CODE>length</CODE> - the length to set to, must be zero or positive
1508 <DT><B>Returns:</B><DD>this, to enable chaining
1509 <DT><B>Throws:</B>
1510 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the length is negative</DL>
1511 </DD>
1512 </DL>
1513 <HR>
1515 <A NAME="capacity()"><!-- --></A><H3>
1516 capacity</H3>
1517 <PRE>
1518 public int <B>capacity</B>()</PRE>
1519 <DL>
1520 <DD>Gets the current size of the internal character array buffer.
1522 <DD><DL>
1523 </DL>
1524 </DD>
1525 <DD><DL>
1527 <DT><B>Returns:</B><DD>the capacity</DL>
1528 </DD>
1529 </DL>
1530 <HR>
1532 <A NAME="ensureCapacity(int)"><!-- --></A><H3>
1533 ensureCapacity</H3>
1534 <PRE>
1535 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>ensureCapacity</B>(int&nbsp;capacity)</PRE>
1536 <DL>
1537 <DD>Checks the capacity and ensures that it is at least the size specified.
1539 <DD><DL>
1540 </DL>
1541 </DD>
1542 <DD><DL>
1543 <DT><B>Parameters:</B><DD><CODE>capacity</CODE> - the capacity to ensure
1544 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
1545 </DD>
1546 </DL>
1547 <HR>
1549 <A NAME="minimizeCapacity()"><!-- --></A><H3>
1550 minimizeCapacity</H3>
1551 <PRE>
1552 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>minimizeCapacity</B>()</PRE>
1553 <DL>
1554 <DD>Minimizes the capacity to the actual length of the string.
1556 <DD><DL>
1557 </DL>
1558 </DD>
1559 <DD><DL>
1561 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
1562 </DD>
1563 </DL>
1564 <HR>
1566 <A NAME="size()"><!-- --></A><H3>
1567 size</H3>
1568 <PRE>
1569 public int <B>size</B>()</PRE>
1570 <DL>
1571 <DD>Gets the length of the string builder.
1573 This method is the same as <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#length()"><CODE>length()</CODE></A> and is provided to match the
1574 API of Collections.
1576 <DD><DL>
1577 </DL>
1578 </DD>
1579 <DD><DL>
1581 <DT><B>Returns:</B><DD>the length</DL>
1582 </DD>
1583 </DL>
1584 <HR>
1586 <A NAME="isEmpty()"><!-- --></A><H3>
1587 isEmpty</H3>
1588 <PRE>
1589 public boolean <B>isEmpty</B>()</PRE>
1590 <DL>
1591 <DD>Checks is the string builder is empty (convenience Collections API style method).
1593 This method is the same as checking <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#length()"><CODE>length()</CODE></A> and is provided to match the
1594 API of Collections.
1596 <DD><DL>
1597 </DL>
1598 </DD>
1599 <DD><DL>
1601 <DT><B>Returns:</B><DD><code>true</code> if the size is <code>0</code>.</DL>
1602 </DD>
1603 </DL>
1604 <HR>
1606 <A NAME="clear()"><!-- --></A><H3>
1607 clear</H3>
1608 <PRE>
1609 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>clear</B>()</PRE>
1610 <DL>
1611 <DD>Clears the string builder (convenience Collections API style method).
1613 This method does not reduce the size of the internal character buffer.
1614 To do that, call <code>clear()</code> followed by <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#minimizeCapacity()"><CODE>minimizeCapacity()</CODE></A>.
1616 This method is the same as <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#setLength(int)"><CODE>setLength(int)</CODE></A> called with zero
1617 and is provided to match the API of Collections.
1619 <DD><DL>
1620 </DL>
1621 </DD>
1622 <DD><DL>
1624 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
1625 </DD>
1626 </DL>
1627 <HR>
1629 <A NAME="charAt(int)"><!-- --></A><H3>
1630 charAt</H3>
1631 <PRE>
1632 public char <B>charAt</B>(int&nbsp;index)</PRE>
1633 <DL>
1634 <DD>Gets the character at the specified index.
1636 <DD><DL>
1637 </DL>
1638 </DD>
1639 <DD><DL>
1640 <DT><B>Parameters:</B><DD><CODE>index</CODE> - the index to retrieve, must be valid
1641 <DT><B>Returns:</B><DD>the character at the index
1642 <DT><B>Throws:</B>
1643 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the index is invalid<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#setCharAt(int, char)"><CODE>setCharAt(int, char)</CODE></A>,
1644 <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#deleteCharAt(int)"><CODE>deleteCharAt(int)</CODE></A></DL>
1645 </DD>
1646 </DL>
1647 <HR>
1649 <A NAME="setCharAt(int, char)"><!-- --></A><H3>
1650 setCharAt</H3>
1651 <PRE>
1652 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>setCharAt</B>(int&nbsp;index,
1653 char&nbsp;ch)</PRE>
1654 <DL>
1655 <DD>Sets the character at the specified index.
1657 <DD><DL>
1658 </DL>
1659 </DD>
1660 <DD><DL>
1661 <DT><B>Parameters:</B><DD><CODE>index</CODE> - the index to set<DD><CODE>ch</CODE> - the new character
1662 <DT><B>Returns:</B><DD>this, to enable chaining
1663 <DT><B>Throws:</B>
1664 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the index is invalid<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#charAt(int)"><CODE>charAt(int)</CODE></A>,
1665 <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#deleteCharAt(int)"><CODE>deleteCharAt(int)</CODE></A></DL>
1666 </DD>
1667 </DL>
1668 <HR>
1670 <A NAME="deleteCharAt(int)"><!-- --></A><H3>
1671 deleteCharAt</H3>
1672 <PRE>
1673 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>deleteCharAt</B>(int&nbsp;index)</PRE>
1674 <DL>
1675 <DD>Deletes the character at the specified index.
1677 <DD><DL>
1678 </DL>
1679 </DD>
1680 <DD><DL>
1681 <DT><B>Parameters:</B><DD><CODE>index</CODE> - the index to delete
1682 <DT><B>Returns:</B><DD>this, to enable chaining
1683 <DT><B>Throws:</B>
1684 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the index is invalid<DT><B>See Also:</B><DD><A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#charAt(int)"><CODE>charAt(int)</CODE></A>,
1685 <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#setCharAt(int, char)"><CODE>setCharAt(int, char)</CODE></A></DL>
1686 </DD>
1687 </DL>
1688 <HR>
1690 <A NAME="toCharArray()"><!-- --></A><H3>
1691 toCharArray</H3>
1692 <PRE>
1693 public char[] <B>toCharArray</B>()</PRE>
1694 <DL>
1695 <DD>Copies the builder's character array into a new character array.
1697 <DD><DL>
1698 </DL>
1699 </DD>
1700 <DD><DL>
1702 <DT><B>Returns:</B><DD>a new array that represents the contents of the builder</DL>
1703 </DD>
1704 </DL>
1705 <HR>
1707 <A NAME="toCharArray(int, int)"><!-- --></A><H3>
1708 toCharArray</H3>
1709 <PRE>
1710 public char[] <B>toCharArray</B>(int&nbsp;startIndex,
1711 int&nbsp;endIndex)</PRE>
1712 <DL>
1713 <DD>Copies part of the builder's character array into a new character array.
1715 <DD><DL>
1716 </DL>
1717 </DD>
1718 <DD><DL>
1719 <DT><B>Parameters:</B><DD><CODE>startIndex</CODE> - the start index, inclusive, must be valid<DD><CODE>endIndex</CODE> - the end index, exclusive, must be valid except that
1720 if too large it is treated as end of string
1721 <DT><B>Returns:</B><DD>a new array that holds part of the contents of the builder
1722 <DT><B>Throws:</B>
1723 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if startIndex is invalid,
1724 or if endIndex is invalid (but endIndex greater than size is valid)</DL>
1725 </DD>
1726 </DL>
1727 <HR>
1729 <A NAME="getChars(char[])"><!-- --></A><H3>
1730 getChars</H3>
1731 <PRE>
1732 public char[] <B>getChars</B>(char[]&nbsp;destination)</PRE>
1733 <DL>
1734 <DD>Copies the character array into the specified array.
1736 <DD><DL>
1737 </DL>
1738 </DD>
1739 <DD><DL>
1740 <DT><B>Parameters:</B><DD><CODE>destination</CODE> - the destination array, null will cause an array to be created
1741 <DT><B>Returns:</B><DD>the input array, unless that was null or too small</DL>
1742 </DD>
1743 </DL>
1744 <HR>
1746 <A NAME="getChars(int, int, char[], int)"><!-- --></A><H3>
1747 getChars</H3>
1748 <PRE>
1749 public void <B>getChars</B>(int&nbsp;startIndex,
1750 int&nbsp;endIndex,
1751 char[]&nbsp;destination,
1752 int&nbsp;destinationIndex)</PRE>
1753 <DL>
1754 <DD>Copies the character array into the specified array.
1756 <DD><DL>
1757 </DL>
1758 </DD>
1759 <DD><DL>
1760 <DT><B>Parameters:</B><DD><CODE>startIndex</CODE> - first index to copy, inclusive, must be valid<DD><CODE>endIndex</CODE> - last index, exclusive, must be valid<DD><CODE>destination</CODE> - the destination array, must not be null or too small<DD><CODE>destinationIndex</CODE> - the index to start copying in destination
1761 <DT><B>Throws:</B>
1762 <DD><CODE>java.lang.NullPointerException</CODE> - if the array is null
1763 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if any index is invalid</DL>
1764 </DD>
1765 </DL>
1766 <HR>
1768 <A NAME="appendNewLine()"><!-- --></A><H3>
1769 appendNewLine</H3>
1770 <PRE>
1771 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendNewLine</B>()</PRE>
1772 <DL>
1773 <DD>Appends the new line string to this string builder.
1775 The new line string can be altered using <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#setNewLineText(java.lang.String)"><CODE>setNewLineText(String)</CODE></A>.
1776 This might be used to force the output to always use Unix line endings
1777 even when on Windows.
1779 <DD><DL>
1780 </DL>
1781 </DD>
1782 <DD><DL>
1784 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
1785 </DD>
1786 </DL>
1787 <HR>
1789 <A NAME="appendNull()"><!-- --></A><H3>
1790 appendNull</H3>
1791 <PRE>
1792 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendNull</B>()</PRE>
1793 <DL>
1794 <DD>Appends the text representing <code>null</code> to this string builder.
1796 <DD><DL>
1797 </DL>
1798 </DD>
1799 <DD><DL>
1801 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
1802 </DD>
1803 </DL>
1804 <HR>
1806 <A NAME="append(java.lang.Object)"><!-- --></A><H3>
1807 append</H3>
1808 <PRE>
1809 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>append</B>(java.lang.Object&nbsp;obj)</PRE>
1810 <DL>
1811 <DD>Appends an object to this string builder.
1812 Appending null will call <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendNull()"><CODE>appendNull()</CODE></A>.
1814 <DD><DL>
1815 </DL>
1816 </DD>
1817 <DD><DL>
1818 <DT><B>Parameters:</B><DD><CODE>obj</CODE> - the object to append
1819 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
1820 </DD>
1821 </DL>
1822 <HR>
1824 <A NAME="append(java.lang.String)"><!-- --></A><H3>
1825 append</H3>
1826 <PRE>
1827 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>append</B>(java.lang.String&nbsp;str)</PRE>
1828 <DL>
1829 <DD>Appends a string to this string builder.
1830 Appending null will call <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendNull()"><CODE>appendNull()</CODE></A>.
1832 <DD><DL>
1833 </DL>
1834 </DD>
1835 <DD><DL>
1836 <DT><B>Parameters:</B><DD><CODE>str</CODE> - the string to append
1837 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
1838 </DD>
1839 </DL>
1840 <HR>
1842 <A NAME="append(java.lang.String, int, int)"><!-- --></A><H3>
1843 append</H3>
1844 <PRE>
1845 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>append</B>(java.lang.String&nbsp;str,
1846 int&nbsp;startIndex,
1847 int&nbsp;length)</PRE>
1848 <DL>
1849 <DD>Appends part of a string to this string builder.
1850 Appending null will call <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendNull()"><CODE>appendNull()</CODE></A>.
1852 <DD><DL>
1853 </DL>
1854 </DD>
1855 <DD><DL>
1856 <DT><B>Parameters:</B><DD><CODE>str</CODE> - the string to append<DD><CODE>startIndex</CODE> - the start index, inclusive, must be valid<DD><CODE>length</CODE> - the length to append, must be valid
1857 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
1858 </DD>
1859 </DL>
1860 <HR>
1862 <A NAME="append(java.lang.StringBuffer)"><!-- --></A><H3>
1863 append</H3>
1864 <PRE>
1865 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>append</B>(java.lang.StringBuffer&nbsp;str)</PRE>
1866 <DL>
1867 <DD>Appends a string buffer to this string builder.
1868 Appending null will call <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendNull()"><CODE>appendNull()</CODE></A>.
1870 <DD><DL>
1871 </DL>
1872 </DD>
1873 <DD><DL>
1874 <DT><B>Parameters:</B><DD><CODE>str</CODE> - the string buffer to append
1875 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
1876 </DD>
1877 </DL>
1878 <HR>
1880 <A NAME="append(java.lang.StringBuffer, int, int)"><!-- --></A><H3>
1881 append</H3>
1882 <PRE>
1883 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>append</B>(java.lang.StringBuffer&nbsp;str,
1884 int&nbsp;startIndex,
1885 int&nbsp;length)</PRE>
1886 <DL>
1887 <DD>Appends part of a string buffer to this string builder.
1888 Appending null will call <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendNull()"><CODE>appendNull()</CODE></A>.
1890 <DD><DL>
1891 </DL>
1892 </DD>
1893 <DD><DL>
1894 <DT><B>Parameters:</B><DD><CODE>str</CODE> - the string to append<DD><CODE>startIndex</CODE> - the start index, inclusive, must be valid<DD><CODE>length</CODE> - the length to append, must be valid
1895 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
1896 </DD>
1897 </DL>
1898 <HR>
1900 <A NAME="append(org.apache.commons.lang.text.StrBuilder)"><!-- --></A><H3>
1901 append</H3>
1902 <PRE>
1903 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>append</B>(<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A>&nbsp;str)</PRE>
1904 <DL>
1905 <DD>Appends another string builder to this string builder.
1906 Appending null will call <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendNull()"><CODE>appendNull()</CODE></A>.
1908 <DD><DL>
1909 </DL>
1910 </DD>
1911 <DD><DL>
1912 <DT><B>Parameters:</B><DD><CODE>str</CODE> - the string builder to append
1913 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
1914 </DD>
1915 </DL>
1916 <HR>
1918 <A NAME="append(org.apache.commons.lang.text.StrBuilder, int, int)"><!-- --></A><H3>
1919 append</H3>
1920 <PRE>
1921 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>append</B>(<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A>&nbsp;str,
1922 int&nbsp;startIndex,
1923 int&nbsp;length)</PRE>
1924 <DL>
1925 <DD>Appends part of a string builder to this string builder.
1926 Appending null will call <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendNull()"><CODE>appendNull()</CODE></A>.
1928 <DD><DL>
1929 </DL>
1930 </DD>
1931 <DD><DL>
1932 <DT><B>Parameters:</B><DD><CODE>str</CODE> - the string to append<DD><CODE>startIndex</CODE> - the start index, inclusive, must be valid<DD><CODE>length</CODE> - the length to append, must be valid
1933 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
1934 </DD>
1935 </DL>
1936 <HR>
1938 <A NAME="append(char[])"><!-- --></A><H3>
1939 append</H3>
1940 <PRE>
1941 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>append</B>(char[]&nbsp;chars)</PRE>
1942 <DL>
1943 <DD>Appends a char array to the string builder.
1944 Appending null will call <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendNull()"><CODE>appendNull()</CODE></A>.
1946 <DD><DL>
1947 </DL>
1948 </DD>
1949 <DD><DL>
1950 <DT><B>Parameters:</B><DD><CODE>chars</CODE> - the char array to append
1951 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
1952 </DD>
1953 </DL>
1954 <HR>
1956 <A NAME="append(char[], int, int)"><!-- --></A><H3>
1957 append</H3>
1958 <PRE>
1959 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>append</B>(char[]&nbsp;chars,
1960 int&nbsp;startIndex,
1961 int&nbsp;length)</PRE>
1962 <DL>
1963 <DD>Appends a char array to the string builder.
1964 Appending null will call <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendNull()"><CODE>appendNull()</CODE></A>.
1966 <DD><DL>
1967 </DL>
1968 </DD>
1969 <DD><DL>
1970 <DT><B>Parameters:</B><DD><CODE>chars</CODE> - the char array to append<DD><CODE>startIndex</CODE> - the start index, inclusive, must be valid<DD><CODE>length</CODE> - the length to append, must be valid
1971 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
1972 </DD>
1973 </DL>
1974 <HR>
1976 <A NAME="append(boolean)"><!-- --></A><H3>
1977 append</H3>
1978 <PRE>
1979 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>append</B>(boolean&nbsp;value)</PRE>
1980 <DL>
1981 <DD>Appends a boolean value to the string builder.
1983 <DD><DL>
1984 </DL>
1985 </DD>
1986 <DD><DL>
1987 <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to append
1988 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
1989 </DD>
1990 </DL>
1991 <HR>
1993 <A NAME="append(char)"><!-- --></A><H3>
1994 append</H3>
1995 <PRE>
1996 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>append</B>(char&nbsp;ch)</PRE>
1997 <DL>
1998 <DD>Appends a char value to the string builder.
2000 <DD><DL>
2001 </DL>
2002 </DD>
2003 <DD><DL>
2004 <DT><B>Parameters:</B><DD><CODE>ch</CODE> - the value to append
2005 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
2006 </DD>
2007 </DL>
2008 <HR>
2010 <A NAME="append(int)"><!-- --></A><H3>
2011 append</H3>
2012 <PRE>
2013 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>append</B>(int&nbsp;value)</PRE>
2014 <DL>
2015 <DD>Appends an int value to the string builder using <code>String.valueOf</code>.
2017 <DD><DL>
2018 </DL>
2019 </DD>
2020 <DD><DL>
2021 <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to append
2022 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
2023 </DD>
2024 </DL>
2025 <HR>
2027 <A NAME="append(long)"><!-- --></A><H3>
2028 append</H3>
2029 <PRE>
2030 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>append</B>(long&nbsp;value)</PRE>
2031 <DL>
2032 <DD>Appends a long value to the string builder using <code>String.valueOf</code>.
2034 <DD><DL>
2035 </DL>
2036 </DD>
2037 <DD><DL>
2038 <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to append
2039 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
2040 </DD>
2041 </DL>
2042 <HR>
2044 <A NAME="append(float)"><!-- --></A><H3>
2045 append</H3>
2046 <PRE>
2047 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>append</B>(float&nbsp;value)</PRE>
2048 <DL>
2049 <DD>Appends a float value to the string builder using <code>String.valueOf</code>.
2051 <DD><DL>
2052 </DL>
2053 </DD>
2054 <DD><DL>
2055 <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to append
2056 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
2057 </DD>
2058 </DL>
2059 <HR>
2061 <A NAME="append(double)"><!-- --></A><H3>
2062 append</H3>
2063 <PRE>
2064 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>append</B>(double&nbsp;value)</PRE>
2065 <DL>
2066 <DD>Appends a double value to the string builder using <code>String.valueOf</code>.
2068 <DD><DL>
2069 </DL>
2070 </DD>
2071 <DD><DL>
2072 <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to append
2073 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
2074 </DD>
2075 </DL>
2076 <HR>
2078 <A NAME="appendln(java.lang.Object)"><!-- --></A><H3>
2079 appendln</H3>
2080 <PRE>
2081 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendln</B>(java.lang.Object&nbsp;obj)</PRE>
2082 <DL>
2083 <DD>Appends an object followed by a new line to this string builder.
2084 Appending null will call <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendNull()"><CODE>appendNull()</CODE></A>.
2086 <DD><DL>
2087 </DL>
2088 </DD>
2089 <DD><DL>
2090 <DT><B>Parameters:</B><DD><CODE>obj</CODE> - the object to append
2091 <DT><B>Returns:</B><DD>this, to enable chaining<DT><B>Since:</B></DT>
2092 <DD>2.3</DD>
2093 </DL>
2094 </DD>
2095 </DL>
2096 <HR>
2098 <A NAME="appendln(java.lang.String)"><!-- --></A><H3>
2099 appendln</H3>
2100 <PRE>
2101 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendln</B>(java.lang.String&nbsp;str)</PRE>
2102 <DL>
2103 <DD>Appends a string followed by a new line to this string builder.
2104 Appending null will call <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendNull()"><CODE>appendNull()</CODE></A>.
2106 <DD><DL>
2107 </DL>
2108 </DD>
2109 <DD><DL>
2110 <DT><B>Parameters:</B><DD><CODE>str</CODE> - the string to append
2111 <DT><B>Returns:</B><DD>this, to enable chaining<DT><B>Since:</B></DT>
2112 <DD>2.3</DD>
2113 </DL>
2114 </DD>
2115 </DL>
2116 <HR>
2118 <A NAME="appendln(java.lang.String, int, int)"><!-- --></A><H3>
2119 appendln</H3>
2120 <PRE>
2121 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendln</B>(java.lang.String&nbsp;str,
2122 int&nbsp;startIndex,
2123 int&nbsp;length)</PRE>
2124 <DL>
2125 <DD>Appends part of a string followed by a new line to this string builder.
2126 Appending null will call <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendNull()"><CODE>appendNull()</CODE></A>.
2128 <DD><DL>
2129 </DL>
2130 </DD>
2131 <DD><DL>
2132 <DT><B>Parameters:</B><DD><CODE>str</CODE> - the string to append<DD><CODE>startIndex</CODE> - the start index, inclusive, must be valid<DD><CODE>length</CODE> - the length to append, must be valid
2133 <DT><B>Returns:</B><DD>this, to enable chaining<DT><B>Since:</B></DT>
2134 <DD>2.3</DD>
2135 </DL>
2136 </DD>
2137 </DL>
2138 <HR>
2140 <A NAME="appendln(java.lang.StringBuffer)"><!-- --></A><H3>
2141 appendln</H3>
2142 <PRE>
2143 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendln</B>(java.lang.StringBuffer&nbsp;str)</PRE>
2144 <DL>
2145 <DD>Appends a string buffer followed by a new line to this string builder.
2146 Appending null will call <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendNull()"><CODE>appendNull()</CODE></A>.
2148 <DD><DL>
2149 </DL>
2150 </DD>
2151 <DD><DL>
2152 <DT><B>Parameters:</B><DD><CODE>str</CODE> - the string buffer to append
2153 <DT><B>Returns:</B><DD>this, to enable chaining<DT><B>Since:</B></DT>
2154 <DD>2.3</DD>
2155 </DL>
2156 </DD>
2157 </DL>
2158 <HR>
2160 <A NAME="appendln(java.lang.StringBuffer, int, int)"><!-- --></A><H3>
2161 appendln</H3>
2162 <PRE>
2163 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendln</B>(java.lang.StringBuffer&nbsp;str,
2164 int&nbsp;startIndex,
2165 int&nbsp;length)</PRE>
2166 <DL>
2167 <DD>Appends part of a string buffer followed by a new line to this string builder.
2168 Appending null will call <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendNull()"><CODE>appendNull()</CODE></A>.
2170 <DD><DL>
2171 </DL>
2172 </DD>
2173 <DD><DL>
2174 <DT><B>Parameters:</B><DD><CODE>str</CODE> - the string to append<DD><CODE>startIndex</CODE> - the start index, inclusive, must be valid<DD><CODE>length</CODE> - the length to append, must be valid
2175 <DT><B>Returns:</B><DD>this, to enable chaining<DT><B>Since:</B></DT>
2176 <DD>2.3</DD>
2177 </DL>
2178 </DD>
2179 </DL>
2180 <HR>
2182 <A NAME="appendln(org.apache.commons.lang.text.StrBuilder)"><!-- --></A><H3>
2183 appendln</H3>
2184 <PRE>
2185 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendln</B>(<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A>&nbsp;str)</PRE>
2186 <DL>
2187 <DD>Appends another string builder followed by a new line to this string builder.
2188 Appending null will call <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendNull()"><CODE>appendNull()</CODE></A>.
2190 <DD><DL>
2191 </DL>
2192 </DD>
2193 <DD><DL>
2194 <DT><B>Parameters:</B><DD><CODE>str</CODE> - the string builder to append
2195 <DT><B>Returns:</B><DD>this, to enable chaining<DT><B>Since:</B></DT>
2196 <DD>2.3</DD>
2197 </DL>
2198 </DD>
2199 </DL>
2200 <HR>
2202 <A NAME="appendln(org.apache.commons.lang.text.StrBuilder, int, int)"><!-- --></A><H3>
2203 appendln</H3>
2204 <PRE>
2205 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendln</B>(<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A>&nbsp;str,
2206 int&nbsp;startIndex,
2207 int&nbsp;length)</PRE>
2208 <DL>
2209 <DD>Appends part of a string builder followed by a new line to this string builder.
2210 Appending null will call <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendNull()"><CODE>appendNull()</CODE></A>.
2212 <DD><DL>
2213 </DL>
2214 </DD>
2215 <DD><DL>
2216 <DT><B>Parameters:</B><DD><CODE>str</CODE> - the string to append<DD><CODE>startIndex</CODE> - the start index, inclusive, must be valid<DD><CODE>length</CODE> - the length to append, must be valid
2217 <DT><B>Returns:</B><DD>this, to enable chaining<DT><B>Since:</B></DT>
2218 <DD>2.3</DD>
2219 </DL>
2220 </DD>
2221 </DL>
2222 <HR>
2224 <A NAME="appendln(char[])"><!-- --></A><H3>
2225 appendln</H3>
2226 <PRE>
2227 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendln</B>(char[]&nbsp;chars)</PRE>
2228 <DL>
2229 <DD>Appends a char array followed by a new line to the string builder.
2230 Appending null will call <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendNull()"><CODE>appendNull()</CODE></A>.
2232 <DD><DL>
2233 </DL>
2234 </DD>
2235 <DD><DL>
2236 <DT><B>Parameters:</B><DD><CODE>chars</CODE> - the char array to append
2237 <DT><B>Returns:</B><DD>this, to enable chaining<DT><B>Since:</B></DT>
2238 <DD>2.3</DD>
2239 </DL>
2240 </DD>
2241 </DL>
2242 <HR>
2244 <A NAME="appendln(char[], int, int)"><!-- --></A><H3>
2245 appendln</H3>
2246 <PRE>
2247 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendln</B>(char[]&nbsp;chars,
2248 int&nbsp;startIndex,
2249 int&nbsp;length)</PRE>
2250 <DL>
2251 <DD>Appends a char array followed by a new line to the string builder.
2252 Appending null will call <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendNull()"><CODE>appendNull()</CODE></A>.
2254 <DD><DL>
2255 </DL>
2256 </DD>
2257 <DD><DL>
2258 <DT><B>Parameters:</B><DD><CODE>chars</CODE> - the char array to append<DD><CODE>startIndex</CODE> - the start index, inclusive, must be valid<DD><CODE>length</CODE> - the length to append, must be valid
2259 <DT><B>Returns:</B><DD>this, to enable chaining<DT><B>Since:</B></DT>
2260 <DD>2.3</DD>
2261 </DL>
2262 </DD>
2263 </DL>
2264 <HR>
2266 <A NAME="appendln(boolean)"><!-- --></A><H3>
2267 appendln</H3>
2268 <PRE>
2269 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendln</B>(boolean&nbsp;value)</PRE>
2270 <DL>
2271 <DD>Appends a boolean value followed by a new line to the string builder.
2273 <DD><DL>
2274 </DL>
2275 </DD>
2276 <DD><DL>
2277 <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to append
2278 <DT><B>Returns:</B><DD>this, to enable chaining<DT><B>Since:</B></DT>
2279 <DD>2.3</DD>
2280 </DL>
2281 </DD>
2282 </DL>
2283 <HR>
2285 <A NAME="appendln(char)"><!-- --></A><H3>
2286 appendln</H3>
2287 <PRE>
2288 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendln</B>(char&nbsp;ch)</PRE>
2289 <DL>
2290 <DD>Appends a char value followed by a new line to the string builder.
2292 <DD><DL>
2293 </DL>
2294 </DD>
2295 <DD><DL>
2296 <DT><B>Parameters:</B><DD><CODE>ch</CODE> - the value to append
2297 <DT><B>Returns:</B><DD>this, to enable chaining<DT><B>Since:</B></DT>
2298 <DD>2.3</DD>
2299 </DL>
2300 </DD>
2301 </DL>
2302 <HR>
2304 <A NAME="appendln(int)"><!-- --></A><H3>
2305 appendln</H3>
2306 <PRE>
2307 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendln</B>(int&nbsp;value)</PRE>
2308 <DL>
2309 <DD>Appends an int value followed by a new line to the string builder using <code>String.valueOf</code>.
2311 <DD><DL>
2312 </DL>
2313 </DD>
2314 <DD><DL>
2315 <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to append
2316 <DT><B>Returns:</B><DD>this, to enable chaining<DT><B>Since:</B></DT>
2317 <DD>2.3</DD>
2318 </DL>
2319 </DD>
2320 </DL>
2321 <HR>
2323 <A NAME="appendln(long)"><!-- --></A><H3>
2324 appendln</H3>
2325 <PRE>
2326 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendln</B>(long&nbsp;value)</PRE>
2327 <DL>
2328 <DD>Appends a long value followed by a new line to the string builder using <code>String.valueOf</code>.
2330 <DD><DL>
2331 </DL>
2332 </DD>
2333 <DD><DL>
2334 <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to append
2335 <DT><B>Returns:</B><DD>this, to enable chaining<DT><B>Since:</B></DT>
2336 <DD>2.3</DD>
2337 </DL>
2338 </DD>
2339 </DL>
2340 <HR>
2342 <A NAME="appendln(float)"><!-- --></A><H3>
2343 appendln</H3>
2344 <PRE>
2345 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendln</B>(float&nbsp;value)</PRE>
2346 <DL>
2347 <DD>Appends a float value followed by a new line to the string builder using <code>String.valueOf</code>.
2349 <DD><DL>
2350 </DL>
2351 </DD>
2352 <DD><DL>
2353 <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to append
2354 <DT><B>Returns:</B><DD>this, to enable chaining<DT><B>Since:</B></DT>
2355 <DD>2.3</DD>
2356 </DL>
2357 </DD>
2358 </DL>
2359 <HR>
2361 <A NAME="appendln(double)"><!-- --></A><H3>
2362 appendln</H3>
2363 <PRE>
2364 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendln</B>(double&nbsp;value)</PRE>
2365 <DL>
2366 <DD>Appends a double value followed by a new line to the string builder using <code>String.valueOf</code>.
2368 <DD><DL>
2369 </DL>
2370 </DD>
2371 <DD><DL>
2372 <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to append
2373 <DT><B>Returns:</B><DD>this, to enable chaining<DT><B>Since:</B></DT>
2374 <DD>2.3</DD>
2375 </DL>
2376 </DD>
2377 </DL>
2378 <HR>
2380 <A NAME="appendAll(java.lang.Object[])"><!-- --></A><H3>
2381 appendAll</H3>
2382 <PRE>
2383 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendAll</B>(java.lang.Object[]&nbsp;array)</PRE>
2384 <DL>
2385 <DD>Appends each item in an array to the builder without any separators.
2386 Appending a null array will have no effect.
2387 Each object is appended using <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(java.lang.Object)"><CODE>append(Object)</CODE></A>.
2389 <DD><DL>
2390 </DL>
2391 </DD>
2392 <DD><DL>
2393 <DT><B>Parameters:</B><DD><CODE>array</CODE> - the array to append
2394 <DT><B>Returns:</B><DD>this, to enable chaining<DT><B>Since:</B></DT>
2395 <DD>2.3</DD>
2396 </DL>
2397 </DD>
2398 </DL>
2399 <HR>
2401 <A NAME="appendAll(java.util.Collection)"><!-- --></A><H3>
2402 appendAll</H3>
2403 <PRE>
2404 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendAll</B>(java.util.Collection&nbsp;coll)</PRE>
2405 <DL>
2406 <DD>Appends each item in a collection to the builder without any separators.
2407 Appending a null collection will have no effect.
2408 Each object is appended using <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(java.lang.Object)"><CODE>append(Object)</CODE></A>.
2410 <DD><DL>
2411 </DL>
2412 </DD>
2413 <DD><DL>
2414 <DT><B>Parameters:</B><DD><CODE>coll</CODE> - the collection to append
2415 <DT><B>Returns:</B><DD>this, to enable chaining<DT><B>Since:</B></DT>
2416 <DD>2.3</DD>
2417 </DL>
2418 </DD>
2419 </DL>
2420 <HR>
2422 <A NAME="appendAll(java.util.Iterator)"><!-- --></A><H3>
2423 appendAll</H3>
2424 <PRE>
2425 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendAll</B>(java.util.Iterator&nbsp;it)</PRE>
2426 <DL>
2427 <DD>Appends each item in an iterator to the builder without any separators.
2428 Appending a null iterator will have no effect.
2429 Each object is appended using <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(java.lang.Object)"><CODE>append(Object)</CODE></A>.
2431 <DD><DL>
2432 </DL>
2433 </DD>
2434 <DD><DL>
2435 <DT><B>Parameters:</B><DD><CODE>it</CODE> - the iterator to append
2436 <DT><B>Returns:</B><DD>this, to enable chaining<DT><B>Since:</B></DT>
2437 <DD>2.3</DD>
2438 </DL>
2439 </DD>
2440 </DL>
2441 <HR>
2443 <A NAME="appendWithSeparators(java.lang.Object[], java.lang.String)"><!-- --></A><H3>
2444 appendWithSeparators</H3>
2445 <PRE>
2446 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendWithSeparators</B>(java.lang.Object[]&nbsp;array,
2447 java.lang.String&nbsp;separator)</PRE>
2448 <DL>
2449 <DD>Appends an array placing separators between each value, but
2450 not before the first or after the last.
2451 Appending a null array will have no effect.
2452 Each object is appended using <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(java.lang.Object)"><CODE>append(Object)</CODE></A>.
2454 <DD><DL>
2455 </DL>
2456 </DD>
2457 <DD><DL>
2458 <DT><B>Parameters:</B><DD><CODE>array</CODE> - the array to append<DD><CODE>separator</CODE> - the separator to use, null means no separator
2459 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
2460 </DD>
2461 </DL>
2462 <HR>
2464 <A NAME="appendWithSeparators(java.util.Collection, java.lang.String)"><!-- --></A><H3>
2465 appendWithSeparators</H3>
2466 <PRE>
2467 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendWithSeparators</B>(java.util.Collection&nbsp;coll,
2468 java.lang.String&nbsp;separator)</PRE>
2469 <DL>
2470 <DD>Appends a collection placing separators between each value, but
2471 not before the first or after the last.
2472 Appending a null collection will have no effect.
2473 Each object is appended using <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(java.lang.Object)"><CODE>append(Object)</CODE></A>.
2475 <DD><DL>
2476 </DL>
2477 </DD>
2478 <DD><DL>
2479 <DT><B>Parameters:</B><DD><CODE>coll</CODE> - the collection to append<DD><CODE>separator</CODE> - the separator to use, null means no separator
2480 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
2481 </DD>
2482 </DL>
2483 <HR>
2485 <A NAME="appendWithSeparators(java.util.Iterator, java.lang.String)"><!-- --></A><H3>
2486 appendWithSeparators</H3>
2487 <PRE>
2488 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendWithSeparators</B>(java.util.Iterator&nbsp;it,
2489 java.lang.String&nbsp;separator)</PRE>
2490 <DL>
2491 <DD>Appends an iterator placing separators between each value, but
2492 not before the first or after the last.
2493 Appending a null iterator will have no effect.
2494 Each object is appended using <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(java.lang.Object)"><CODE>append(Object)</CODE></A>.
2496 <DD><DL>
2497 </DL>
2498 </DD>
2499 <DD><DL>
2500 <DT><B>Parameters:</B><DD><CODE>it</CODE> - the iterator to append<DD><CODE>separator</CODE> - the separator to use, null means no separator
2501 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
2502 </DD>
2503 </DL>
2504 <HR>
2506 <A NAME="appendSeparator(java.lang.String)"><!-- --></A><H3>
2507 appendSeparator</H3>
2508 <PRE>
2509 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendSeparator</B>(java.lang.String&nbsp;separator)</PRE>
2510 <DL>
2511 <DD>Appends a separator if the builder is currently non-empty.
2512 Appending a null separator will have no effect.
2513 The separator is appended using <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(java.lang.String)"><CODE>append(String)</CODE></A>.
2515 This method is useful for adding a separator each time around the
2516 loop except the first.
2517 <pre>
2518 for (Iterator it = list.iterator(); it.hasNext(); ) {
2519 appendSeparator(",");
2520 append(it.next());
2522 </pre>
2523 Note that for this simple example, you should use
2524 <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendWithSeparators(java.util.Collection, java.lang.String)"><CODE>appendWithSeparators(Collection, String)</CODE></A>.
2526 <DD><DL>
2527 </DL>
2528 </DD>
2529 <DD><DL>
2530 <DT><B>Parameters:</B><DD><CODE>separator</CODE> - the separator to use, null means no separator
2531 <DT><B>Returns:</B><DD>this, to enable chaining<DT><B>Since:</B></DT>
2532 <DD>2.3</DD>
2533 </DL>
2534 </DD>
2535 </DL>
2536 <HR>
2538 <A NAME="appendSeparator(char)"><!-- --></A><H3>
2539 appendSeparator</H3>
2540 <PRE>
2541 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendSeparator</B>(char&nbsp;separator)</PRE>
2542 <DL>
2543 <DD>Appends a separator if the builder is currently non-empty.
2544 The separator is appended using <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(char)"><CODE>append(char)</CODE></A>.
2546 This method is useful for adding a separator each time around the
2547 loop except the first.
2548 <pre>
2549 for (Iterator it = list.iterator(); it.hasNext(); ) {
2550 appendSeparator(',');
2551 append(it.next());
2553 </pre>
2554 Note that for this simple example, you should use
2555 <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendWithSeparators(java.util.Collection, java.lang.String)"><CODE>appendWithSeparators(Collection, String)</CODE></A>.
2557 <DD><DL>
2558 </DL>
2559 </DD>
2560 <DD><DL>
2561 <DT><B>Parameters:</B><DD><CODE>separator</CODE> - the separator to use
2562 <DT><B>Returns:</B><DD>this, to enable chaining<DT><B>Since:</B></DT>
2563 <DD>2.3</DD>
2564 </DL>
2565 </DD>
2566 </DL>
2567 <HR>
2569 <A NAME="appendSeparator(java.lang.String, int)"><!-- --></A><H3>
2570 appendSeparator</H3>
2571 <PRE>
2572 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendSeparator</B>(java.lang.String&nbsp;separator,
2573 int&nbsp;loopIndex)</PRE>
2574 <DL>
2575 <DD>Appends a separator to the builder if the loop index is greater than zero.
2576 Appending a null separator will have no effect.
2577 The separator is appended using <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(java.lang.String)"><CODE>append(String)</CODE></A>.
2579 This method is useful for adding a separator each time around the
2580 loop except the first.
2581 <pre>
2582 for (int i = 0; i < list.size(); i++) {
2583 appendSeparator(",", i);
2584 append(list.get(i));
2586 </pre>
2587 Note that for this simple example, you should use
2588 <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendWithSeparators(java.util.Collection, java.lang.String)"><CODE>appendWithSeparators(Collection, String)</CODE></A>.
2590 <DD><DL>
2591 </DL>
2592 </DD>
2593 <DD><DL>
2594 <DT><B>Parameters:</B><DD><CODE>separator</CODE> - the separator to use, null means no separator<DD><CODE>loopIndex</CODE> - the loop index
2595 <DT><B>Returns:</B><DD>this, to enable chaining<DT><B>Since:</B></DT>
2596 <DD>2.3</DD>
2597 </DL>
2598 </DD>
2599 </DL>
2600 <HR>
2602 <A NAME="appendSeparator(char, int)"><!-- --></A><H3>
2603 appendSeparator</H3>
2604 <PRE>
2605 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendSeparator</B>(char&nbsp;separator,
2606 int&nbsp;loopIndex)</PRE>
2607 <DL>
2608 <DD>Appends a separator to the builder if the loop index is greater than zero.
2609 The separator is appended using <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#append(char)"><CODE>append(char)</CODE></A>.
2611 This method is useful for adding a separator each time around the
2612 loop except the first.
2613 <pre>
2614 for (int i = 0; i < list.size(); i++) {
2615 appendSeparator(",", i);
2616 append(list.get(i));
2618 </pre>
2619 Note that for this simple example, you should use
2620 <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html#appendWithSeparators(java.util.Collection, java.lang.String)"><CODE>appendWithSeparators(Collection, String)</CODE></A>.
2622 <DD><DL>
2623 </DL>
2624 </DD>
2625 <DD><DL>
2626 <DT><B>Parameters:</B><DD><CODE>separator</CODE> - the separator to use<DD><CODE>loopIndex</CODE> - the loop index
2627 <DT><B>Returns:</B><DD>this, to enable chaining<DT><B>Since:</B></DT>
2628 <DD>2.3</DD>
2629 </DL>
2630 </DD>
2631 </DL>
2632 <HR>
2634 <A NAME="appendPadding(int, char)"><!-- --></A><H3>
2635 appendPadding</H3>
2636 <PRE>
2637 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendPadding</B>(int&nbsp;length,
2638 char&nbsp;padChar)</PRE>
2639 <DL>
2640 <DD>Appends the pad character to the builder the specified number of times.
2642 <DD><DL>
2643 </DL>
2644 </DD>
2645 <DD><DL>
2646 <DT><B>Parameters:</B><DD><CODE>length</CODE> - the length to append, negative means no append<DD><CODE>padChar</CODE> - the character to append
2647 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
2648 </DD>
2649 </DL>
2650 <HR>
2652 <A NAME="appendFixedWidthPadLeft(java.lang.Object, int, char)"><!-- --></A><H3>
2653 appendFixedWidthPadLeft</H3>
2654 <PRE>
2655 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendFixedWidthPadLeft</B>(java.lang.Object&nbsp;obj,
2656 int&nbsp;width,
2657 char&nbsp;padChar)</PRE>
2658 <DL>
2659 <DD>Appends an object to the builder padding on the left to a fixed width.
2660 The <code>toString</code> of the object is used.
2661 If the object is larger than the length, the left hand side is lost.
2662 If the object is null, the null text value is used.
2664 <DD><DL>
2665 </DL>
2666 </DD>
2667 <DD><DL>
2668 <DT><B>Parameters:</B><DD><CODE>obj</CODE> - the object to append, null uses null text<DD><CODE>width</CODE> - the fixed field width, zero or negative has no effect<DD><CODE>padChar</CODE> - the pad character to use
2669 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
2670 </DD>
2671 </DL>
2672 <HR>
2674 <A NAME="appendFixedWidthPadLeft(int, int, char)"><!-- --></A><H3>
2675 appendFixedWidthPadLeft</H3>
2676 <PRE>
2677 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendFixedWidthPadLeft</B>(int&nbsp;value,
2678 int&nbsp;width,
2679 char&nbsp;padChar)</PRE>
2680 <DL>
2681 <DD>Appends an object to the builder padding on the left to a fixed width.
2682 The <code>String.valueOf</code> of the <code>int</code> value is used.
2683 If the formatted value is larger than the length, the left hand side is lost.
2685 <DD><DL>
2686 </DL>
2687 </DD>
2688 <DD><DL>
2689 <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to append<DD><CODE>width</CODE> - the fixed field width, zero or negative has no effect<DD><CODE>padChar</CODE> - the pad character to use
2690 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
2691 </DD>
2692 </DL>
2693 <HR>
2695 <A NAME="appendFixedWidthPadRight(java.lang.Object, int, char)"><!-- --></A><H3>
2696 appendFixedWidthPadRight</H3>
2697 <PRE>
2698 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendFixedWidthPadRight</B>(java.lang.Object&nbsp;obj,
2699 int&nbsp;width,
2700 char&nbsp;padChar)</PRE>
2701 <DL>
2702 <DD>Appends an object to the builder padding on the right to a fixed length.
2703 The <code>toString</code> of the object is used.
2704 If the object is larger than the length, the right hand side is lost.
2705 If the object is null, null text value is used.
2707 <DD><DL>
2708 </DL>
2709 </DD>
2710 <DD><DL>
2711 <DT><B>Parameters:</B><DD><CODE>obj</CODE> - the object to append, null uses null text<DD><CODE>width</CODE> - the fixed field width, zero or negative has no effect<DD><CODE>padChar</CODE> - the pad character to use
2712 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
2713 </DD>
2714 </DL>
2715 <HR>
2717 <A NAME="appendFixedWidthPadRight(int, int, char)"><!-- --></A><H3>
2718 appendFixedWidthPadRight</H3>
2719 <PRE>
2720 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>appendFixedWidthPadRight</B>(int&nbsp;value,
2721 int&nbsp;width,
2722 char&nbsp;padChar)</PRE>
2723 <DL>
2724 <DD>Appends an object to the builder padding on the right to a fixed length.
2725 The <code>String.valueOf</code> of the <code>int</code> value is used.
2726 If the object is larger than the length, the right hand side is lost.
2728 <DD><DL>
2729 </DL>
2730 </DD>
2731 <DD><DL>
2732 <DT><B>Parameters:</B><DD><CODE>value</CODE> - the value to append<DD><CODE>width</CODE> - the fixed field width, zero or negative has no effect<DD><CODE>padChar</CODE> - the pad character to use
2733 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
2734 </DD>
2735 </DL>
2736 <HR>
2738 <A NAME="insert(int, java.lang.Object)"><!-- --></A><H3>
2739 insert</H3>
2740 <PRE>
2741 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>insert</B>(int&nbsp;index,
2742 java.lang.Object&nbsp;obj)</PRE>
2743 <DL>
2744 <DD>Inserts the string representation of an object into this builder.
2745 Inserting null will use the stored null text value.
2747 <DD><DL>
2748 </DL>
2749 </DD>
2750 <DD><DL>
2751 <DT><B>Parameters:</B><DD><CODE>index</CODE> - the index to add at, must be valid<DD><CODE>obj</CODE> - the object to insert
2752 <DT><B>Returns:</B><DD>this, to enable chaining
2753 <DT><B>Throws:</B>
2754 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the index is invalid</DL>
2755 </DD>
2756 </DL>
2757 <HR>
2759 <A NAME="insert(int, java.lang.String)"><!-- --></A><H3>
2760 insert</H3>
2761 <PRE>
2762 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>insert</B>(int&nbsp;index,
2763 java.lang.String&nbsp;str)</PRE>
2764 <DL>
2765 <DD>Inserts the string into this builder.
2766 Inserting null will use the stored null text value.
2768 <DD><DL>
2769 </DL>
2770 </DD>
2771 <DD><DL>
2772 <DT><B>Parameters:</B><DD><CODE>index</CODE> - the index to add at, must be valid<DD><CODE>str</CODE> - the string to insert
2773 <DT><B>Returns:</B><DD>this, to enable chaining
2774 <DT><B>Throws:</B>
2775 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the index is invalid</DL>
2776 </DD>
2777 </DL>
2778 <HR>
2780 <A NAME="insert(int, char[])"><!-- --></A><H3>
2781 insert</H3>
2782 <PRE>
2783 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>insert</B>(int&nbsp;index,
2784 char[]&nbsp;chars)</PRE>
2785 <DL>
2786 <DD>Inserts the character array into this builder.
2787 Inserting null will use the stored null text value.
2789 <DD><DL>
2790 </DL>
2791 </DD>
2792 <DD><DL>
2793 <DT><B>Parameters:</B><DD><CODE>index</CODE> - the index to add at, must be valid<DD><CODE>chars</CODE> - the char array to insert
2794 <DT><B>Returns:</B><DD>this, to enable chaining
2795 <DT><B>Throws:</B>
2796 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the index is invalid</DL>
2797 </DD>
2798 </DL>
2799 <HR>
2801 <A NAME="insert(int, char[], int, int)"><!-- --></A><H3>
2802 insert</H3>
2803 <PRE>
2804 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>insert</B>(int&nbsp;index,
2805 char[]&nbsp;chars,
2806 int&nbsp;offset,
2807 int&nbsp;length)</PRE>
2808 <DL>
2809 <DD>Inserts part of the character array into this builder.
2810 Inserting null will use the stored null text value.
2812 <DD><DL>
2813 </DL>
2814 </DD>
2815 <DD><DL>
2816 <DT><B>Parameters:</B><DD><CODE>index</CODE> - the index to add at, must be valid<DD><CODE>chars</CODE> - the char array to insert<DD><CODE>offset</CODE> - the offset into the character array to start at, must be valid<DD><CODE>length</CODE> - the length of the character array part to copy, must be positive
2817 <DT><B>Returns:</B><DD>this, to enable chaining
2818 <DT><B>Throws:</B>
2819 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if any index is invalid</DL>
2820 </DD>
2821 </DL>
2822 <HR>
2824 <A NAME="insert(int, boolean)"><!-- --></A><H3>
2825 insert</H3>
2826 <PRE>
2827 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>insert</B>(int&nbsp;index,
2828 boolean&nbsp;value)</PRE>
2829 <DL>
2830 <DD>Inserts the value into this builder.
2832 <DD><DL>
2833 </DL>
2834 </DD>
2835 <DD><DL>
2836 <DT><B>Parameters:</B><DD><CODE>index</CODE> - the index to add at, must be valid<DD><CODE>value</CODE> - the value to insert
2837 <DT><B>Returns:</B><DD>this, to enable chaining
2838 <DT><B>Throws:</B>
2839 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the index is invalid</DL>
2840 </DD>
2841 </DL>
2842 <HR>
2844 <A NAME="insert(int, char)"><!-- --></A><H3>
2845 insert</H3>
2846 <PRE>
2847 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>insert</B>(int&nbsp;index,
2848 char&nbsp;value)</PRE>
2849 <DL>
2850 <DD>Inserts the value into this builder.
2852 <DD><DL>
2853 </DL>
2854 </DD>
2855 <DD><DL>
2856 <DT><B>Parameters:</B><DD><CODE>index</CODE> - the index to add at, must be valid<DD><CODE>value</CODE> - the value to insert
2857 <DT><B>Returns:</B><DD>this, to enable chaining
2858 <DT><B>Throws:</B>
2859 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the index is invalid</DL>
2860 </DD>
2861 </DL>
2862 <HR>
2864 <A NAME="insert(int, int)"><!-- --></A><H3>
2865 insert</H3>
2866 <PRE>
2867 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>insert</B>(int&nbsp;index,
2868 int&nbsp;value)</PRE>
2869 <DL>
2870 <DD>Inserts the value into this builder.
2872 <DD><DL>
2873 </DL>
2874 </DD>
2875 <DD><DL>
2876 <DT><B>Parameters:</B><DD><CODE>index</CODE> - the index to add at, must be valid<DD><CODE>value</CODE> - the value to insert
2877 <DT><B>Returns:</B><DD>this, to enable chaining
2878 <DT><B>Throws:</B>
2879 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the index is invalid</DL>
2880 </DD>
2881 </DL>
2882 <HR>
2884 <A NAME="insert(int, long)"><!-- --></A><H3>
2885 insert</H3>
2886 <PRE>
2887 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>insert</B>(int&nbsp;index,
2888 long&nbsp;value)</PRE>
2889 <DL>
2890 <DD>Inserts the value into this builder.
2892 <DD><DL>
2893 </DL>
2894 </DD>
2895 <DD><DL>
2896 <DT><B>Parameters:</B><DD><CODE>index</CODE> - the index to add at, must be valid<DD><CODE>value</CODE> - the value to insert
2897 <DT><B>Returns:</B><DD>this, to enable chaining
2898 <DT><B>Throws:</B>
2899 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the index is invalid</DL>
2900 </DD>
2901 </DL>
2902 <HR>
2904 <A NAME="insert(int, float)"><!-- --></A><H3>
2905 insert</H3>
2906 <PRE>
2907 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>insert</B>(int&nbsp;index,
2908 float&nbsp;value)</PRE>
2909 <DL>
2910 <DD>Inserts the value into this builder.
2912 <DD><DL>
2913 </DL>
2914 </DD>
2915 <DD><DL>
2916 <DT><B>Parameters:</B><DD><CODE>index</CODE> - the index to add at, must be valid<DD><CODE>value</CODE> - the value to insert
2917 <DT><B>Returns:</B><DD>this, to enable chaining
2918 <DT><B>Throws:</B>
2919 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the index is invalid</DL>
2920 </DD>
2921 </DL>
2922 <HR>
2924 <A NAME="insert(int, double)"><!-- --></A><H3>
2925 insert</H3>
2926 <PRE>
2927 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>insert</B>(int&nbsp;index,
2928 double&nbsp;value)</PRE>
2929 <DL>
2930 <DD>Inserts the value into this builder.
2932 <DD><DL>
2933 </DL>
2934 </DD>
2935 <DD><DL>
2936 <DT><B>Parameters:</B><DD><CODE>index</CODE> - the index to add at, must be valid<DD><CODE>value</CODE> - the value to insert
2937 <DT><B>Returns:</B><DD>this, to enable chaining
2938 <DT><B>Throws:</B>
2939 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the index is invalid</DL>
2940 </DD>
2941 </DL>
2942 <HR>
2944 <A NAME="delete(int, int)"><!-- --></A><H3>
2945 delete</H3>
2946 <PRE>
2947 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>delete</B>(int&nbsp;startIndex,
2948 int&nbsp;endIndex)</PRE>
2949 <DL>
2950 <DD>Deletes the characters between the two specified indices.
2952 <DD><DL>
2953 </DL>
2954 </DD>
2955 <DD><DL>
2956 <DT><B>Parameters:</B><DD><CODE>startIndex</CODE> - the start index, inclusive, must be valid<DD><CODE>endIndex</CODE> - the end index, exclusive, must be valid except
2957 that if too large it is treated as end of string
2958 <DT><B>Returns:</B><DD>this, to enable chaining
2959 <DT><B>Throws:</B>
2960 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the index is invalid</DL>
2961 </DD>
2962 </DL>
2963 <HR>
2965 <A NAME="deleteAll(char)"><!-- --></A><H3>
2966 deleteAll</H3>
2967 <PRE>
2968 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>deleteAll</B>(char&nbsp;ch)</PRE>
2969 <DL>
2970 <DD>Deletes the character wherever it occurs in the builder.
2972 <DD><DL>
2973 </DL>
2974 </DD>
2975 <DD><DL>
2976 <DT><B>Parameters:</B><DD><CODE>ch</CODE> - the character to delete
2977 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
2978 </DD>
2979 </DL>
2980 <HR>
2982 <A NAME="deleteFirst(char)"><!-- --></A><H3>
2983 deleteFirst</H3>
2984 <PRE>
2985 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>deleteFirst</B>(char&nbsp;ch)</PRE>
2986 <DL>
2987 <DD>Deletes the character wherever it occurs in the builder.
2989 <DD><DL>
2990 </DL>
2991 </DD>
2992 <DD><DL>
2993 <DT><B>Parameters:</B><DD><CODE>ch</CODE> - the character to delete
2994 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
2995 </DD>
2996 </DL>
2997 <HR>
2999 <A NAME="deleteAll(java.lang.String)"><!-- --></A><H3>
3000 deleteAll</H3>
3001 <PRE>
3002 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>deleteAll</B>(java.lang.String&nbsp;str)</PRE>
3003 <DL>
3004 <DD>Deletes the string wherever it occurs in the builder.
3006 <DD><DL>
3007 </DL>
3008 </DD>
3009 <DD><DL>
3010 <DT><B>Parameters:</B><DD><CODE>str</CODE> - the string to delete, null causes no action
3011 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
3012 </DD>
3013 </DL>
3014 <HR>
3016 <A NAME="deleteFirst(java.lang.String)"><!-- --></A><H3>
3017 deleteFirst</H3>
3018 <PRE>
3019 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>deleteFirst</B>(java.lang.String&nbsp;str)</PRE>
3020 <DL>
3021 <DD>Deletes the string wherever it occurs in the builder.
3023 <DD><DL>
3024 </DL>
3025 </DD>
3026 <DD><DL>
3027 <DT><B>Parameters:</B><DD><CODE>str</CODE> - the string to delete, null causes no action
3028 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
3029 </DD>
3030 </DL>
3031 <HR>
3033 <A NAME="deleteAll(org.apache.commons.lang.text.StrMatcher)"><!-- --></A><H3>
3034 deleteAll</H3>
3035 <PRE>
3036 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>deleteAll</B>(<A HREF="../../../../../org/apache/commons/lang/text/StrMatcher.html" title="class in org.apache.commons.lang.text">StrMatcher</A>&nbsp;matcher)</PRE>
3037 <DL>
3038 <DD>Deletes all parts of the builder that the matcher matches.
3040 Matchers can be used to perform advanced deletion behaviour.
3041 For example you could write a matcher to delete all occurances
3042 where the character 'a' is followed by a number.
3044 <DD><DL>
3045 </DL>
3046 </DD>
3047 <DD><DL>
3048 <DT><B>Parameters:</B><DD><CODE>matcher</CODE> - the matcher to use to find the deletion, null causes no action
3049 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
3050 </DD>
3051 </DL>
3052 <HR>
3054 <A NAME="deleteFirst(org.apache.commons.lang.text.StrMatcher)"><!-- --></A><H3>
3055 deleteFirst</H3>
3056 <PRE>
3057 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>deleteFirst</B>(<A HREF="../../../../../org/apache/commons/lang/text/StrMatcher.html" title="class in org.apache.commons.lang.text">StrMatcher</A>&nbsp;matcher)</PRE>
3058 <DL>
3059 <DD>Deletes the first match within the builder using the specified matcher.
3061 Matchers can be used to perform advanced deletion behaviour.
3062 For example you could write a matcher to delete
3063 where the character 'a' is followed by a number.
3065 <DD><DL>
3066 </DL>
3067 </DD>
3068 <DD><DL>
3069 <DT><B>Parameters:</B><DD><CODE>matcher</CODE> - the matcher to use to find the deletion, null causes no action
3070 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
3071 </DD>
3072 </DL>
3073 <HR>
3075 <A NAME="replace(int, int, java.lang.String)"><!-- --></A><H3>
3076 replace</H3>
3077 <PRE>
3078 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>replace</B>(int&nbsp;startIndex,
3079 int&nbsp;endIndex,
3080 java.lang.String&nbsp;replaceStr)</PRE>
3081 <DL>
3082 <DD>Replaces a portion of the string builder with another string.
3083 The length of the inserted string does not have to match the removed length.
3085 <DD><DL>
3086 </DL>
3087 </DD>
3088 <DD><DL>
3089 <DT><B>Parameters:</B><DD><CODE>startIndex</CODE> - the start index, inclusive, must be valid<DD><CODE>endIndex</CODE> - the end index, exclusive, must be valid except
3090 that if too large it is treated as end of string<DD><CODE>replaceStr</CODE> - the string to replace with, null means delete range
3091 <DT><B>Returns:</B><DD>this, to enable chaining
3092 <DT><B>Throws:</B>
3093 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the index is invalid</DL>
3094 </DD>
3095 </DL>
3096 <HR>
3098 <A NAME="replaceAll(char, char)"><!-- --></A><H3>
3099 replaceAll</H3>
3100 <PRE>
3101 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>replaceAll</B>(char&nbsp;search,
3102 char&nbsp;replace)</PRE>
3103 <DL>
3104 <DD>Replaces the search character with the replace character
3105 throughout the builder.
3107 <DD><DL>
3108 </DL>
3109 </DD>
3110 <DD><DL>
3111 <DT><B>Parameters:</B><DD><CODE>search</CODE> - the search character<DD><CODE>replace</CODE> - the replace character
3112 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
3113 </DD>
3114 </DL>
3115 <HR>
3117 <A NAME="replaceFirst(char, char)"><!-- --></A><H3>
3118 replaceFirst</H3>
3119 <PRE>
3120 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>replaceFirst</B>(char&nbsp;search,
3121 char&nbsp;replace)</PRE>
3122 <DL>
3123 <DD>Replaces the first instance of the search character with the
3124 replace character in the builder.
3126 <DD><DL>
3127 </DL>
3128 </DD>
3129 <DD><DL>
3130 <DT><B>Parameters:</B><DD><CODE>search</CODE> - the search character<DD><CODE>replace</CODE> - the replace character
3131 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
3132 </DD>
3133 </DL>
3134 <HR>
3136 <A NAME="replaceAll(java.lang.String, java.lang.String)"><!-- --></A><H3>
3137 replaceAll</H3>
3138 <PRE>
3139 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>replaceAll</B>(java.lang.String&nbsp;searchStr,
3140 java.lang.String&nbsp;replaceStr)</PRE>
3141 <DL>
3142 <DD>Replaces the search string with the replace string throughout the builder.
3144 <DD><DL>
3145 </DL>
3146 </DD>
3147 <DD><DL>
3148 <DT><B>Parameters:</B><DD><CODE>searchStr</CODE> - the search string, null causes no action to occur<DD><CODE>replaceStr</CODE> - the replace string, null is equivalent to an empty string
3149 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
3150 </DD>
3151 </DL>
3152 <HR>
3154 <A NAME="replaceFirst(java.lang.String, java.lang.String)"><!-- --></A><H3>
3155 replaceFirst</H3>
3156 <PRE>
3157 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>replaceFirst</B>(java.lang.String&nbsp;searchStr,
3158 java.lang.String&nbsp;replaceStr)</PRE>
3159 <DL>
3160 <DD>Replaces the first instance of the search string with the replace string.
3162 <DD><DL>
3163 </DL>
3164 </DD>
3165 <DD><DL>
3166 <DT><B>Parameters:</B><DD><CODE>searchStr</CODE> - the search string, null causes no action to occur<DD><CODE>replaceStr</CODE> - the replace string, null is equivalent to an empty string
3167 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
3168 </DD>
3169 </DL>
3170 <HR>
3172 <A NAME="replaceAll(org.apache.commons.lang.text.StrMatcher, java.lang.String)"><!-- --></A><H3>
3173 replaceAll</H3>
3174 <PRE>
3175 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>replaceAll</B>(<A HREF="../../../../../org/apache/commons/lang/text/StrMatcher.html" title="class in org.apache.commons.lang.text">StrMatcher</A>&nbsp;matcher,
3176 java.lang.String&nbsp;replaceStr)</PRE>
3177 <DL>
3178 <DD>Replaces all matches within the builder with the replace string.
3180 Matchers can be used to perform advanced replace behaviour.
3181 For example you could write a matcher to replace all occurances
3182 where the character 'a' is followed by a number.
3184 <DD><DL>
3185 </DL>
3186 </DD>
3187 <DD><DL>
3188 <DT><B>Parameters:</B><DD><CODE>matcher</CODE> - the matcher to use to find the deletion, null causes no action<DD><CODE>replaceStr</CODE> - the replace string, null is equivalent to an empty string
3189 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
3190 </DD>
3191 </DL>
3192 <HR>
3194 <A NAME="replaceFirst(org.apache.commons.lang.text.StrMatcher, java.lang.String)"><!-- --></A><H3>
3195 replaceFirst</H3>
3196 <PRE>
3197 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>replaceFirst</B>(<A HREF="../../../../../org/apache/commons/lang/text/StrMatcher.html" title="class in org.apache.commons.lang.text">StrMatcher</A>&nbsp;matcher,
3198 java.lang.String&nbsp;replaceStr)</PRE>
3199 <DL>
3200 <DD>Replaces the first match within the builder with the replace string.
3202 Matchers can be used to perform advanced replace behaviour.
3203 For example you could write a matcher to replace
3204 where the character 'a' is followed by a number.
3206 <DD><DL>
3207 </DL>
3208 </DD>
3209 <DD><DL>
3210 <DT><B>Parameters:</B><DD><CODE>matcher</CODE> - the matcher to use to find the deletion, null causes no action<DD><CODE>replaceStr</CODE> - the replace string, null is equivalent to an empty string
3211 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
3212 </DD>
3213 </DL>
3214 <HR>
3216 <A NAME="replace(org.apache.commons.lang.text.StrMatcher, java.lang.String, int, int, int)"><!-- --></A><H3>
3217 replace</H3>
3218 <PRE>
3219 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>replace</B>(<A HREF="../../../../../org/apache/commons/lang/text/StrMatcher.html" title="class in org.apache.commons.lang.text">StrMatcher</A>&nbsp;matcher,
3220 java.lang.String&nbsp;replaceStr,
3221 int&nbsp;startIndex,
3222 int&nbsp;endIndex,
3223 int&nbsp;replaceCount)</PRE>
3224 <DL>
3225 <DD>Advanced search and replaces within the builder using a matcher.
3227 Matchers can be used to perform advanced behaviour.
3228 For example you could write a matcher to delete all occurances
3229 where the character 'a' is followed by a number.
3231 <DD><DL>
3232 </DL>
3233 </DD>
3234 <DD><DL>
3235 <DT><B>Parameters:</B><DD><CODE>matcher</CODE> - the matcher to use to find the deletion, null causes no action<DD><CODE>replaceStr</CODE> - the string to replace the match with, null is a delete<DD><CODE>startIndex</CODE> - the start index, inclusive, must be valid<DD><CODE>endIndex</CODE> - the end index, exclusive, must be valid except
3236 that if too large it is treated as end of string<DD><CODE>replaceCount</CODE> - the number of times to replace, -1 for replace all
3237 <DT><B>Returns:</B><DD>this, to enable chaining
3238 <DT><B>Throws:</B>
3239 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if start index is invalid</DL>
3240 </DD>
3241 </DL>
3242 <HR>
3244 <A NAME="reverse()"><!-- --></A><H3>
3245 reverse</H3>
3246 <PRE>
3247 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>reverse</B>()</PRE>
3248 <DL>
3249 <DD>Reverses the string builder placing each character in the opposite index.
3251 <DD><DL>
3252 </DL>
3253 </DD>
3254 <DD><DL>
3256 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
3257 </DD>
3258 </DL>
3259 <HR>
3261 <A NAME="trim()"><!-- --></A><H3>
3262 trim</H3>
3263 <PRE>
3264 public <A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A> <B>trim</B>()</PRE>
3265 <DL>
3266 <DD>Trims the builder by removing characters less than or equal to a space
3267 from the beginning and end.
3269 <DD><DL>
3270 </DL>
3271 </DD>
3272 <DD><DL>
3274 <DT><B>Returns:</B><DD>this, to enable chaining</DL>
3275 </DD>
3276 </DL>
3277 <HR>
3279 <A NAME="startsWith(java.lang.String)"><!-- --></A><H3>
3280 startsWith</H3>
3281 <PRE>
3282 public boolean <B>startsWith</B>(java.lang.String&nbsp;str)</PRE>
3283 <DL>
3284 <DD>Checks whether this builder starts with the specified string.
3286 Note that this method handles null input quietly, unlike String.
3288 <DD><DL>
3289 </DL>
3290 </DD>
3291 <DD><DL>
3292 <DT><B>Parameters:</B><DD><CODE>str</CODE> - the string to search for, null returns false
3293 <DT><B>Returns:</B><DD>true if the builder starts with the string</DL>
3294 </DD>
3295 </DL>
3296 <HR>
3298 <A NAME="endsWith(java.lang.String)"><!-- --></A><H3>
3299 endsWith</H3>
3300 <PRE>
3301 public boolean <B>endsWith</B>(java.lang.String&nbsp;str)</PRE>
3302 <DL>
3303 <DD>Checks whether this builder ends with the specified string.
3305 Note that this method handles null input quietly, unlike String.
3307 <DD><DL>
3308 </DL>
3309 </DD>
3310 <DD><DL>
3311 <DT><B>Parameters:</B><DD><CODE>str</CODE> - the string to search for, null returns false
3312 <DT><B>Returns:</B><DD>true if the builder ends with the string</DL>
3313 </DD>
3314 </DL>
3315 <HR>
3317 <A NAME="substring(int)"><!-- --></A><H3>
3318 substring</H3>
3319 <PRE>
3320 public java.lang.String <B>substring</B>(int&nbsp;start)</PRE>
3321 <DL>
3322 <DD>Extracts a portion of this string builder as a string.
3324 <DD><DL>
3325 </DL>
3326 </DD>
3327 <DD><DL>
3328 <DT><B>Parameters:</B><DD><CODE>start</CODE> - the start index, inclusive, must be valid
3329 <DT><B>Returns:</B><DD>the new string
3330 <DT><B>Throws:</B>
3331 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the index is invalid</DL>
3332 </DD>
3333 </DL>
3334 <HR>
3336 <A NAME="substring(int, int)"><!-- --></A><H3>
3337 substring</H3>
3338 <PRE>
3339 public java.lang.String <B>substring</B>(int&nbsp;startIndex,
3340 int&nbsp;endIndex)</PRE>
3341 <DL>
3342 <DD>Extracts a portion of this string builder as a string.
3344 Note: This method treats an endIndex greater than the length of the
3345 builder as equal to the length of the builder, and continues
3346 without error, unlike StringBuffer or String.
3348 <DD><DL>
3349 </DL>
3350 </DD>
3351 <DD><DL>
3352 <DT><B>Parameters:</B><DD><CODE>startIndex</CODE> - the start index, inclusive, must be valid<DD><CODE>endIndex</CODE> - the end index, exclusive, must be valid except
3353 that if too large it is treated as end of string
3354 <DT><B>Returns:</B><DD>the new string
3355 <DT><B>Throws:</B>
3356 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the index is invalid</DL>
3357 </DD>
3358 </DL>
3359 <HR>
3361 <A NAME="leftString(int)"><!-- --></A><H3>
3362 leftString</H3>
3363 <PRE>
3364 public java.lang.String <B>leftString</B>(int&nbsp;length)</PRE>
3365 <DL>
3366 <DD>Extracts the leftmost characters from the string builder without
3367 throwing an exception.
3369 This method extracts the left <code>length</code> characters from
3370 the builder. If this many characters are not available, the whole
3371 builder is returned. Thus the returned string may be shorter than the
3372 length requested.
3374 <DD><DL>
3375 </DL>
3376 </DD>
3377 <DD><DL>
3378 <DT><B>Parameters:</B><DD><CODE>length</CODE> - the number of characters to extract, negative returns empty string
3379 <DT><B>Returns:</B><DD>the new string</DL>
3380 </DD>
3381 </DL>
3382 <HR>
3384 <A NAME="rightString(int)"><!-- --></A><H3>
3385 rightString</H3>
3386 <PRE>
3387 public java.lang.String <B>rightString</B>(int&nbsp;length)</PRE>
3388 <DL>
3389 <DD>Extracts the rightmost characters from the string builder without
3390 throwing an exception.
3392 This method extracts the right <code>length</code> characters from
3393 the builder. If this many characters are not available, the whole
3394 builder is returned. Thus the returned string may be shorter than the
3395 length requested.
3397 <DD><DL>
3398 </DL>
3399 </DD>
3400 <DD><DL>
3401 <DT><B>Parameters:</B><DD><CODE>length</CODE> - the number of characters to extract, negative returns empty string
3402 <DT><B>Returns:</B><DD>the new string</DL>
3403 </DD>
3404 </DL>
3405 <HR>
3407 <A NAME="midString(int, int)"><!-- --></A><H3>
3408 midString</H3>
3409 <PRE>
3410 public java.lang.String <B>midString</B>(int&nbsp;index,
3411 int&nbsp;length)</PRE>
3412 <DL>
3413 <DD>Extracts some characters from the middle of the string builder without
3414 throwing an exception.
3416 This method extracts <code>length</code> characters from the builder
3417 at the specified index.
3418 If the index is negative it is treated as zero.
3419 If the index is greater than the builder size, it is treated as the builder size.
3420 If the length is negative, the empty string is returned.
3421 If insufficient characters are available in the builder, as much as possible is returned.
3422 Thus the returned string may be shorter than the length requested.
3424 <DD><DL>
3425 </DL>
3426 </DD>
3427 <DD><DL>
3428 <DT><B>Parameters:</B><DD><CODE>index</CODE> - the index to start at, negative means zero<DD><CODE>length</CODE> - the number of characters to extract, negative returns empty string
3429 <DT><B>Returns:</B><DD>the new string</DL>
3430 </DD>
3431 </DL>
3432 <HR>
3434 <A NAME="contains(char)"><!-- --></A><H3>
3435 contains</H3>
3436 <PRE>
3437 public boolean <B>contains</B>(char&nbsp;ch)</PRE>
3438 <DL>
3439 <DD>Checks if the string builder contains the specified char.
3441 <DD><DL>
3442 </DL>
3443 </DD>
3444 <DD><DL>
3445 <DT><B>Parameters:</B><DD><CODE>ch</CODE> - the character to find
3446 <DT><B>Returns:</B><DD>true if the builder contains the character</DL>
3447 </DD>
3448 </DL>
3449 <HR>
3451 <A NAME="contains(java.lang.String)"><!-- --></A><H3>
3452 contains</H3>
3453 <PRE>
3454 public boolean <B>contains</B>(java.lang.String&nbsp;str)</PRE>
3455 <DL>
3456 <DD>Checks if the string builder contains the specified string.
3458 <DD><DL>
3459 </DL>
3460 </DD>
3461 <DD><DL>
3462 <DT><B>Parameters:</B><DD><CODE>str</CODE> - the string to find
3463 <DT><B>Returns:</B><DD>true if the builder contains the string</DL>
3464 </DD>
3465 </DL>
3466 <HR>
3468 <A NAME="contains(org.apache.commons.lang.text.StrMatcher)"><!-- --></A><H3>
3469 contains</H3>
3470 <PRE>
3471 public boolean <B>contains</B>(<A HREF="../../../../../org/apache/commons/lang/text/StrMatcher.html" title="class in org.apache.commons.lang.text">StrMatcher</A>&nbsp;matcher)</PRE>
3472 <DL>
3473 <DD>Checks if the string builder contains a string matched using the
3474 specified matcher.
3476 Matchers can be used to perform advanced searching behaviour.
3477 For example you could write a matcher to search for the character
3478 'a' followed by a number.
3480 <DD><DL>
3481 </DL>
3482 </DD>
3483 <DD><DL>
3484 <DT><B>Parameters:</B><DD><CODE>matcher</CODE> - the matcher to use, null returns -1
3485 <DT><B>Returns:</B><DD>true if the matcher finds a match in the builder</DL>
3486 </DD>
3487 </DL>
3488 <HR>
3490 <A NAME="indexOf(char)"><!-- --></A><H3>
3491 indexOf</H3>
3492 <PRE>
3493 public int <B>indexOf</B>(char&nbsp;ch)</PRE>
3494 <DL>
3495 <DD>Searches the string builder to find the first reference to the specified char.
3497 <DD><DL>
3498 </DL>
3499 </DD>
3500 <DD><DL>
3501 <DT><B>Parameters:</B><DD><CODE>ch</CODE> - the character to find
3502 <DT><B>Returns:</B><DD>the first index of the character, or -1 if not found</DL>
3503 </DD>
3504 </DL>
3505 <HR>
3507 <A NAME="indexOf(char, int)"><!-- --></A><H3>
3508 indexOf</H3>
3509 <PRE>
3510 public int <B>indexOf</B>(char&nbsp;ch,
3511 int&nbsp;startIndex)</PRE>
3512 <DL>
3513 <DD>Searches the string builder to find the first reference to the specified char.
3515 <DD><DL>
3516 </DL>
3517 </DD>
3518 <DD><DL>
3519 <DT><B>Parameters:</B><DD><CODE>ch</CODE> - the character to find<DD><CODE>startIndex</CODE> - the index to start at, invalid index rounded to edge
3520 <DT><B>Returns:</B><DD>the first index of the character, or -1 if not found</DL>
3521 </DD>
3522 </DL>
3523 <HR>
3525 <A NAME="indexOf(java.lang.String)"><!-- --></A><H3>
3526 indexOf</H3>
3527 <PRE>
3528 public int <B>indexOf</B>(java.lang.String&nbsp;str)</PRE>
3529 <DL>
3530 <DD>Searches the string builder to find the first reference to the specified string.
3532 Note that a null input string will return -1, whereas the JDK throws an exception.
3534 <DD><DL>
3535 </DL>
3536 </DD>
3537 <DD><DL>
3538 <DT><B>Parameters:</B><DD><CODE>str</CODE> - the string to find, null returns -1
3539 <DT><B>Returns:</B><DD>the first index of the string, or -1 if not found</DL>
3540 </DD>
3541 </DL>
3542 <HR>
3544 <A NAME="indexOf(java.lang.String, int)"><!-- --></A><H3>
3545 indexOf</H3>
3546 <PRE>
3547 public int <B>indexOf</B>(java.lang.String&nbsp;str,
3548 int&nbsp;startIndex)</PRE>
3549 <DL>
3550 <DD>Searches the string builder to find the first reference to the specified
3551 string starting searching from the given index.
3553 Note that a null input string will return -1, whereas the JDK throws an exception.
3555 <DD><DL>
3556 </DL>
3557 </DD>
3558 <DD><DL>
3559 <DT><B>Parameters:</B><DD><CODE>str</CODE> - the string to find, null returns -1<DD><CODE>startIndex</CODE> - the index to start at, invalid index rounded to edge
3560 <DT><B>Returns:</B><DD>the first index of the string, or -1 if not found</DL>
3561 </DD>
3562 </DL>
3563 <HR>
3565 <A NAME="indexOf(org.apache.commons.lang.text.StrMatcher)"><!-- --></A><H3>
3566 indexOf</H3>
3567 <PRE>
3568 public int <B>indexOf</B>(<A HREF="../../../../../org/apache/commons/lang/text/StrMatcher.html" title="class in org.apache.commons.lang.text">StrMatcher</A>&nbsp;matcher)</PRE>
3569 <DL>
3570 <DD>Searches the string builder using the matcher to find the first match.
3572 Matchers can be used to perform advanced searching behaviour.
3573 For example you could write a matcher to find the character 'a'
3574 followed by a number.
3576 <DD><DL>
3577 </DL>
3578 </DD>
3579 <DD><DL>
3580 <DT><B>Parameters:</B><DD><CODE>matcher</CODE> - the matcher to use, null returns -1
3581 <DT><B>Returns:</B><DD>the first index matched, or -1 if not found</DL>
3582 </DD>
3583 </DL>
3584 <HR>
3586 <A NAME="indexOf(org.apache.commons.lang.text.StrMatcher, int)"><!-- --></A><H3>
3587 indexOf</H3>
3588 <PRE>
3589 public int <B>indexOf</B>(<A HREF="../../../../../org/apache/commons/lang/text/StrMatcher.html" title="class in org.apache.commons.lang.text">StrMatcher</A>&nbsp;matcher,
3590 int&nbsp;startIndex)</PRE>
3591 <DL>
3592 <DD>Searches the string builder using the matcher to find the first
3593 match searching from the given index.
3595 Matchers can be used to perform advanced searching behaviour.
3596 For example you could write a matcher to find the character 'a'
3597 followed by a number.
3599 <DD><DL>
3600 </DL>
3601 </DD>
3602 <DD><DL>
3603 <DT><B>Parameters:</B><DD><CODE>matcher</CODE> - the matcher to use, null returns -1<DD><CODE>startIndex</CODE> - the index to start at, invalid index rounded to edge
3604 <DT><B>Returns:</B><DD>the first index matched, or -1 if not found</DL>
3605 </DD>
3606 </DL>
3607 <HR>
3609 <A NAME="lastIndexOf(char)"><!-- --></A><H3>
3610 lastIndexOf</H3>
3611 <PRE>
3612 public int <B>lastIndexOf</B>(char&nbsp;ch)</PRE>
3613 <DL>
3614 <DD>Searches the string builder to find the last reference to the specified char.
3616 <DD><DL>
3617 </DL>
3618 </DD>
3619 <DD><DL>
3620 <DT><B>Parameters:</B><DD><CODE>ch</CODE> - the character to find
3621 <DT><B>Returns:</B><DD>the last index of the character, or -1 if not found</DL>
3622 </DD>
3623 </DL>
3624 <HR>
3626 <A NAME="lastIndexOf(char, int)"><!-- --></A><H3>
3627 lastIndexOf</H3>
3628 <PRE>
3629 public int <B>lastIndexOf</B>(char&nbsp;ch,
3630 int&nbsp;startIndex)</PRE>
3631 <DL>
3632 <DD>Searches the string builder to find the last reference to the specified char.
3634 <DD><DL>
3635 </DL>
3636 </DD>
3637 <DD><DL>
3638 <DT><B>Parameters:</B><DD><CODE>ch</CODE> - the character to find<DD><CODE>startIndex</CODE> - the index to start at, invalid index rounded to edge
3639 <DT><B>Returns:</B><DD>the last index of the character, or -1 if not found</DL>
3640 </DD>
3641 </DL>
3642 <HR>
3644 <A NAME="lastIndexOf(java.lang.String)"><!-- --></A><H3>
3645 lastIndexOf</H3>
3646 <PRE>
3647 public int <B>lastIndexOf</B>(java.lang.String&nbsp;str)</PRE>
3648 <DL>
3649 <DD>Searches the string builder to find the last reference to the specified string.
3651 Note that a null input string will return -1, whereas the JDK throws an exception.
3653 <DD><DL>
3654 </DL>
3655 </DD>
3656 <DD><DL>
3657 <DT><B>Parameters:</B><DD><CODE>str</CODE> - the string to find, null returns -1
3658 <DT><B>Returns:</B><DD>the last index of the string, or -1 if not found</DL>
3659 </DD>
3660 </DL>
3661 <HR>
3663 <A NAME="lastIndexOf(java.lang.String, int)"><!-- --></A><H3>
3664 lastIndexOf</H3>
3665 <PRE>
3666 public int <B>lastIndexOf</B>(java.lang.String&nbsp;str,
3667 int&nbsp;startIndex)</PRE>
3668 <DL>
3669 <DD>Searches the string builder to find the last reference to the specified
3670 string starting searching from the given index.
3672 Note that a null input string will return -1, whereas the JDK throws an exception.
3674 <DD><DL>
3675 </DL>
3676 </DD>
3677 <DD><DL>
3678 <DT><B>Parameters:</B><DD><CODE>str</CODE> - the string to find, null returns -1<DD><CODE>startIndex</CODE> - the index to start at, invalid index rounded to edge
3679 <DT><B>Returns:</B><DD>the last index of the string, or -1 if not found</DL>
3680 </DD>
3681 </DL>
3682 <HR>
3684 <A NAME="lastIndexOf(org.apache.commons.lang.text.StrMatcher)"><!-- --></A><H3>
3685 lastIndexOf</H3>
3686 <PRE>
3687 public int <B>lastIndexOf</B>(<A HREF="../../../../../org/apache/commons/lang/text/StrMatcher.html" title="class in org.apache.commons.lang.text">StrMatcher</A>&nbsp;matcher)</PRE>
3688 <DL>
3689 <DD>Searches the string builder using the matcher to find the last match.
3691 Matchers can be used to perform advanced searching behaviour.
3692 For example you could write a matcher to find the character 'a'
3693 followed by a number.
3695 <DD><DL>
3696 </DL>
3697 </DD>
3698 <DD><DL>
3699 <DT><B>Parameters:</B><DD><CODE>matcher</CODE> - the matcher to use, null returns -1
3700 <DT><B>Returns:</B><DD>the last index matched, or -1 if not found</DL>
3701 </DD>
3702 </DL>
3703 <HR>
3705 <A NAME="lastIndexOf(org.apache.commons.lang.text.StrMatcher, int)"><!-- --></A><H3>
3706 lastIndexOf</H3>
3707 <PRE>
3708 public int <B>lastIndexOf</B>(<A HREF="../../../../../org/apache/commons/lang/text/StrMatcher.html" title="class in org.apache.commons.lang.text">StrMatcher</A>&nbsp;matcher,
3709 int&nbsp;startIndex)</PRE>
3710 <DL>
3711 <DD>Searches the string builder using the matcher to find the last
3712 match searching from the given index.
3714 Matchers can be used to perform advanced searching behaviour.
3715 For example you could write a matcher to find the character 'a'
3716 followed by a number.
3718 <DD><DL>
3719 </DL>
3720 </DD>
3721 <DD><DL>
3722 <DT><B>Parameters:</B><DD><CODE>matcher</CODE> - the matcher to use, null returns -1<DD><CODE>startIndex</CODE> - the index to start at, invalid index rounded to edge
3723 <DT><B>Returns:</B><DD>the last index matched, or -1 if not found</DL>
3724 </DD>
3725 </DL>
3726 <HR>
3728 <A NAME="asTokenizer()"><!-- --></A><H3>
3729 asTokenizer</H3>
3730 <PRE>
3731 public <A HREF="../../../../../org/apache/commons/lang/text/StrTokenizer.html" title="class in org.apache.commons.lang.text">StrTokenizer</A> <B>asTokenizer</B>()</PRE>
3732 <DL>
3733 <DD>Creates a tokenizer that can tokenize the contents of this builder.
3735 This method allows the contents of this builder to be tokenized.
3736 The tokenizer will be setup by default to tokenize on space, tab,
3737 newline and formfeed (as per StringTokenizer). These values can be
3738 changed on the tokenizer class, before retrieving the tokens.
3740 The returned tokenizer is linked to this builder. You may intermix
3741 calls to the buider and tokenizer within certain limits, however
3742 there is no synchronization. Once the tokenizer has been used once,
3743 it must be <A HREF="../../../../../org/apache/commons/lang/text/StrTokenizer.html#reset()"><CODE>reset</CODE></A> to pickup the latest
3744 changes in the builder. For example:
3745 <pre>
3746 StrBuilder b = new StrBuilder();
3747 b.append("a b ");
3748 StrTokenizer t = b.asTokenizer();
3749 String[] tokens1 = t.getTokenArray(); // returns a,b
3750 b.append("c d ");
3751 String[] tokens2 = t.getTokenArray(); // returns a,b (c and d ignored)
3752 t.reset(); // reset causes builder changes to be picked up
3753 String[] tokens3 = t.getTokenArray(); // returns a,b,c,d
3754 </pre>
3755 In addition to simply intermixing appends and tokenization, you can also
3756 call the set methods on the tokenizer to alter how it tokenizes. Just
3757 remember to call reset when you want to pickup builder changes.
3759 Calling <A HREF="../../../../../org/apache/commons/lang/text/StrTokenizer.html#reset(java.lang.String)"><CODE>StrTokenizer.reset(String)</CODE></A> or <A HREF="../../../../../org/apache/commons/lang/text/StrTokenizer.html#reset(char[])"><CODE>StrTokenizer.reset(char[])</CODE></A>
3760 with a non-null value will break the link with the builder.
3762 <DD><DL>
3763 </DL>
3764 </DD>
3765 <DD><DL>
3767 <DT><B>Returns:</B><DD>a tokenizer that is linked to this builder</DL>
3768 </DD>
3769 </DL>
3770 <HR>
3772 <A NAME="asReader()"><!-- --></A><H3>
3773 asReader</H3>
3774 <PRE>
3775 public java.io.Reader <B>asReader</B>()</PRE>
3776 <DL>
3777 <DD>Gets the contents of this builder as a Reader.
3779 This method allows the contents of the builder to be read
3780 using any standard method that expects a Reader.
3782 To use, simply create a <code>StrBuilder</code>, populate it with
3783 data, call <code>asReader</code>, and then read away.
3785 The internal character array is shared between the builder and the reader.
3786 This allows you to append to the builder after creating the reader,
3787 and the changes will be picked up.
3788 Note however, that no synchronization occurs, so you must perform
3789 all operations with the builder and the reader in one thread.
3791 The returned reader supports marking, and ignores the flush method.
3793 <DD><DL>
3794 </DL>
3795 </DD>
3796 <DD><DL>
3798 <DT><B>Returns:</B><DD>a reader that reads from this builder</DL>
3799 </DD>
3800 </DL>
3801 <HR>
3803 <A NAME="asWriter()"><!-- --></A><H3>
3804 asWriter</H3>
3805 <PRE>
3806 public java.io.Writer <B>asWriter</B>()</PRE>
3807 <DL>
3808 <DD>Gets this builder as a Writer that can be written to.
3810 This method allows you to populate the contents of the builder
3811 using any standard method that takes a Writer.
3813 To use, simply create a <code>StrBuilder</code>,
3814 call <code>asWriter</code>, and populate away. The data is available
3815 at any time using the methods of the <code>StrBuilder</code>.
3817 The internal character array is shared between the builder and the writer.
3818 This allows you to intermix calls that append to the builder and
3819 write using the writer and the changes will be occur correctly.
3820 Note however, that no synchronization occurs, so you must perform
3821 all operations with the builder and the writer in one thread.
3823 The returned writer ignores the close and flush methods.
3825 <DD><DL>
3826 </DL>
3827 </DD>
3828 <DD><DL>
3830 <DT><B>Returns:</B><DD>a writer that populates this builder</DL>
3831 </DD>
3832 </DL>
3833 <HR>
3835 <A NAME="equalsIgnoreCase(org.apache.commons.lang.text.StrBuilder)"><!-- --></A><H3>
3836 equalsIgnoreCase</H3>
3837 <PRE>
3838 public boolean <B>equalsIgnoreCase</B>(<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A>&nbsp;other)</PRE>
3839 <DL>
3840 <DD>Checks the contents of this builder against another to see if they
3841 contain the same character content ignoring case.
3843 <DD><DL>
3844 </DL>
3845 </DD>
3846 <DD><DL>
3847 <DT><B>Parameters:</B><DD><CODE>other</CODE> - the object to check, null returns false
3848 <DT><B>Returns:</B><DD>true if the builders contain the same characters in the same order</DL>
3849 </DD>
3850 </DL>
3851 <HR>
3853 <A NAME="equals(org.apache.commons.lang.text.StrBuilder)"><!-- --></A><H3>
3854 equals</H3>
3855 <PRE>
3856 public boolean <B>equals</B>(<A HREF="../../../../../org/apache/commons/lang/text/StrBuilder.html" title="class in org.apache.commons.lang.text">StrBuilder</A>&nbsp;other)</PRE>
3857 <DL>
3858 <DD>Checks the contents of this builder against another to see if they
3859 contain the same character content.
3861 <DD><DL>
3862 </DL>
3863 </DD>
3864 <DD><DL>
3865 <DT><B>Parameters:</B><DD><CODE>other</CODE> - the object to check, null returns false
3866 <DT><B>Returns:</B><DD>true if the builders contain the same characters in the same order</DL>
3867 </DD>
3868 </DL>
3869 <HR>
3871 <A NAME="equals(java.lang.Object)"><!-- --></A><H3>
3872 equals</H3>
3873 <PRE>
3874 public boolean <B>equals</B>(java.lang.Object&nbsp;obj)</PRE>
3875 <DL>
3876 <DD>Checks the contents of this builder against another to see if they
3877 contain the same character content.
3879 <DD><DL>
3880 </DL>
3881 </DD>
3882 <DD><DL>
3883 <DT><B>Parameters:</B><DD><CODE>obj</CODE> - the object to check, null returns false
3884 <DT><B>Returns:</B><DD>true if the builders contain the same characters in the same order</DL>
3885 </DD>
3886 </DL>
3887 <HR>
3889 <A NAME="hashCode()"><!-- --></A><H3>
3890 hashCode</H3>
3891 <PRE>
3892 public int <B>hashCode</B>()</PRE>
3893 <DL>
3894 <DD>Gets a suitable hash code for this builder.
3896 <DD><DL>
3897 </DL>
3898 </DD>
3899 <DD><DL>
3901 <DT><B>Returns:</B><DD>a hash code</DL>
3902 </DD>
3903 </DL>
3904 <HR>
3906 <A NAME="toString()"><!-- --></A><H3>
3907 toString</H3>
3908 <PRE>
3909 public java.lang.String <B>toString</B>()</PRE>
3910 <DL>
3911 <DD>Gets a String version of the string builder, creating a new instance
3912 each time the method is called.
3914 Note that unlike StringBuffer, the string version returned is
3915 independent of the string builder.
3917 <DD><DL>
3918 </DL>
3919 </DD>
3920 <DD><DL>
3922 <DT><B>Returns:</B><DD>the builder as a String</DL>
3923 </DD>
3924 </DL>
3925 <HR>
3927 <A NAME="toStringBuffer()"><!-- --></A><H3>
3928 toStringBuffer</H3>
3929 <PRE>
3930 public java.lang.StringBuffer <B>toStringBuffer</B>()</PRE>
3931 <DL>
3932 <DD>Gets a StringBuffer version of the string builder, creating a
3933 new instance each time the method is called.
3935 <DD><DL>
3936 </DL>
3937 </DD>
3938 <DD><DL>
3940 <DT><B>Returns:</B><DD>the builder as a StringBuffer</DL>
3941 </DD>
3942 </DL>
3943 <HR>
3945 <A NAME="validateRange(int, int)"><!-- --></A><H3>
3946 validateRange</H3>
3947 <PRE>
3948 protected int <B>validateRange</B>(int&nbsp;startIndex,
3949 int&nbsp;endIndex)</PRE>
3950 <DL>
3951 <DD>Validates parameters defining a range of the builder.
3953 <DD><DL>
3954 </DL>
3955 </DD>
3956 <DD><DL>
3957 <DT><B>Parameters:</B><DD><CODE>startIndex</CODE> - the start index, inclusive, must be valid<DD><CODE>endIndex</CODE> - the end index, exclusive, must be valid except
3958 that if too large it is treated as end of string
3959 <DT><B>Returns:</B><DD>the new string
3960 <DT><B>Throws:</B>
3961 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the index is invalid</DL>
3962 </DD>
3963 </DL>
3964 <HR>
3966 <A NAME="validateIndex(int)"><!-- --></A><H3>
3967 validateIndex</H3>
3968 <PRE>
3969 protected void <B>validateIndex</B>(int&nbsp;index)</PRE>
3970 <DL>
3971 <DD>Validates parameters defining a single index in the builder.
3973 <DD><DL>
3974 </DL>
3975 </DD>
3976 <DD><DL>
3977 <DT><B>Parameters:</B><DD><CODE>index</CODE> - the index, must be valid
3978 <DT><B>Throws:</B>
3979 <DD><CODE>java.lang.IndexOutOfBoundsException</CODE> - if the index is invalid</DL>
3980 </DD>
3981 </DL>
3982 <!-- ========= END OF CLASS DATA ========= -->
3983 <HR>
3986 <!-- ======= START OF BOTTOM NAVBAR ====== -->
3987 <A NAME="navbar_bottom"><!-- --></A>
3988 <A HREF="#skip-navbar_bottom" title="Skip navigation links"></A>
3989 <TABLE BORDER="0" WIDTH="100%" CELLPADDING="1" CELLSPACING="0" SUMMARY="">
3990 <TR>
3991 <TD COLSPAN=3 BGCOLOR="#EEEEFF" CLASS="NavBarCell1">
3992 <A NAME="navbar_bottom_firstrow"><!-- --></A>
3993 <TABLE BORDER="0" CELLPADDING="0" CELLSPACING="3" SUMMARY="">
3994 <TR ALIGN="center" VALIGN="top">
3995 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../overview-summary.html"><FONT CLASS="NavBarFont1"><B>Overview</B></FONT></A>&nbsp;</TD>
3996 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-summary.html"><FONT CLASS="NavBarFont1"><B>Package</B></FONT></A>&nbsp;</TD>
3997 <TD BGCOLOR="#FFFFFF" CLASS="NavBarCell1Rev"> &nbsp;<FONT CLASS="NavBarFont1Rev"><B>Class</B></FONT>&nbsp;</TD>
3998 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="class-use/StrBuilder.html"><FONT CLASS="NavBarFont1"><B>Use</B></FONT></A>&nbsp;</TD>
3999 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="package-tree.html"><FONT CLASS="NavBarFont1"><B>Tree</B></FONT></A>&nbsp;</TD>
4000 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../deprecated-list.html"><FONT CLASS="NavBarFont1"><B>Deprecated</B></FONT></A>&nbsp;</TD>
4001 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../index-all.html"><FONT CLASS="NavBarFont1"><B>Index</B></FONT></A>&nbsp;</TD>
4002 <TD BGCOLOR="#EEEEFF" CLASS="NavBarCell1"> <A HREF="../../../../../help-doc.html"><FONT CLASS="NavBarFont1"><B>Help</B></FONT></A>&nbsp;</TD>
4003 </TR>
4004 </TABLE>
4005 </TD>
4006 <TD ALIGN="right" VALIGN="top" ROWSPAN=3><EM>
4007 </EM>
4008 </TD>
4009 </TR>
4011 <TR>
4012 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
4013 &nbsp;<A HREF="../../../../../org/apache/commons/lang/text/ExtendedMessageFormat.html" title="class in org.apache.commons.lang.text"><B>PREV CLASS</B></A>&nbsp;
4014 &nbsp;<A HREF="../../../../../org/apache/commons/lang/text/StrLookup.html" title="class in org.apache.commons.lang.text"><B>NEXT CLASS</B></A></FONT></TD>
4015 <TD BGCOLOR="white" CLASS="NavBarCell2"><FONT SIZE="-2">
4016 <A HREF="../../../../../index.html" target="_top"><B>FRAMES</B></A> &nbsp;
4017 &nbsp;<A HREF="StrBuilder.html" target="_top"><B>NO FRAMES</B></A> &nbsp;
4018 &nbsp;<SCRIPT type="text/javascript">
4019 <!--
4020 if(window==top) {
4021 document.writeln('<A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>');
4023 //-->
4024 </SCRIPT>
4025 <NOSCRIPT>
4026 <A HREF="../../../../../allclasses-noframe.html"><B>All Classes</B></A>
4027 </NOSCRIPT>
4029 </FONT></TD>
4030 </TR>
4031 <TR>
4032 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
4033 SUMMARY:&nbsp;NESTED&nbsp;|&nbsp;<A HREF="#field_summary">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_summary">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_summary">METHOD</A></FONT></TD>
4034 <TD VALIGN="top" CLASS="NavBarCell3"><FONT SIZE="-2">
4035 DETAIL:&nbsp;<A HREF="#field_detail">FIELD</A>&nbsp;|&nbsp;<A HREF="#constructor_detail">CONSTR</A>&nbsp;|&nbsp;<A HREF="#method_detail">METHOD</A></FONT></TD>
4036 </TR>
4037 </TABLE>
4038 <A NAME="skip-navbar_bottom"></A>
4039 <!-- ======== END OF BOTTOM NAVBAR ======= -->
4041 <HR>
4042 Copyright © 2001-2008 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All Rights Reserved.
4043 </BODY>
4044 </HTML>