| java.lang.Object
 java.lang.StringBuffer
| StringBuffer | | final public class StringBuffer (Code) | | A string buffer implements a mutable sequence of characters.
A string buffer is like a
String , but can be modified. At any
point in time it contains some particular sequence of characters, but
the length and content of the sequence can be changed through certain
method calls.
String buffers are safe for use by multiple threads. The methods
are synchronized where necessary so that all the operations on any
particular instance behave as if they occur in some serial order
that is consistent with the order of the method calls made by each of
the individual threads involved.
String buffers are used by the compiler to implement the binary
string concatenation operator +. For example, the code:
x = "a" + 4 + "c"
is compiled to the equivalent of:
x = new StringBuffer().append("a").append(4).append("c")
.toString()
which creates a new string buffer (initially empty), appends the string
representation of each operand to the string buffer in turn, and then
converts the contents of the string buffer to a string. Overall, this avoids
creating many temporary strings.
The principal operations on a StringBuffer are the
append and insert methods, which are
overloaded so as to accept data of any type. Each effectively
converts a given datum to a string and then appends or inserts the
characters of that string to the string buffer. The
append method always adds these characters at the end
of the buffer; the insert method adds the characters at
a specified point.
For example, if z refers to a string buffer object
whose current contents are "start", then
the method call z.append("le") would cause the string
buffer to contain "startle", whereas
z.insert(4, "le") would alter the string buffer to
contain "starlet".
In general, if sb refers to an instance of a StringBuffer,
then sb.append(x) has the same effect as
sb.insert(sb.length(), x).
Every string buffer has a capacity. As long as the length of the
character sequence contained in the string buffer does not exceed
the capacity, it is not necessary to allocate a new internal
buffer array. If the internal buffer overflows, it is
automatically made larger.
version:
12/17/01 (CLDC 1.1)
See Also: java.io.ByteArrayOutputStream
See Also: java.lang.String
since:
JDK1.0, CLDC 1.0 |
| Constructor Summary | |
| public | StringBuffer()
Constructs a string buffer with no characters in it and an
initial capacity of 16 characters. | | public | StringBuffer(int length)
Constructs a string buffer with no characters in it and an
initial capacity specified by the length argument. | | public | StringBuffer(String str)
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. |
| Method Summary | |
| public synchronized StringBuffer | append(Object obj)
Appends the string representation of the Object
argument to this string buffer. | | public synchronized StringBuffer | append(String str)
Appends the string to this string buffer. | | public synchronized StringBuffer | append(char str)
Appends the string representation of the char array
argument to this string buffer. | | public synchronized StringBuffer | append(char str, int offset, int len)
Appends the string representation of a subarray of the
char array argument to this string buffer. | | public StringBuffer | append(boolean b)
Appends the string representation of the boolean
argument to the string buffer. | | public synchronized StringBuffer | append(char c)
Appends the string representation of the char
argument to this string buffer. | | public StringBuffer | append(int i)
Appends the string representation of the int
argument to this string buffer. | | public StringBuffer | append(long l)
Appends the string representation of the long
argument to this string buffer. | | public StringBuffer | append(float f)
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. | | public StringBuffer | append(double d)
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. | | public int | capacity()
Returns the current capacity of the String buffer. | | public synchronized char | charAt(int index)
The specified character of the sequence currently represented by
the string buffer, as indicated by the index argument,
is returned. | | public synchronized StringBuffer | delete(int start, int end)
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. | | public synchronized StringBuffer | deleteCharAt(int index)
Removes the character at the specified position in this
StringBuffer (shortening the StringBuffer
by one character). | | public synchronized void | ensureCapacity(int minimumCapacity)
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. | | public synchronized void | getChars(int srcBegin, int srcEnd, char dst, int dstBegin)
Characters are copied from this string buffer into the
destination character array dst. | | final char[] | getValue()
| | public synchronized StringBuffer | insert(int offset, Object obj)
Inserts the string representation of the Object
argument into this string buffer. | | public synchronized StringBuffer | insert(int offset, String str)
Inserts the string into this string buffer. | | public synchronized StringBuffer | insert(int offset, char str)
Inserts the string representation of the char array
argument into this string buffer. | | public StringBuffer | insert(int offset, boolean b)
Inserts the string representation of the boolean
argument into this string buffer. | | public synchronized StringBuffer | insert(int offset, char c)
Inserts the string representation of the char
argument into this string buffer. | | public StringBuffer | insert(int offset, int i)
Inserts the string representation of the second int
argument into this string buffer. | | public StringBuffer | insert(int offset, long l)
Inserts the string representation of the long
argument into this string buffer. | | public StringBuffer | insert(int offset, float f)
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.
Parameters:
f - a float. | | public StringBuffer | insert(int offset, double d)
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.
Parameters:
d - a double. | | public int | length()
Returns the length (character count) of this string buffer. | | public synchronized StringBuffer | reverse()
The character sequence contained in this string buffer is
replaced by the reverse of the sequence. | | public synchronized void | setCharAt(int index, char ch)
The character at the specified index of this string buffer is set
to ch. | | public synchronized void | setLength(int newLength)
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. | | final void | setShared()
| | public String | toString()
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. |
| StringBuffer | | public StringBuffer()(Code) | | Constructs a string buffer with no characters in it and an
initial capacity of 16 characters.
|
| StringBuffer | | public StringBuffer(int length)(Code) | | Constructs a string buffer with no characters in it and an
initial capacity specified by the length argument.
Parameters:
length - the initial capacity.
exception:
NegativeArraySizeException - if the lengthargument is less than 0. |
| StringBuffer | | public StringBuffer(String str)(Code) | | 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. |
| append | | public synchronized StringBuffer append(String str)(Code) | | 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. a reference to this StringBuffer. |
| append | | public synchronized StringBuffer append(char str)(Code) | | 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
StringBuffer.append(String) appended
to this StringBuffer object.
Parameters:
str - the characters to be appended. a reference to this StringBuffer object. |
| append | | public synchronized StringBuffer append(char str, int offset, int len)(Code) | | 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[]intint) and the
characters of that string were then
StringBuffer.append(String) appended
to this StringBuffer object.
Parameters:
str - the characters to be appended.
Parameters:
offset - the index of the first character to append.
Parameters:
len - the number of characters to append. a reference to this StringBuffer object. |
| append | | public synchronized StringBuffer append(char c)(Code) | | 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
StringBuffer.append(String) appended to this
StringBuffer object.
Parameters:
c - a char. a reference to this StringBuffer object. |
| capacity | | public int capacity()(Code) | | 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.
the current capacity of this string buffer. |
| charAt | | public synchronized char charAt(int index)(Code) | | 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.
Parameters:
index - the index of the desired character. the character at the specified index of this string buffer.
exception:
IndexOutOfBoundsException - if index is negative or greater than or equal to length().
See Also: java.lang.StringBuffer.length |
| delete | | public synchronized StringBuffer delete(int start, int end)(Code) | | 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.
Parameters:
end - The ending index, exclusive. This string buffer.
exception:
StringIndexOutOfBoundsException - if startis negative, greater than length(), orgreater than end.
since:
JDK1.2 |
| deleteCharAt | | public synchronized StringBuffer deleteCharAt(int index)(Code) | | Removes the character at the specified position in this
StringBuffer (shortening the StringBuffer
by one character).
Parameters:
index - Index of character to remove This string buffer.
exception:
StringIndexOutOfBoundsException - if the indexis negative or greater than or equal tolength().
since:
JDK1.2 |
| ensureCapacity | | public synchronized void ensureCapacity(int minimumCapacity)(Code) | | 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. |
| getChars | | public synchronized void getChars(int srcBegin, int srcEnd, char dst, int dstBegin)(Code) | | 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.
Parameters:
srcEnd - stop copying at this offset in the string buffer.
Parameters:
dst - the array to copy the data into.
Parameters:
dstBegin - offset into dst.
exception:
NullPointerException - if dst is null.
exception:
IndexOutOfBoundsException - if any of the following is true:srcBegin is negativedstBegin is negative- the
srcBegin argument is greater than the srcEnd argument. srcEnd is greater than this.length(), the current length of this string buffer.dstBegin+srcEnd-srcBegin is greater than dst.length
|
| getValue | | final char[] getValue()(Code) | | |
| insert | | public synchronized StringBuffer insert(int offset, String str)(Code) | | 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.
Parameters:
str - a string. a reference to this StringBuffer object.
exception:
StringIndexOutOfBoundsException - if the offset is invalid.
See Also: java.lang.StringBuffer.length |
| insert | | public synchronized StringBuffer insert(int offset, char str)(Code) | | 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
StringBuffer.insert(int,String) inserted into this
StringBuffer object at the position indicated by
offset.
Parameters:
offset - the offset.
Parameters:
str - a character array. a reference to this StringBuffer object.
exception:
StringIndexOutOfBoundsException - if the offset is invalid. |
| insert | | public synchronized StringBuffer insert(int offset, char c)(Code) | | 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
StringBuffer.insert(int,String) 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.
Parameters:
c - a char. a reference to this StringBuffer object.
exception:
IndexOutOfBoundsException - if the offset is invalid.
See Also: java.lang.StringBuffer.length |
| length | | public int length()(Code) | | Returns the length (character count) of this string buffer.
the length of the sequence of characters currently represented by this string buffer. |
| reverse | | public synchronized StringBuffer reverse()(Code) | | 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.
a reference to this StringBuffer object..
since:
JDK1.0.2 |
| setCharAt | | public synchronized void setCharAt(int index, char ch)(Code) | | 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 offset 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.
Parameters:
ch - the new character.
exception:
IndexOutOfBoundsException - if index is negative or greater than or equal to length().
See Also: java.lang.StringBuffer.length |
| setLength | | public synchronized void setLength(int newLength)(Code) | | 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.
exception:
IndexOutOfBoundsException - if thenewLength argument is negative.
See Also: java.lang.StringBuffer.length |
| setShared | | final void setShared()(Code) | | |
| toString | | public String toString()(Code) | | 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.
a string representation of the string buffer. |
|
|