sample/java.lang.StringBuilder.txt

   1 *java.lang.StringBuilder* *StringBuilder* A mutable sequence of characters.
   2
   3 public final class StringBuilder
   4   extends    |java.lang.AbstractStringBuilder|
   5   implements |java.io.Serializable|
   6              |java.lang.CharSequence|
   7
   8 |java.lang.StringBuilder_Description|
   9 |java.lang.StringBuilder_Fields|
  10 |java.lang.StringBuilder_Constructors|
  11 |java.lang.StringBuilder_Methods|
  12
  13 ================================================================================
  14
  15 *java.lang.StringBuilder_Constructors*
  16 |java.lang.StringBuilder()|Constructs a string builder with no characters in it
  17 |java.lang.StringBuilder(CharSequence)|Constructs a string builder that contain
  18 |java.lang.StringBuilder(int)|Constructs a string builder with no characters in
  19 |java.lang.StringBuilder(String)|Constructs a string builder initialized to the
  20
  21 *java.lang.StringBuilder_Methods*
  22 |java.lang.StringBuilder.append(boolean)|
  23 |java.lang.StringBuilder.append(char)|
  24 |java.lang.StringBuilder.append(char[])|
  25 |java.lang.StringBuilder.append(char[],int,int)|
  26 |java.lang.StringBuilder.append(CharSequence)|
  27 |java.lang.StringBuilder.append(CharSequence,int,int)|
  28 |java.lang.StringBuilder.append(double)|
  29 |java.lang.StringBuilder.append(float)|
  30 |java.lang.StringBuilder.append(int)|
  31 |java.lang.StringBuilder.append(long)|
  32 |java.lang.StringBuilder.append(Object)|
  33 |java.lang.StringBuilder.append(String)|
  34 |java.lang.StringBuilder.append(StringBuffer)|Appends the specified StringBuffe
  35 |java.lang.StringBuilder.appendCodePoint(int)|
  36 |java.lang.StringBuilder.delete(int,int)|
  37 |java.lang.StringBuilder.deleteCharAt(int)|
  38 |java.lang.StringBuilder.indexOf(String)|
  39 |java.lang.StringBuilder.indexOf(String,int)|
  40 |java.lang.StringBuilder.insert(int,boolean)|
  41 |java.lang.StringBuilder.insert(int,char)|
  42 |java.lang.StringBuilder.insert(int,char[])|
  43 |java.lang.StringBuilder.insert(int,char[],int,int)|
  44 |java.lang.StringBuilder.insert(int,CharSequence)|
  45 |java.lang.StringBuilder.insert(int,CharSequence,int,int)|
  46 |java.lang.StringBuilder.insert(int,double)|
  47 |java.lang.StringBuilder.insert(int,float)|
  48 |java.lang.StringBuilder.insert(int,int)|
  49 |java.lang.StringBuilder.insert(int,long)|
  50 |java.lang.StringBuilder.insert(int,Object)|
  51 |java.lang.StringBuilder.insert(int,String)|
  52 |java.lang.StringBuilder.lastIndexOf(String)|
  53 |java.lang.StringBuilder.lastIndexOf(String,int)|
  54 |java.lang.StringBuilder.replace(int,int,String)|
  55 |java.lang.StringBuilder.reverse()|
  56 |java.lang.StringBuilder.toString()|
  57
  58 *java.lang.StringBuilder_Description*
  59
  60 A mutable sequence of characters. This class provides an API compatible with
  61 StringBuffer, but with no guarantee of synchronization. This class is designed
  62 for use as a drop-in replacement for StringBuffer in places where the string
  63 buffer was being used by a single thread (as is generally the case). Where
  64 possible, it is recommended that this class be used in preference to
  65 StringBuffer as it will be faster under most implementations.
  66
  67 The principal operations on a StringBuilder are the append and insert methods,
  68 which are overloaded so as to accept data of any type. Each effectively
  69 converts a given datum to a string and then appends or inserts the characters
  70 of that string to the string builder. The append method always adds these
  71 characters at the end of the builder; the insert method adds the characters at
  72 a specified point.
  73
  74 For example, if z refers to a string builder object whose current contents are
  75 "start", then the method call z.append("le") would cause the string builder to
  76 contain "startle", whereas z.insert(4, "le") would alter the string builder to
  77 contain "starlet".
  78
  79 In general, if sb refers to an instance of a StringBuilder, then sb.append(x)
  80 has the same effect as sb.insert(sb.length(),x).
  81
  82 Every string builder has a capacity. As long as the length of the character
  83 sequence contained in the string builder does not exceed the capacity, it is
  84 not necessary to allocate a new internal buffer. If the internal buffer
  85 overflows, it is automatically made larger.
  86
  87 Instances of StringBuilder are not safe for use by multiple threads. If such
  88 synchronization is required then it is recommended that
  89 (|java.lang.StringBuffer|) be used.
  90
  91
  92
  93 *java.lang.StringBuilder()*
  94
  95 public StringBuilder()
  96
  97 Constructs a string builder with no characters in it and an initial capacity of
  98 16 characters.
  99
 100
 101 *java.lang.StringBuilder(CharSequence)*
 102
 103 public StringBuilder(java.lang.CharSequence seq)
 104
 105 Constructs a string builder that contains the same characters as the specified
 106 CharSequence. The initial capacity of the string builder is 16 plus the length
 107 of the CharSequence argument.
 108
 109     seq - the sequence to copy.
 110
 111 *java.lang.StringBuilder(int)*
 112
 113 public StringBuilder(int capacity)
 114
 115 Constructs a string builder with no characters in it and an initial capacity
 116 specified by the capacity argument.
 117
 118     capacity - the initial capacity.
 119
 120 *java.lang.StringBuilder(String)*
 121
 122 public StringBuilder(java.lang.String str)
 123
 124 Constructs a string builder initialized to the contents of the specified
 125 string. The initial capacity of the string builder is 16 plus the length of the
 126 string argument.
 127
 128     str - the initial contents of the buffer.
 129
 130 *java.lang.StringBuilder.append(boolean)*
 131
 132 public |java.lang.StringBuilder| append(boolean b)
 133
 134
 135
 136
 137
 138 *java.lang.StringBuilder.append(char)*
 139
 140 public |java.lang.StringBuilder| append(char c)
 141
 142
 143
 144
 145
 146 *java.lang.StringBuilder.append(char[])*
 147
 148 public |java.lang.StringBuilder| append(char[] str)
 149
 150
 151
 152
 153
 154 *java.lang.StringBuilder.append(char[],int,int)*
 155
 156 public |java.lang.StringBuilder| append(
 157   char[] str,
 158   int offset,
 159   int len)
 160
 161
 162
 163
 164
 165 *java.lang.StringBuilder.append(CharSequence)*
 166
 167 public |java.lang.StringBuilder| append(java.lang.CharSequence s)
 168
 169
 170
 171
 172
 173 *java.lang.StringBuilder.append(CharSequence,int,int)*
 174
 175 public |java.lang.StringBuilder| append(
 176   java.lang.CharSequence s,
 177   int start,
 178   int end)
 179
 180
 181
 182
 183
 184 *java.lang.StringBuilder.append(double)*
 185
 186 public |java.lang.StringBuilder| append(double d)
 187
 188
 189
 190
 191
 192 *java.lang.StringBuilder.append(float)*
 193
 194 public |java.lang.StringBuilder| append(float f)
 195
 196
 197
 198
 199
 200 *java.lang.StringBuilder.append(int)*
 201
 202 public |java.lang.StringBuilder| append(int i)
 203
 204
 205
 206
 207
 208 *java.lang.StringBuilder.append(long)*
 209
 210 public |java.lang.StringBuilder| append(long lng)
 211
 212
 213
 214
 215
 216 *java.lang.StringBuilder.append(Object)*
 217
 218 public |java.lang.StringBuilder| append(java.lang.Object obj)
 219
 220
 221
 222
 223
 224 *java.lang.StringBuilder.append(String)*
 225
 226 public |java.lang.StringBuilder| append(java.lang.String str)
 227
 228
 229
 230
 231
 232 *java.lang.StringBuilder.append(StringBuffer)*
 233
 234 public |java.lang.StringBuilder| append(java.lang.StringBuffer sb)
 235
 236 Appends the specified StringBuffer to this sequence.
 237
 238 The characters of the StringBuffer argument are appended, in order, to this
 239 sequence, increasing the length of this sequence by the length of the argument.
 240 If sb is null, then the four characters "null" are appended to this sequence.
 241
 242 Let n be the length of this character sequence just prior to execution of the
 243 append method. Then the character at index k in the new character sequence is
 244 equal to the character at index k in the old character sequence, if k is less
 245 than n; otherwise, it is equal to the character at index k-n in the argument
 246 sb.
 247
 248
 249     sb - the StringBuffer to append.
 250
 251     Returns: a reference to this object.
 252
 253 *java.lang.StringBuilder.appendCodePoint(int)*
 254
 255 public |java.lang.StringBuilder| appendCodePoint(int codePoint)
 256
 257
 258
 259
 260
 261 *java.lang.StringBuilder.delete(int,int)*
 262
 263 public |java.lang.StringBuilder| delete(
 264   int start,
 265   int end)
 266
 267
 268
 269
 270
 271 *java.lang.StringBuilder.deleteCharAt(int)*
 272
 273 public |java.lang.StringBuilder| deleteCharAt(int index)
 274
 275
 276
 277
 278
 279 *java.lang.StringBuilder.indexOf(String)*
 280
 281 public int indexOf(java.lang.String str)
 282
 283
 284
 285
 286
 287 *java.lang.StringBuilder.indexOf(String,int)*
 288
 289 public int indexOf(
 290   java.lang.String str,
 291   int fromIndex)
 292
 293
 294
 295
 296
 297 *java.lang.StringBuilder.insert(int,boolean)*
 298
 299 public |java.lang.StringBuilder| insert(
 300   int offset,
 301   boolean b)
 302
 303
 304
 305
 306
 307 *java.lang.StringBuilder.insert(int,char)*
 308
 309 public |java.lang.StringBuilder| insert(
 310   int offset,
 311   char c)
 312
 313
 314
 315
 316
 317 *java.lang.StringBuilder.insert(int,char[])*
 318
 319 public |java.lang.StringBuilder| insert(
 320   int offset,
 321   char[] str)
 322
 323
 324
 325
 326
 327 *java.lang.StringBuilder.insert(int,char[],int,int)*
 328
 329 public |java.lang.StringBuilder| insert(
 330   int index,
 331   char[] str,
 332   int offset,
 333   int len)
 334
 335
 336
 337
 338
 339 *java.lang.StringBuilder.insert(int,CharSequence)*
 340
 341 public |java.lang.StringBuilder| insert(
 342   int dstOffset,
 343   java.lang.CharSequence s)
 344
 345
 346
 347
 348
 349 *java.lang.StringBuilder.insert(int,CharSequence,int,int)*
 350
 351 public |java.lang.StringBuilder| insert(
 352   int dstOffset,
 353   java.lang.CharSequence s,
 354   int start,
 355   int end)
 356
 357
 358
 359
 360
 361 *java.lang.StringBuilder.insert(int,double)*
 362
 363 public |java.lang.StringBuilder| insert(
 364   int offset,
 365   double d)
 366
 367
 368
 369
 370
 371 *java.lang.StringBuilder.insert(int,float)*
 372
 373 public |java.lang.StringBuilder| insert(
 374   int offset,
 375   float f)
 376
 377
 378
 379
 380
 381 *java.lang.StringBuilder.insert(int,int)*
 382
 383 public |java.lang.StringBuilder| insert(
 384   int offset,
 385   int i)
 386
 387
 388
 389
 390
 391 *java.lang.StringBuilder.insert(int,long)*
 392
 393 public |java.lang.StringBuilder| insert(
 394   int offset,
 395   long l)
 396
 397
 398
 399
 400
 401 *java.lang.StringBuilder.insert(int,Object)*
 402
 403 public |java.lang.StringBuilder| insert(
 404   int offset,
 405   java.lang.Object obj)
 406
 407
 408
 409
 410
 411 *java.lang.StringBuilder.insert(int,String)*
 412
 413 public |java.lang.StringBuilder| insert(
 414   int offset,
 415   java.lang.String str)
 416
 417
 418
 419
 420
 421 *java.lang.StringBuilder.lastIndexOf(String)*
 422
 423 public int lastIndexOf(java.lang.String str)
 424
 425
 426
 427
 428
 429 *java.lang.StringBuilder.lastIndexOf(String,int)*
 430
 431 public int lastIndexOf(
 432   java.lang.String str,
 433   int fromIndex)
 434
 435
 436
 437
 438
 439 *java.lang.StringBuilder.replace(int,int,String)*
 440
 441 public |java.lang.StringBuilder| replace(
 442   int start,
 443   int end,
 444   java.lang.String str)
 445
 446
 447
 448
 449
 450 *java.lang.StringBuilder.reverse()*
 451
 452 public |java.lang.StringBuilder| reverse()
 453
 454
 455
 456
 457
 458 *java.lang.StringBuilder.toString()*
 459
 460 public |java.lang.String| toString()
 461
 462
 463
 464
 465
 466