public final Class StringBuilder

Overrides java.lang.AbstractStringBuilder.append.

Doc from java.lang.AbstractStringBuilder.append.

Appends the string representation of the Object argument.

The overall effect is exactly as if the argument were converted to a string by the method String#valueOf(Object), and the characters of that string were then appended to this character sequence.

Annotations

@Override

Overrides java.lang.AbstractStringBuilder.append.

Doc from java.lang.AbstractStringBuilder.append.

Appends the specified string to this character sequence.

The characters of the String argument are appended, in order, increasing the length of this sequence by the length of the argument. If str is null, then the four characters "null" are appended.

Let n be the length of this character sequence just prior to execution of the append method. Then the character at index k in the new character sequence is equal to the character at index k in the old character sequence, if k is less than n; otherwise, it is equal to the character at index k-n in the argument str.

Annotations

@Override

@IntrinsicCandidate

Overrides java.lang.AbstractStringBuilder.append.

Appends the specified StringBuffer to this sequence.

The characters of the StringBuffer argument are appended, in order, to this sequence, increasing the length of this sequence by the length of the argument. If sb is null, then the four characters "null" are appended to this sequence.

Let n be the length of this character sequence just prior to execution of the append method. Then the character at index k in the new character sequence is equal to the character at index k in the old character sequence, if k is less than n; otherwise, it is equal to the character at index k-n in the argument sb.

Parameters

sb:StringBuffer

the StringBuffer to append.

Returns:StringBuilder

a reference to this object.

Overrides java.lang.AbstractStringBuilder.append.

Implements java.lang.Appendable.append.

Doc from java.lang.Appendable.append.

Appends the specified character sequence to this Appendable.

Depending on which class implements the character sequence csq, the entire sequence may not be appended. For instance, if csq is a java.nio.CharBuffer then the subsequence to append is defined by the buffer's position and limit.

The contents of this Appendable are unspecified if the CharSequence is modified during the method call or an exception is thrown when accessing the CharSequence.

Annotations

@Override

Overrides java.lang.AbstractStringBuilder.append.

Implements java.lang.Appendable.append.

Doc from java.lang.Appendable.append.

Appends a subsequence of the specified character sequence to this Appendable.

An invocation of this method of the form out.append(csq, start, end) when csq is not null, behaves in exactly the same way as the invocation

    out.append(csq.subSequence(start, end)) 

The contents of this Appendable are unspecified if the CharSequence is modified during the method call or an exception is thrown when accessing the CharSequence.

Annotations

@Override

Exceptions

IndexOutOfBoundsException:

If start or end are negative, start is greater than end, or end is greater than csq.length()

Overrides java.lang.AbstractStringBuilder.append.

Doc from java.lang.AbstractStringBuilder.append.

Appends the string representation of the char array argument to this sequence.

The characters of the array argument are appended, in order, to the contents of this sequence. The length of this sequence increases by the length of the argument.

The overall effect is exactly as if the argument were converted to a string by the method String#valueOf(char[]), and the characters of that string were then appended to this character sequence.

Annotations

@Override

Overrides java.lang.AbstractStringBuilder.append.

Doc from java.lang.AbstractStringBuilder.append.

Appends the string representation of a subarray of the char array argument to this sequence.

Characters of the char array str, starting at index offset, are appended, in order, to the contents of this sequence. The length of this sequence increases by the value of len.

The overall effect is exactly as if the arguments were converted to a string by the method String#valueOf(char[], int, int), and the characters of that string were then appended to this character sequence.

Annotations

@Override

Exceptions

IndexOutOfBoundsException:

if offset < 0 or len < 0 or offset+len > str.length

Overrides java.lang.AbstractStringBuilder.append.

Doc from java.lang.AbstractStringBuilder.append.

Appends the string representation of the boolean argument to the sequence.

The overall effect is exactly as if the argument were converted to a string by the method String#valueOf(boolean), and the characters of that string were then appended to this character sequence.

Annotations

@Override

Overrides java.lang.AbstractStringBuilder.append.

Implements java.lang.Appendable.append.

Doc from java.lang.Appendable.append.

Appends the specified character to this Appendable.

Annotations

@Override

@IntrinsicCandidate

Overrides java.lang.AbstractStringBuilder.append.

Doc from java.lang.AbstractStringBuilder.append.

Appends the string representation of the int argument to this sequence.

The overall effect is exactly as if the argument were converted to a string by the method String#valueOf(int), and the characters of that string were then appended to this character sequence.

Annotations

@Override

@IntrinsicCandidate

Overrides java.lang.AbstractStringBuilder.append.

Doc from java.lang.AbstractStringBuilder.append.

Appends the string representation of the long argument to this sequence.

The overall effect is exactly as if the argument were converted to a string by the method String#valueOf(long), and the characters of that string were then appended to this character sequence.

Annotations

@Override

Overrides java.lang.AbstractStringBuilder.append.

Doc from java.lang.AbstractStringBuilder.append.

Appends the string representation of the float argument to this sequence.

The overall effect is exactly as if the argument were converted to a string by the method String#valueOf(float), and the characters of that string were then appended to this character sequence.

Annotations

@Override

Overrides java.lang.AbstractStringBuilder.append.

Doc from java.lang.AbstractStringBuilder.append.

Appends the string representation of the double argument to this sequence.

The overall effect is exactly as if the argument were converted to a string by the method String#valueOf(double), and the characters of that string were then appended to this character sequence.

Annotations

@Override

Overrides java.lang.AbstractStringBuilder.appendCodePoint.

Doc from java.lang.AbstractStringBuilder.appendCodePoint.

Appends the string representation of the codePoint argument to this sequence.

The argument is appended to the contents of this sequence. The length of this sequence increases by Character.charCount(codePoint).

The overall effect is exactly as if the argument were converted to a char array by the method Character#toChars(int) and the character in that array were then appended to this character sequence.

Annotations

@Override

Since

1.5

Implements java.lang.Comparable.compareTo.

Compares two StringBuilder instances lexicographically. This method follows the same rules for lexicographical comparison as defined in the CharSequence.compare(this, another) method.

For finer-grained, locale-sensitive String comparison, refer to java.text.Collator.

Parameters

another:StringBuilder

the StringBuilder to be compared with

Returns:int

the value 0 if this StringBuilder contains the same character sequence as that of the argument StringBuilder; a negative integer if this StringBuilder is lexicographically less than the StringBuilder argument; or a positive integer if this StringBuilder is lexicographically greater than the StringBuilder argument.

Annotations

@Override

Since

11

Overrides java.lang.AbstractStringBuilder.delete.

Doc from java.lang.AbstractStringBuilder.delete.

Removes the characters in a substring of this sequence. The substring begins at the specified start and extends to the character at index end - 1 or to the end of the sequence if no such character exists. If start is equal to end, no changes are made.

Annotations

@Override

Exceptions

StringIndexOutOfBoundsException:

if start is negative, greater than length(), or greater than end.

Overrides java.lang.AbstractStringBuilder.deleteCharAt.

Doc from java.lang.AbstractStringBuilder.deleteCharAt.

Removes the char at the specified position in this sequence. This sequence is shortened by one char.

Annotations

@Override

Exceptions

StringIndexOutOfBoundsException:

if the index is negative or greater than or equal to length().

Overrides java.lang.AbstractStringBuilder.indexOf.

Doc from java.lang.AbstractStringBuilder.indexOf.

Returns the index within this string of the first occurrence of the specified substring.

The returned index is the smallest value k for which:

this.toString().startsWith(str, k)

Annotations

@Override

Overrides java.lang.AbstractStringBuilder.indexOf.

Doc from java.lang.AbstractStringBuilder.indexOf.

Returns the index within this string of the first occurrence of the specified substring, starting at the specified index.

The returned index is the smallest value k for which:

k >= Math.min(fromIndex, this.length()) &&
                  this.toString().startsWith(str, k)

Annotations

@Override

Overrides java.lang.AbstractStringBuilder.insert.

Doc from java.lang.AbstractStringBuilder.insert.

Inserts the string representation of a subarray of the str array argument into this sequence. The subarray begins at the specified offset and extends len chars. The characters of the subarray are inserted into this sequence at the position indicated by index. The length of this sequence increases by len chars.

Annotations

@Override

Exceptions

StringIndexOutOfBoundsException:

if index is negative or greater than length(), or offset or len are negative, or (offset+len) is greater than str.length.

Overrides java.lang.AbstractStringBuilder.insert.

Doc from java.lang.AbstractStringBuilder.insert.

Inserts the string representation of the Object argument into this character sequence.

The overall effect is exactly as if the second argument were converted to a string by the method String#valueOf(Object), and the characters of that string were then inserted into this character sequence at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this sequence.

Annotations

@Override

Exceptions

StringIndexOutOfBoundsException:

if the offset is invalid.

Overrides java.lang.AbstractStringBuilder.insert.

Doc from java.lang.AbstractStringBuilder.insert.

Inserts the string into this character sequence.

The characters of the String argument are inserted, in order, into this sequence at the indicated offset, moving up any characters originally above that position and increasing the length of this sequence by the length of the argument. If str is null, then the four characters "null" are inserted into this sequence.

The character at index k in the new character sequence is equal to:

• the character at index k in the old character sequence, if k is less than offset
• the character at index k-offset in the argument str, if k is not less than offset but is less than offset+str.length()
• the character at index k-str.length() in the old character sequence, if k is not less than offset+str.length()

The offset argument must be greater than or equal to 0, and less than or equal to the length of this sequence.

Annotations

@Override

Exceptions

StringIndexOutOfBoundsException:

if the offset is invalid.

Overrides java.lang.AbstractStringBuilder.insert.

Doc from java.lang.AbstractStringBuilder.insert.

Inserts the string representation of the char array argument into this sequence.

The characters of the array argument are inserted into the contents of this sequence at the position indicated by offset. The length of this sequence increases by the length of the argument.

The overall effect is exactly as if the second argument were converted to a string by the method String#valueOf(char[]), and the characters of that string were then inserted into this character sequence at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this sequence.

Annotations

@Override

Exceptions

StringIndexOutOfBoundsException:

if the offset is invalid.

Overrides java.lang.AbstractStringBuilder.insert.

Doc from java.lang.AbstractStringBuilder.insert.

Inserts the specified CharSequence into this sequence.

The characters of the CharSequence argument are inserted, in order, into this sequence at the indicated offset, moving up any characters originally above that position and increasing the length of this sequence by the length of the argument s.

The result of this method is exactly the same as if it were an invocation of this object's insert(dstOffset, s, 0, s.length()) method.

The contents are unspecified if the CharSequence is modified during the method call or an exception is thrown when accessing the CharSequence.

If s is null, then the four characters "null" are inserted into this sequence.

Annotations

@Override

Exceptions

IndexOutOfBoundsException:

if the offset is invalid.

Overrides java.lang.AbstractStringBuilder.insert.

Doc from java.lang.AbstractStringBuilder.insert.

Inserts a subsequence of the specified CharSequence into this sequence.

The subsequence of the argument s specified by start and end are inserted, in order, into this sequence at the specified destination offset, moving up any characters originally above that position. The length of this sequence is increased by end - start.

The character at index k in this sequence becomes equal to:

• the character at index k in this sequence, if k is less than dstOffset
• the character at index k+start-dstOffset in the argument s, if k is greater than or equal to dstOffset but is less than dstOffset+end-start
• the character at index k-(end-start) in this sequence, if k is greater than or equal to dstOffset+end-start

The dstOffset argument must be greater than or equal to 0, and less than or equal to the length of this sequence.

The start argument must be non-negative, and not greater than end.

The end argument must be greater than or equal to start, and less than or equal to the length of s.

If s is null, then this method inserts characters as if the s parameter was a sequence containing the four characters "null".

The contents are unspecified if the CharSequence is modified during the method call or an exception is thrown when accessing the CharSequence.

Annotations

@Override

Exceptions

IndexOutOfBoundsException:

if dstOffset is negative or greater than this.length(), or start or end are negative, or start is greater than end or end is greater than s.length()

Overrides java.lang.AbstractStringBuilder.insert.

Doc from java.lang.AbstractStringBuilder.insert.

Inserts the string representation of the boolean argument into this sequence.

The overall effect is exactly as if the second argument were converted to a string by the method String#valueOf(boolean), and the characters of that string were then inserted into this character sequence at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this sequence.

Annotations

@Override

Exceptions

StringIndexOutOfBoundsException:

if the offset is invalid.

Overrides java.lang.AbstractStringBuilder.insert.

Doc from java.lang.AbstractStringBuilder.insert.

Inserts the string representation of the char argument into this sequence.

The overall effect is exactly as if the second argument were converted to a string by the method String#valueOf(char), and the character in that string were then inserted into this character sequence at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this sequence.

Annotations

@Override

Exceptions

IndexOutOfBoundsException:

if the offset is invalid.

Overrides java.lang.AbstractStringBuilder.insert.

Doc from java.lang.AbstractStringBuilder.insert.

Inserts the string representation of the second int argument into this sequence.

The overall effect is exactly as if the second argument were converted to a string by the method String#valueOf(int), and the characters of that string were then inserted into this character sequence at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this sequence.

Annotations

@Override

Exceptions

StringIndexOutOfBoundsException:

if the offset is invalid.

Overrides java.lang.AbstractStringBuilder.insert.

Doc from java.lang.AbstractStringBuilder.insert.

Inserts the string representation of the long argument into this sequence.

The overall effect is exactly as if the second argument were converted to a string by the method String#valueOf(long), and the characters of that string were then inserted into this character sequence at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this sequence.

Annotations

@Override

Exceptions

StringIndexOutOfBoundsException:

if the offset is invalid.

Overrides java.lang.AbstractStringBuilder.insert.

Doc from java.lang.AbstractStringBuilder.insert.

Inserts the string representation of the float argument into this sequence.

The overall effect is exactly as if the second argument were converted to a string by the method String#valueOf(float), and the characters of that string were then inserted into this character sequence at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this sequence.

Annotations

@Override

Exceptions

StringIndexOutOfBoundsException:

if the offset is invalid.

Overrides java.lang.AbstractStringBuilder.insert.

Doc from java.lang.AbstractStringBuilder.insert.

Inserts the string representation of the double argument into this sequence.

The overall effect is exactly as if the second argument were converted to a string by the method String#valueOf(double), and the characters of that string were then inserted into this character sequence at the indicated offset.

The offset argument must be greater than or equal to 0, and less than or equal to the length of this sequence.

Annotations

@Override

Exceptions

StringIndexOutOfBoundsException:

if the offset is invalid.

Overrides java.lang.AbstractStringBuilder.lastIndexOf.

Doc from java.lang.AbstractStringBuilder.lastIndexOf.

Returns the index within this string of the last occurrence of the specified substring. The last occurrence of the empty string "" is considered to occur at the index value this.length().

The returned index is the largest value k for which:

this.toString().startsWith(str, k)

Annotations

@Override

Overrides java.lang.AbstractStringBuilder.lastIndexOf.

Doc from java.lang.AbstractStringBuilder.lastIndexOf.

Returns the index within this string of the last occurrence of the specified substring, searching backward starting at the specified index.

The returned index is the largest value k for which:

k <= Math.min(fromIndex, this.length()) &&
                  this.toString().startsWith(str, k)

Annotations

@Override

Overrides java.lang.AbstractStringBuilder.repeat.

Doc from java.lang.AbstractStringBuilder.repeat.

Repeats count copies of the string representation of the codePoint argument to this sequence.

The length of this sequence increases by count times the string representation length.

It is usual to use char expressions for code points. For example:

// insert 10 asterisks into the buffer
sb.repeat('*', 10);

Annotations

@Override

Exceptions

IllegalArgumentException:

if the specified codePoint is not a valid Unicode code point or if count is negative.

Since

21

Overrides java.lang.AbstractStringBuilder.repeat.

Doc from java.lang.AbstractStringBuilder.repeat.

Appends count copies of the specified CharSequence cs to this sequence.

The length of this sequence increases by count times the CharSequence length.

If cs is null, then the four characters "null" are repeated into this sequence.

The contents are unspecified if the CharSequence is modified during the method call or an exception is thrown when accessing the CharSequence.

Annotations

@Override

Exceptions

IllegalArgumentException:

if count is negative

Since

21

Overrides java.lang.AbstractStringBuilder.replace.

Doc from java.lang.AbstractStringBuilder.replace.

Replaces the characters in a substring of this sequence with characters in the specified String. The substring begins at the specified start and extends to the character at index end - 1 or to the end of the sequence if no such character exists. First the characters in the substring are removed and then the specified String is inserted at start. (This sequence will be lengthened to accommodate the specified String if necessary.)

Annotations

@Override

Exceptions

StringIndexOutOfBoundsException:

if start is negative, greater than length(), or greater than end.

Overrides java.lang.AbstractStringBuilder.reverse.

Doc from java.lang.AbstractStringBuilder.reverse.

Causes this character sequence to be replaced by the reverse of the sequence. If there are any surrogate pairs included in the sequence, these are treated as single characters for the reverse operation. Thus, the order of the high-low surrogates is never reversed. Let n be the character length of this character sequence (not the length in char values) just prior to execution of the reverse method. Then the character at index k in the new character sequence is equal to the character at index n-k-1 in the old character sequence.

Note that the reverse operation may result in producing surrogate pairs that were unpaired low-surrogates and high-surrogates before the operation. For example, reversing "\uDC00\uD800" produces "\uD800\uDC00" which is a valid surrogate pair.

Annotations

@Override

Implements abstract java.lang.AbstractStringBuilder.toString.

Implements java.lang.CharSequence.toString.

Doc from java.lang.CharSequence.toString.

Returns a string containing the characters in this sequence in the same order as this sequence. The length of the string will be the length of this sequence.

Annotations

@Override

@IntrinsicCandidate