---

java.lang
Class StringBuffer

java.lang.Object
 |
 +--java.lang.StringBuffer

All Implemented Interfaces:

CharSequence, Serializable

---

public final class StringBuffer

extends Object

implements Serializable, CharSequence

Safe:

See Also:

Serialized Form

---

value

private char[] value

The value is used for character storage.

---

count

private int count

The count is the number of characters in the buffer.

---

shared

private boolean shared

A flag indicating whether the buffer is shared

---

serialVersionUID

static final long serialVersionUID

use serialVersionUID from JDK 1.0.2 for interoperability

---

NULL

private static final StringBuffer NULL

StringBuffer

public StringBuffer()

Enabled: Constructs a string buffer with no characters in it and an initial capacity of 16 characters.

---

StringBuffer

public StringBuffer(int length)

Enabled: Constructs a string buffer with no characters in it and an initial capacity specified by the length argument.

Parameters:

length - the initial capacity.

---

StringBuffer

public StringBuffer(String str)

Enabled: Constructs a string buffer so that it represents the same sequence of characters as the string argument; in other words, the initial contents of the string buffer is a copy of the argument string. The initial capacity of the string buffer is 16 plus the length of the string argument.

Parameters:

str - the initial contents of the buffer.

length

public int length()

Enabled: Returns the length (character count) of this string buffer.

Specified by:

length in interface CharSequence

Returns:

the length of the sequence of characters currently represented by this string buffer.

---

capacity

public int capacity()

Enabled: Returns the current capacity of the String buffer. The capacity is the amount of storage available for newly inserted characters; beyond which an allocation will occur.

Returns:

the current capacity of this string buffer.

---

copy

private final void copy()

Copies the buffer value. This is normally only called when shared is true. It should only be called from a synchronized method.

---

ensureCapacity

public void ensureCapacity(int minimumCapacity)

Enabled: Ensures that the capacity of the buffer is at least equal to the specified minimum. If the current capacity of this string buffer is less than the argument, then a new internal buffer is allocated with greater capacity. The new capacity is the larger of:

• The minimumCapacity argument.
• Twice the old capacity, plus 2.

If the minimumCapacity argument is nonpositive, this method takes no action and simply returns.

Parameters:

minimumCapacity - the minimum desired capacity.

---

expandCapacity

private void expandCapacity(int minimumCapacity)

This implements the expansion semantics of ensureCapacity but is unsynchronized for use internally by methods which are already synchronized.

See Also:

java.lang.StringBuffer#ensureCapacity(int)

---

setLength

public void setLength(int newLength)

Enabled: Sets the length of this String buffer. This string buffer is altered to represent a new character sequence whose length is specified by the argument. For every nonnegative index k less than newLength, the character at index k in the new character sequence is the same as the character at index k in the old sequence if k is less than the length of the old character sequence; otherwise, it is the null character '\u0000'. In other words, if the newLength argument is less than the current length of the string buffer, the string buffer is truncated to contain exactly the number of characters given by the newLength argument.

If the newLength argument is greater than or equal to the current length, sufficient null characters ('\u0000') are appended to the string buffer so that length becomes the newLength argument.

The newLength argument must be greater than or equal to 0.

Parameters:

newLength - the new length of the buffer.

See Also:

java.lang.StringBuffer#length()

---

charAt

public char charAt(int index)

Enabled: The specified character of the sequence currently represented by the string buffer, as indicated by the index argument, is returned. The first character of a string buffer is at index 0, the next at index 1, and so on, for array indexing.

The index argument must be greater than or equal to 0, and less than the length of this string buffer.

Specified by:

charAt in interface CharSequence

Parameters:

index - the index of the desired character.

Returns:

the character at the specified index of this string buffer.

See Also:

java.lang.StringBuffer#length()

---

getChars

public void getChars(int srcBegin,
 int srcEnd,
 char[] dst,
 int dstBegin)

Enabled: Characters are copied from this string buffer into the destination character array dst. The first character to be copied is at index srcBegin; the last character to be copied is at index srcEnd-1. The total number of characters to be copied is srcEnd-srcBegin. The characters are copied into the subarray of dst starting at index dstBegin and ending at index:

 dstbegin + (srcEnd-srcBegin) - 1
 

Parameters:

srcBegin - start copying at this offset in the string buffer.

srcEnd - stop copying at this offset in the string buffer.

dst - the array to copy the data into.

dstBegin - offset into dst.

---

setCharAt

public void setCharAt(int index,
 char ch)

Enabled: The character at the specified index of this string buffer is set to ch. The string buffer is altered to represent a new character sequence that is identical to the old character sequence, except that it contains the character ch at position index.

The index argument must be greater than or equal to 0, and less than the length of this string buffer.

Parameters:

index - the index of the character to modify.

ch - the new character.

See Also:

java.lang.StringBuffer#length()

---

append

public StringBuffer append(Object obj)

Enabled: Appends the string representation of the Object argument to this string buffer.

The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer.

Parameters:

obj - an Object.

Returns:

a reference to this StringBuffer object.

See Also:

java.lang.String#valueOf(java.lang.Object), java.lang.StringBuffer#append(java.lang.String)

---

append

public StringBuffer append(String str)

Enabled: Appends the string to this string buffer.

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

Let n be the length of the old character sequence, the one contained in the string buffer 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.

Parameters:

str - a string.

Returns:

a reference to this StringBuffer.

---

append

public StringBuffer append(StringBuffer sb)

Suppressed: Appends the specified StringBuffer to this StringBuffer.

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

Let n be the length of the old character sequence, the one contained in the StringBuffer 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.

The method ensureCapacity is first called on this StringBuffer with the new buffer length as its argument. (This ensures that the storage of this StringBuffer is adequate to contain the additional characters being appended.)

Parameters:

sb - the StringBuffer to append.

Returns:

a reference to this StringBuffer.

Since:

1.4

---

append

public StringBuffer append(char[] str)

Enabled: Appends the string representation of the char array argument to this string buffer.

The characters of the array argument are appended, in order, to the contents of this string buffer. The length of this string buffer 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 StringBuffer object.

Parameters:

str - the characters to be appended.

Returns:

a reference to this StringBuffer object.

---

append

public StringBuffer append(char[] str,
 int offset,
 int len)

Enabled: Appends the string representation of a subarray of the char array argument to this string buffer.

Characters of the character array str, starting at index offset, are appended, in order, to the contents of this string buffer. The length of this string buffer 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 StringBuffer object.

Parameters:

str - the characters to be appended.

offset - the index of the first character to append.

len - the number of characters to append.

Returns:

a reference to this StringBuffer object.

---

append

public StringBuffer append(boolean b)

Enabled: Appends the string representation of the boolean argument to the string buffer.

The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer.

Parameters:

b - a boolean.

Returns:

a reference to this StringBuffer.

See Also:

java.lang.String#valueOf(boolean), java.lang.StringBuffer#append(java.lang.String)

---

append

public StringBuffer append(char c)

Enabled: Appends the string representation of the char argument to this string buffer.

The argument is appended to the contents of this string buffer. The length of this string buffer increases by 1.

The overall effect is exactly as if the argument were converted to a string by the method String.valueOf(char) and the character in that string were then appended to this StringBuffer object.

Parameters:

c - a char.

Returns:

a reference to this StringBuffer object.

---

append

public StringBuffer append(int i)

Enabled: Appends the string representation of the int argument to this string buffer.

The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer.

Parameters:

i - an int.

Returns:

a reference to this StringBuffer object.

See Also:

java.lang.String#valueOf(int), java.lang.StringBuffer#append(java.lang.String)

---

append

public StringBuffer append(long l)

Enabled: Appends the string representation of the long argument to this string buffer.

The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer.

Parameters:

l - a long.

Returns:

a reference to this StringBuffer object.

See Also:

java.lang.String#valueOf(long), java.lang.StringBuffer#append(java.lang.String)

---

append

public StringBuffer append(float f)

Enabled: Appends the string representation of the float argument to this string buffer.

The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer.

Parameters:

f - a float.

Returns:

a reference to this StringBuffer object.

See Also:

java.lang.String#valueOf(float), java.lang.StringBuffer#append(java.lang.String)

---

append

public StringBuffer append(double d)

Enabled: Appends the string representation of the double argument to this string buffer.

The argument is converted to a string as if by the method String.valueOf, and the characters of that string are then appended to this string buffer.

Parameters:

d - a double.

Returns:

a reference to this StringBuffer object.

See Also:

java.lang.String#valueOf(double), java.lang.StringBuffer#append(java.lang.String)

---

delete

public StringBuffer delete(int start,
 int end)

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

Parameters:

start - The beginning index, inclusive.

end - The ending index, exclusive.

Returns:

This string buffer.

Since:

1.2

---

deleteCharAt

public StringBuffer deleteCharAt(int index)

Enabled: Removes the character at the specified position in this StringBuffer (shortening the StringBuffer by one character).

Parameters:

index - Index of character to remove

Returns:

This string buffer.

Since:

1.2

---

replace

public StringBuffer replace(int start,
 int end,
 String str)

Enabled: Replaces the characters in a substring of this StringBuffer 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 StringBuffer if no such character exists. First the characters in the substring are removed and then the specified String is inserted at start. (The StringBuffer will be lengthened to accommodate the specified String if necessary.)

Parameters:

start - The beginning index, inclusive.

end - The ending index, exclusive.

str - String that will replace previous contents.

Returns:

This string buffer.

Since:

1.2

---

substring

public String substring(int start)

Enabled: Returns a new String that contains a subsequence of characters currently contained in this StringBuffer.The substring begins at the specified index and extends to the end of the StringBuffer.

Parameters:

start - The beginning index, inclusive.

Returns:

The new string.

Since:

1.2

---

subSequence

public CharSequence subSequence(int start,
 int end)

Enabled: Returns a new character sequence that is a subsequence of this sequence.

An invocation of this method of the form

 sb.subSequence(begin, end)

behaves in exactly the same way as the invocation

 sb.substring(begin, end)

This method is provided so that the StringBuffer class can implement the CharSequence interface.

Specified by:

subSequence in interface CharSequence

Parameters:

start - the start index, inclusive.

end - the end index, exclusive.

Returns:

the specified subsequence.

Throws:

IndexOutOfBoundsException - if start or end are negative, if end is greater than length(), or if start is greater than end

Since:

1.4

---

substring

public String substring(int start,
 int end)

Enabled: Returns a new String that contains a subsequence of characters currently contained in this StringBuffer. The substring begins at the specified start and extends to the character at index end - 1. An exception is thrown if

Parameters:

start - The beginning index, inclusive.

end - The ending index, exclusive.

Returns:

The new string.

Since:

1.2

---

insert

public StringBuffer insert(int index,
 char[] str,
 int offset,
 int len)

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

Parameters:

index - position at which to insert subarray.

str - A character array.

offset - the index of the first character in subarray to to be inserted.

len - the number of characters in the subarray to to be inserted.

Returns:

This string buffer.

Since:

1.2

---

insert

public StringBuffer insert(int offset,
 Object obj)

Enabled: Inserts the string representation of the Object argument into this string buffer.

The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this string buffer 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 string buffer.

Parameters:

offset - the offset.

obj - an Object.

Returns:

a reference to this StringBuffer object.

See Also:

java.lang.String#valueOf(java.lang.Object), java.lang.StringBuffer#insert(int, java.lang.String), java.lang.StringBuffer#length()

---

insert

public StringBuffer insert(int offset,
 String str)

Enabled: Inserts the string into this string buffer.

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

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 string buffer.

Parameters:

offset - the offset.

str - a string.

Returns:

a reference to this StringBuffer object.

See Also:

java.lang.StringBuffer#length()

---

insert

public StringBuffer insert(int offset,
 char[] str)

Enabled: Inserts the string representation of the char array argument into this string buffer.

The characters of the array argument are inserted into the contents of this string buffer at the position indicated by offset. The length of this string buffer 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 inserted into this StringBuffer object at the position indicated by offset.

Parameters:

offset - the offset.

str - a character array.

Returns:

a reference to this StringBuffer object.

---

insert

public StringBuffer insert(int offset,
 boolean b)

Enabled: Inserts the string representation of the boolean argument into this string buffer.

The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this string buffer 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 string buffer.

Parameters:

offset - the offset.

b - a boolean.

Returns:

a reference to this StringBuffer object.

See Also:

java.lang.String#valueOf(boolean), java.lang.StringBuffer#insert(int, java.lang.String), java.lang.StringBuffer#length()

---

insert

public StringBuffer insert(int offset,
 char c)

Enabled: Inserts the string representation of the char argument into this string buffer.

The second argument is inserted into the contents of this string buffer at the position indicated by offset. The length of this string buffer increases by one.

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

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

Parameters:

offset - the offset.

c - a char.

Returns:

a reference to this StringBuffer object.

See Also:

java.lang.StringBuffer#length()

---

insert

public StringBuffer insert(int offset,
 int i)

Enabled: Inserts the string representation of the second int argument into this string buffer.

The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this string buffer 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 string buffer.

Parameters:

offset - the offset.

i - an int.

Returns:

a reference to this StringBuffer object.

See Also:

java.lang.String#valueOf(int), java.lang.StringBuffer#insert(int, java.lang.String), java.lang.StringBuffer#length()

---

insert

public StringBuffer insert(int offset,
 long l)

Enabled: Inserts the string representation of the long argument into this string buffer.

The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this string buffer at the position indicated by offset.

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

Parameters:

offset - the offset.

l - a long.

Returns:

a reference to this StringBuffer object.

See Also:

java.lang.String#valueOf(long), java.lang.StringBuffer#insert(int, java.lang.String), java.lang.StringBuffer#length()

---

insert

public StringBuffer insert(int offset,
 float f)

Enabled: Inserts the string representation of the float argument into this string buffer.

The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this string buffer 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 string buffer.

Parameters:

offset - the offset.

f - a float.

Returns:

a reference to this StringBuffer object.

See Also:

java.lang.String#valueOf(float), java.lang.StringBuffer#insert(int, java.lang.String), java.lang.StringBuffer#length()

---

insert

public StringBuffer insert(int offset,
 double d)

Enabled: Inserts the string representation of the double argument into this string buffer.

The second argument is converted to a string as if by the method String.valueOf, and the characters of that string are then inserted into this string buffer 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 string buffer.

Parameters:

offset - the offset.

d - a double.

Returns:

a reference to this StringBuffer object.

See Also:

java.lang.String#valueOf(double), java.lang.StringBuffer#insert(int, java.lang.String), java.lang.StringBuffer#length()

---

indexOf

public int indexOf(String str)

Suppressed: Returns the index within this string of the first occurrence of the specified substring. The integer returned is the smallest value k such that:

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

is true.

Parameters:

str - any string.

Returns:

if the string argument occurs as a substring within this object, then the index of the first character of the first such substring is returned; if it does not occur as a substring, -1 is returned.

Since:

1.4

---

indexOf

public int indexOf(String str,
 int fromIndex)

Suppressed: Returns the index within this string of the first occurrence of the specified substring, starting at the specified index. The integer returned is the smallest value k for which:

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

If no such value of k exists, then -1 is returned.

Parameters:

str - the substring for which to search.

fromIndex - the index from which to start the search.

Returns:

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

Since:

1.4

---

lastIndexOf

public int lastIndexOf(String str)

Suppressed: Returns the index within this string of the rightmost occurrence of the specified substring. The rightmost empty string "" is considered to occur at the index value this.length(). The returned index is the largest value k such that

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

is true.

Parameters:

str - the substring to search for.

Returns:

if the string argument occurs one or more times as a substring within this object, then the index of the first character of the last such substring is returned. If it does not occur as a substring, -1 is returned.

Since:

1.4

---

lastIndexOf

public int lastIndexOf(String str,
 int fromIndex)

Suppressed: Returns the index within this string of the last occurrence of the specified substring. The integer returned is the largest value k such that:

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

If no such value of k exists, then -1 is returned.

Parameters:

str - the substring to search for.

fromIndex - the index to start the search from.

Returns:

the index within this string of the last occurrence of the specified substring.

Since:

1.4

---

reverse

public StringBuffer reverse()

Enabled: The character sequence contained in this string buffer is replaced by the reverse of the sequence.

Let n be the length of the old character sequence, the one contained in the string buffer 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.

Returns:

a reference to this StringBuffer object.

Since:

JDK1.0.2

---

toString

public String toString()

Suppressed: Converts to a string representing the data in this string buffer. A new String object is allocated and initialized to contain the character sequence currently represented by this string buffer. This String is then returned. Subsequent changes to the string buffer do not affect the contents of the String.

Implementation advice: This method can be coded so as to create a new String object without allocating new memory to hold a copy of the character sequence. Instead, the string can share the memory used by the string buffer. Any subsequent operation that alters the content or capacity of the string buffer must then make a copy of the internal buffer at that time. This strategy is effective for reducing the amount of memory allocated by a string concatenation operation when it is implemented using a string buffer.

Specified by:

toString in interface CharSequence

Overrides:

toString in class Object

Returns:

a string representation of the string buffer.

---

setShared

final void setShared()

---

getValue

final char[] getValue()

---

readObject

private void readObject(ObjectInputStream s)
 throws IOException,
 ClassNotFoundException

readObject is called to restore the state of the StringBuffer from a stream.

IOException

ClassNotFoundException

---

get

public char get(int index)

Added: "bar"[2] == 'r'

---

size

public int size()

Added:

---

snapshot

public String snapshot()

Added: Just like the Java-level toString, but avoids confusion with Object.toString().

---

iterate

public void iterate(AssocFunc func)

Added: Considered as a map, an array is a ConstMap from indices to values, so iterate() will call func with each successive pair of index and value, in ascending index order.

---

---