sample/java.lang.StringBuffer.txt

   1 *java.lang.StringBuffer* *StringBuffer* A thread-safe, mutable sequence of chara
   2
   3 public final class StringBuffer
   4   extends    |java.lang.AbstractStringBuilder|
   5   implements |java.io.Serializable|
   6              |java.lang.CharSequence|
   7
   8 |java.lang.StringBuffer_Description|
   9 |java.lang.StringBuffer_Fields|
  10 |java.lang.StringBuffer_Constructors|
  11 |java.lang.StringBuffer_Methods|
  12
  13 ================================================================================
  14
  15 *java.lang.StringBuffer_Constructors*
  16 |java.lang.StringBuffer()|Constructs a string buffer with no characters in it a
  17 |java.lang.StringBuffer(CharSequence)|Constructs a string buffer that contains
  18 |java.lang.StringBuffer(int)|Constructs a string buffer with no characters in i
  19 |java.lang.StringBuffer(String)|Constructs a string buffer initialized to the c
  20
  21 *java.lang.StringBuffer_Methods*
  22 |java.lang.StringBuffer.append(boolean)|
  23 |java.lang.StringBuffer.append(char)|
  24 |java.lang.StringBuffer.append(char[])|
  25 |java.lang.StringBuffer.append(char[],int,int)|
  26 |java.lang.StringBuffer.append(CharSequence)|Appends the specified CharSequence
  27 |java.lang.StringBuffer.append(CharSequence,int,int)|
  28 |java.lang.StringBuffer.append(double)|
  29 |java.lang.StringBuffer.append(float)|
  30 |java.lang.StringBuffer.append(int)|
  31 |java.lang.StringBuffer.append(long)|
  32 |java.lang.StringBuffer.append(Object)|
  33 |java.lang.StringBuffer.append(String)|
  34 |java.lang.StringBuffer.append(StringBuffer)|Appends the specified StringBuffer
  35 |java.lang.StringBuffer.appendCodePoint(int)|
  36 |java.lang.StringBuffer.capacity()|
  37 |java.lang.StringBuffer.charAt(int)|
  38 |java.lang.StringBuffer.codePointAt(int)|
  39 |java.lang.StringBuffer.codePointBefore(int)|
  40 |java.lang.StringBuffer.codePointCount(int,int)|
  41 |java.lang.StringBuffer.delete(int,int)|
  42 |java.lang.StringBuffer.deleteCharAt(int)|
  43 |java.lang.StringBuffer.ensureCapacity(int)|
  44 |java.lang.StringBuffer.getChars(int,int,char[],int)|
  45 |java.lang.StringBuffer.indexOf(String)|
  46 |java.lang.StringBuffer.indexOf(String,int)|
  47 |java.lang.StringBuffer.insert(int,boolean)|
  48 |java.lang.StringBuffer.insert(int,char)|
  49 |java.lang.StringBuffer.insert(int,char[])|
  50 |java.lang.StringBuffer.insert(int,char[],int,int)|
  51 |java.lang.StringBuffer.insert(int,CharSequence)|
  52 |java.lang.StringBuffer.insert(int,CharSequence,int,int)|
  53 |java.lang.StringBuffer.insert(int,double)|
  54 |java.lang.StringBuffer.insert(int,float)|
  55 |java.lang.StringBuffer.insert(int,int)|
  56 |java.lang.StringBuffer.insert(int,long)|
  57 |java.lang.StringBuffer.insert(int,Object)|
  58 |java.lang.StringBuffer.insert(int,String)|
  59 |java.lang.StringBuffer.lastIndexOf(String)|
  60 |java.lang.StringBuffer.lastIndexOf(String,int)|
  61 |java.lang.StringBuffer.length()|
  62 |java.lang.StringBuffer.offsetByCodePoints(int,int)|
  63 |java.lang.StringBuffer.replace(int,int,String)|
  64 |java.lang.StringBuffer.reverse()|
  65 |java.lang.StringBuffer.setCharAt(int,char)|
  66 |java.lang.StringBuffer.setLength(int)|
  67 |java.lang.StringBuffer.subSequence(int,int)|
  68 |java.lang.StringBuffer.substring(int)|
  69 |java.lang.StringBuffer.substring(int,int)|
  70 |java.lang.StringBuffer.toString()|
  71 |java.lang.StringBuffer.trimToSize()|
  72
  73 *java.lang.StringBuffer_Description*
  74
  75 A thread-safe, mutable sequence of characters. A string buffer is like a
  76 (|java.lang.String|) , but can be modified. At any point in time it contains
  77 some particular sequence of characters, but the length and content of the
  78 sequence can be changed through certain method calls.
  79
  80 String buffers are safe for use by multiple threads. The methods are
  81 synchronized where necessary so that all the operations on any particular
  82 instance behave as if they occur in some serial order that is consistent with
  83 the order of the method calls made by each of the individual threads involved.
  84
  85 The principal operations on a StringBuffer are the append and insert methods,
  86 which are overloaded so as to accept data of any type. Each effectively
  87 converts a given datum to a string and then appends or inserts the characters
  88 of that string to the string buffer. The append method always adds these
  89 characters at the end of the buffer; the insert method adds the characters at a
  90 specified point.
  91
  92 For example, if z refers to a string buffer object whose current contents are
  93 "start", then the method call z.append("le") would cause the string buffer to
  94 contain "startle", whereas z.insert(4, "le") would alter the string buffer to
  95 contain "starlet".
  96
  97 In general, if sb refers to an instance of a StringBuffer, then sb.append(x)
  98 has the same effect as sb.insert(sb.length(),x).
  99
 100 Whenever an operation occurs involving a source sequence (such as appending or
 101 inserting from a source sequence) this class synchronizes only on the string
 102 buffer performing the operation, not on the source.
 103
 104 Every string buffer has a capacity. As long as the length of the character
 105 sequence contained in the string buffer does not exceed the capacity, it is not
 106 necessary to allocate a new internal buffer array. If the internal buffer
 107 overflows, it is automatically made larger.
 108
 109 As of release JDK 5, this class has been supplemented with an equivalent class
 110 designed for use by a single thread, (|java.lang.StringBuilder|) . The
 111 StringBuilder class should generally be used in preference to this one, as it
 112 supports all of the same operations but it is faster, as it performs no
 113 synchronization.
 114
 115
 116 *java.lang.StringBuffer()*
 117
 118 public StringBuffer()
 119
 120 Constructs a string buffer with no characters in it and an initial capacity of
 121 16 characters.
 122
 123
 124 *java.lang.StringBuffer(CharSequence)*
 125
 126 public StringBuffer(java.lang.CharSequence seq)
 127
 128 Constructs a string buffer that contains the same characters as the specified
 129 CharSequence. The initial capacity of the string buffer is 16 plus the length
 130 of the CharSequence argument.
 131
 132 If the length of the specified CharSequence is less than or equal to zero, then
 133 an empty buffer of capacity 16 is returned.
 134
 135     seq - the sequence to copy.
 136
 137 *java.lang.StringBuffer(int)*
 138
 139 public StringBuffer(int capacity)
 140
 141 Constructs a string buffer with no characters in it and the specified initial
 142 capacity.
 143
 144     capacity - the initial capacity.
 145
 146 *java.lang.StringBuffer(String)*
 147
 148 public StringBuffer(java.lang.String str)
 149
 150 Constructs a string buffer initialized to the contents of the specified string.
 151 The initial capacity of the string buffer is 16 plus the length of the string
 152 argument.
 153
 154     str - the initial contents of the buffer.
 155
 156 *java.lang.StringBuffer.append(boolean)*
 157
 158 public synchronized |java.lang.StringBuffer| append(boolean b)
 159
 160
 161
 162
 163 *java.lang.StringBuffer.append(char)*
 164
 165 public synchronized |java.lang.StringBuffer| append(char c)
 166
 167
 168
 169
 170 *java.lang.StringBuffer.append(char[])*
 171
 172 public synchronized |java.lang.StringBuffer| append(char[] str)
 173
 174
 175
 176
 177 *java.lang.StringBuffer.append(char[],int,int)*
 178
 179 public synchronized |java.lang.StringBuffer| append(
 180   char[] str,
 181   int offset,
 182   int len)
 183
 184
 185
 186
 187 *java.lang.StringBuffer.append(CharSequence)*
 188
 189 public |java.lang.StringBuffer| append(java.lang.CharSequence s)
 190
 191 Appends the specified CharSequence to this sequence.
 192
 193 The characters of the CharSequence argument are appended, in order, increasing
 194 the length of this sequence by the length of the argument.
 195
 196 The result of this method is exactly the same as if it were an invocation of
 197 this.append(s, 0, s.length());
 198
 199 This method synchronizes on this (the destination) object but does not
 200 synchronize on the source (s).
 201
 202 If s is null, then the four characters "null" are appended.
 203
 204     s - the CharSequence to append.
 205
 206     Returns: a reference to this object.
 207 *java.lang.StringBuffer.append(CharSequence,int,int)*
 208
 209 public synchronized |java.lang.StringBuffer| append(
 210   java.lang.CharSequence s,
 211   int start,
 212   int end)
 213
 214
 215
 216
 217 *java.lang.StringBuffer.append(double)*
 218
 219 public synchronized |java.lang.StringBuffer| append(double d)
 220
 221
 222
 223
 224 *java.lang.StringBuffer.append(float)*
 225
 226 public synchronized |java.lang.StringBuffer| append(float f)
 227
 228
 229
 230
 231 *java.lang.StringBuffer.append(int)*
 232
 233 public synchronized |java.lang.StringBuffer| append(int i)
 234
 235
 236
 237
 238 *java.lang.StringBuffer.append(long)*
 239
 240 public synchronized |java.lang.StringBuffer| append(long lng)
 241
 242
 243
 244
 245 *java.lang.StringBuffer.append(Object)*
 246
 247 public synchronized |java.lang.StringBuffer| append(java.lang.Object obj)
 248
 249
 250
 251
 252 *java.lang.StringBuffer.append(String)*
 253
 254 public synchronized |java.lang.StringBuffer| append(java.lang.String str)
 255
 256
 257
 258
 259 *java.lang.StringBuffer.append(StringBuffer)*
 260
 261 public synchronized |java.lang.StringBuffer| append(java.lang.StringBuffer sb)
 262
 263 Appends the specified StringBuffer to this sequence.
 264
 265 The characters of the StringBuffer argument are appended, in order, to the
 266 contents of this StringBuffer, increasing the length of this StringBuffer by
 267 the length of the argument. If sb is null, then the four characters "null" are
 268 appended to this StringBuffer.
 269
 270 Let n be the length of the old character sequence, the one contained in the
 271 StringBuffer just prior to execution of the append method. Then the character
 272 at index k in the new character sequence is equal to the character at index k
 273 in the old character sequence, if k is less than n; otherwise, it is equal to
 274 the character at index k-n in the argument sb.
 275
 276 This method synchronizes on this (the destination) object but does not
 277 synchronize on the source (sb).
 278
 279     sb - the StringBuffer to append.
 280
 281     Returns: a reference to this object.
 282 *java.lang.StringBuffer.appendCodePoint(int)*
 283
 284 public synchronized |java.lang.StringBuffer| appendCodePoint(int codePoint)
 285
 286
 287
 288
 289 *java.lang.StringBuffer.capacity()*
 290
 291 public synchronized int capacity()
 292
 293
 294
 295
 296 *java.lang.StringBuffer.charAt(int)*
 297
 298 public synchronized char charAt(int index)
 299
 300
 301
 302
 303 *java.lang.StringBuffer.codePointAt(int)*
 304
 305 public synchronized int codePointAt(int index)
 306
 307
 308
 309
 310 *java.lang.StringBuffer.codePointBefore(int)*
 311
 312 public synchronized int codePointBefore(int index)
 313
 314
 315
 316
 317 *java.lang.StringBuffer.codePointCount(int,int)*
 318
 319 public synchronized int codePointCount(
 320   int beginIndex,
 321   int endIndex)
 322
 323
 324
 325
 326 *java.lang.StringBuffer.delete(int,int)*
 327
 328 public synchronized |java.lang.StringBuffer| delete(
 329   int start,
 330   int end)
 331
 332
 333
 334
 335 *java.lang.StringBuffer.deleteCharAt(int)*
 336
 337 public synchronized |java.lang.StringBuffer| deleteCharAt(int index)
 338
 339
 340
 341
 342 *java.lang.StringBuffer.ensureCapacity(int)*
 343
 344 public synchronized void ensureCapacity(int minimumCapacity)
 345
 346
 347
 348
 349 *java.lang.StringBuffer.getChars(int,int,char[],int)*
 350
 351 public synchronized void getChars(
 352   int srcBegin,
 353   int srcEnd,
 354   char[] dst,
 355   int dstBegin)
 356
 357
 358
 359
 360 *java.lang.StringBuffer.indexOf(String)*
 361
 362 public int indexOf(java.lang.String str)
 363
 364
 365
 366
 367 *java.lang.StringBuffer.indexOf(String,int)*
 368
 369 public synchronized int indexOf(
 370   java.lang.String str,
 371   int fromIndex)
 372
 373
 374
 375
 376 *java.lang.StringBuffer.insert(int,boolean)*
 377
 378 public |java.lang.StringBuffer| insert(
 379   int offset,
 380   boolean b)
 381
 382
 383
 384
 385 *java.lang.StringBuffer.insert(int,char)*
 386
 387 public synchronized |java.lang.StringBuffer| insert(
 388   int offset,
 389   char c)
 390
 391
 392
 393
 394 *java.lang.StringBuffer.insert(int,char[])*
 395
 396 public synchronized |java.lang.StringBuffer| insert(
 397   int offset,
 398   char[] str)
 399
 400
 401
 402
 403 *java.lang.StringBuffer.insert(int,char[],int,int)*
 404
 405 public synchronized |java.lang.StringBuffer| insert(
 406   int index,
 407   char[] str,
 408   int offset,
 409   int len)
 410
 411
 412
 413
 414 *java.lang.StringBuffer.insert(int,CharSequence)*
 415
 416 public |java.lang.StringBuffer| insert(
 417   int dstOffset,
 418   java.lang.CharSequence s)
 419
 420
 421
 422
 423 *java.lang.StringBuffer.insert(int,CharSequence,int,int)*
 424
 425 public synchronized |java.lang.StringBuffer| insert(
 426   int dstOffset,
 427   java.lang.CharSequence s,
 428   int start,
 429   int end)
 430
 431
 432
 433
 434 *java.lang.StringBuffer.insert(int,double)*
 435
 436 public |java.lang.StringBuffer| insert(
 437   int offset,
 438   double d)
 439
 440
 441
 442
 443 *java.lang.StringBuffer.insert(int,float)*
 444
 445 public |java.lang.StringBuffer| insert(
 446   int offset,
 447   float f)
 448
 449
 450
 451
 452 *java.lang.StringBuffer.insert(int,int)*
 453
 454 public |java.lang.StringBuffer| insert(
 455   int offset,
 456   int i)
 457
 458
 459
 460
 461 *java.lang.StringBuffer.insert(int,long)*
 462
 463 public |java.lang.StringBuffer| insert(
 464   int offset,
 465   long l)
 466
 467
 468
 469
 470 *java.lang.StringBuffer.insert(int,Object)*
 471
 472 public synchronized |java.lang.StringBuffer| insert(
 473   int offset,
 474   java.lang.Object obj)
 475
 476
 477
 478
 479 *java.lang.StringBuffer.insert(int,String)*
 480
 481 public synchronized |java.lang.StringBuffer| insert(
 482   int offset,
 483   java.lang.String str)
 484
 485
 486
 487
 488 *java.lang.StringBuffer.lastIndexOf(String)*
 489
 490 public int lastIndexOf(java.lang.String str)
 491
 492
 493
 494
 495 *java.lang.StringBuffer.lastIndexOf(String,int)*
 496
 497 public synchronized int lastIndexOf(
 498   java.lang.String str,
 499   int fromIndex)
 500
 501
 502
 503
 504 *java.lang.StringBuffer.length()*
 505
 506 public synchronized int length()
 507
 508
 509
 510
 511 *java.lang.StringBuffer.offsetByCodePoints(int,int)*
 512
 513 public synchronized int offsetByCodePoints(
 514   int index,
 515   int codePointOffset)
 516
 517
 518
 519
 520 *java.lang.StringBuffer.replace(int,int,String)*
 521
 522 public synchronized |java.lang.StringBuffer| replace(
 523   int start,
 524   int end,
 525   java.lang.String str)
 526
 527
 528
 529
 530 *java.lang.StringBuffer.reverse()*
 531
 532 public synchronized |java.lang.StringBuffer| reverse()
 533
 534
 535
 536
 537 *java.lang.StringBuffer.setCharAt(int,char)*
 538
 539 public synchronized void setCharAt(
 540   int index,
 541   char ch)
 542
 543
 544
 545
 546 *java.lang.StringBuffer.setLength(int)*
 547
 548 public synchronized void setLength(int newLength)
 549
 550
 551
 552
 553 *java.lang.StringBuffer.subSequence(int,int)*
 554
 555 public synchronized |java.lang.CharSequence| subSequence(
 556   int start,
 557   int end)
 558
 559
 560
 561
 562 *java.lang.StringBuffer.substring(int)*
 563
 564 public synchronized |java.lang.String| substring(int start)
 565
 566
 567
 568
 569 *java.lang.StringBuffer.substring(int,int)*
 570
 571 public synchronized |java.lang.String| substring(
 572   int start,
 573   int end)
 574
 575
 576
 577
 578 *java.lang.StringBuffer.toString()*
 579
 580 public synchronized |java.lang.String| toString()
 581
 582
 583
 584
 585 *java.lang.StringBuffer.trimToSize()*
 586
 587 public synchronized void trimToSize()
 588
 589
 590
 591
 592