|
FlexDoc/Javadoc 2.0 Demo Java Doc |
The principal operations on a StringBuilder 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 builder. The append method always adds these characters at the end of the builder; the insert method adds the characters at a specified point.
For example, if z refers to a string builder object whose current contents are "start", then the method call z.append("le") would cause the string builder to contain "startle", whereas z.insert(4, "le") would alter the string builder to contain "starlet".
In general, if sb refers to an instance of a StringBuilder, then sb.append(x) has the same effect as sb.insert(sb.length(), x).
Every string builder has a capacity. As long as the length of the character sequence contained in the string builder does not exceed the capacity, it is not necessary to allocate a new internal buffer. If the internal buffer overflows, it is automatically made larger.
Instances of StringBuilder are not safe for use by multiple threads. If such synchronization is required then it is recommended that StringBuffer be used.
Unless otherwise noted, passing a null argument to a constructor or method in this class will cause a NullPointerException to be thrown.
Constructor Summary |
||
Constructs a string builder with no characters in it and an
initial capacity of 16 characters.
|
||
Constructs a string builder that contains the same characters
as the specified CharSequence.
|
||
StringBuilder(int capacity)
Constructs a string builder with no characters in it and an
initial capacity specified by the capacity argument.
|
||
StringBuilder(String str)
Constructs a string builder initialized to the contents of the
specified string.
|
Method Summary |
||
append(boolean b)
Appends the string representation of the boolean
argument to the sequence.
|
||
append(char c)
Appends the string representation of the char
argument to this sequence.
|
||
append(char[] str)
Appends the string representation of the char array
argument to this sequence.
|
||
append(char[] str, int offset, int len)
Appends the string representation of a subarray of the
char array argument to this sequence.
|
||
Appends the specified character sequence to this Appendable.
|
||
append(CharSequence s, int start, int end)
Appends a subsequence of the specified CharSequence to this
sequence.
|
||
append(double d)
Appends the string representation of the double
argument to this sequence.
|
||
append(float f)
Appends the string representation of the float
argument to this sequence.
|
||
append(int i)
Appends the string representation of the int
argument to this sequence.
|
||
append(long lng)
Appends the string representation of the long
argument to this sequence.
|
||
Appends the string representation of the Object argument.
|
||
Appends the specified string to this character sequence.
|
||
append(StringBuffer sb)
Appends the specified StringBuffer to this sequence.
|
||
appendCodePoint(int codePoint)
Appends the string representation of the codePoint
argument to this sequence.
|
||
int |
capacity()
Returns the current capacity.
|
|
char |
charAt(int index)
Returns the char value in this sequence at the specified index.
|
|
chars()
Returns a stream of int zero-extending the char values
from this sequence.
|
||
int |
codePointAt(int index)
Returns the character (Unicode code point) at the specified
index.
|
|
int |
codePointBefore(int index)
Returns the character (Unicode code point) before the specified
index.
|
|
int |
codePointCount(int beginIndex, int endIndex)
Returns the number of Unicode code points in the specified text
range of this sequence.
|
|
Returns a stream of code point values from this sequence.
|
||
int |
compareTo(StringBuilder another)
Compares two StringBuilder instances lexicographically.
|
|
delete(int start, int end)
Removes the characters in a substring of this sequence.
|
||
deleteCharAt(int index)
Removes the char at the specified position in this
sequence.
|
||
void |
ensureCapacity(int minimumCapacity)
Ensures that the capacity is at least equal to the specified minimum.
|
|
void |
getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin)
Characters are copied from this sequence into the
destination character array dst.
|
|
int |
Returns the index within this string of the first occurrence of the
specified substring.
|
|
int |
Returns the index within this string of the first occurrence of the
specified substring, starting at the specified index.
|
|
insert(int offset, boolean b)
Inserts the string representation of the boolean
argument into this sequence.
|
||
insert(int offset, char c)
Inserts the string representation of the char
argument into this sequence.
|
||
insert(int offset, char[] str)
Inserts the string representation of the char array
argument into this sequence.
|
||
insert(int index, char[] str, int offset, int len)
Inserts the string representation of a subarray of the str
array argument into this sequence.
|
||
insert(int dstOffset, CharSequence s)
Inserts the specified CharSequence into this sequence.
|
||
insert(int dstOffset, CharSequence s, int start, int end)
Inserts a subsequence of the specified CharSequence into
this sequence.
|
||
insert(int offset, double d)
Inserts the string representation of the double
argument into this sequence.
|
||
insert(int offset, float f)
Inserts the string representation of the float
argument into this sequence.
|
||
insert(int offset, int i)
Inserts the string representation of the second int
argument into this sequence.
|
||
insert(int offset, long l)
Inserts the string representation of the long
argument into this sequence.
|
||
Inserts the string representation of the Object
argument into this character sequence.
|
||
Inserts the string into this character sequence.
|
||
int |
lastIndexOf(String str)
Returns the index within this string of the last occurrence of the
specified substring.
|
|
int |
lastIndexOf(String str, int fromIndex)
Returns the index within this string of the last occurrence of the
specified substring, searching backward starting at the specified index.
|
|
int |
length()
Returns the length (character count).
|
|
int |
offsetByCodePoints(int index, int codePointOffset)
Returns the index within this sequence that is offset from the
given index by codePointOffset code
points.
|
|
Replaces the characters in a substring of this sequence
with characters in the specified String.
|
||
reverse()
Causes this character sequence to be replaced by the reverse of
the sequence.
|
||
void |
setCharAt(int index, char ch)
The character at the specified index is set to ch.
|
|
void |
setLength(int newLength)
Sets the length of the character sequence.
|
|
subSequence(int start, int end)
Returns a new character sequence that is a subsequence of this sequence.
|
||
substring(int start)
Returns a new String that contains a subsequence of
characters currently contained in this character sequence.
|
||
substring(int start, int end)
Returns a new String that contains a subsequence of
characters currently contained in this sequence.
|
||
toString()
Returns a string representing the data in this sequence.
|
||
void |
Attempts to reduce storage used for the character sequence.
|
Methods inherited from class java.lang.Object |
Methods inherited from interface java.lang.CharSequence |
public StringBuilder |
() |
public StringBuilder |
(int capacity) |
public StringBuilder |
(String str) |
public StringBuilder |
(CharSequence seq) |
public int length |
() |
public int capacity |
() |
public void ensureCapacity |
(int minimumCapacity) |
public void trimToSize |
() |
public void setLength |
(int newLength) |
If the newLength argument is greater than or equal to the current length, sufficient null characters ('\u0000') are appended so that length becomes the newLength argument.
The newLength argument must be greater than or equal to 0.
public char charAt |
(int index) |
The index argument must be greater than or equal to 0, and less than the length of this sequence.
If the char value specified by the index is a surrogate, the surrogate value is returned.
public int codePointAt |
(int index) |
If the char value specified at the given index is in the high-surrogate range, the following index is less than the length of this sequence, and the char value at the following index is in the low-surrogate range, then the supplementary code point corresponding to this surrogate pair is returned. Otherwise, the char value at the given index is returned.
public int codePointBefore |
(int index) |
If the char value at (index - 1) is in the low-surrogate range, (index - 2) is not negative, and the char value at (index - 2) is in the high-surrogate range, then the supplementary code point value of the surrogate pair is returned. If the char value at index - 1 is an unpaired low-surrogate or a high-surrogate, the surrogate value is returned.
public int codePointCount |
(int beginIndex, int endIndex) |
public int offsetByCodePoints |
(int index, int codePointOffset) |
public void getChars |
(int srcBegin, int srcEnd, char[] dst, int dstBegin) |
dstbegin + (srcEnd-srcBegin) - 1
public void setCharAt |
(int index, char ch) |
The index argument must be greater than or equal to 0, and less than the length of this sequence.
public String substring |
(int start) |
public CharSequence subSequence |
(int start, int end) |
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 this class can
implement the CharSequence interface.
public String substring |
(int start, int end) |
public IntStream chars |
() |
The stream binds to this sequence when the terminal stream operation commences (specifically, for mutable sequences the spliterator for the stream is late-binding). If the sequence is modified during that operation then the result is undefined.
public IntStream codePoints |
() |
The stream binds to this sequence when the terminal stream operation commences (specifically, for mutable sequences the spliterator for the stream is late-binding). If the sequence is modified during that operation then the result is undefined.
public int compareTo |
(StringBuilder another) |
For finer-grained, locale-sensitive String comparison, refer to Collator.
public StringBuilder append |
(Object obj) |
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.
public StringBuilder append |
(String str) |
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.
public StringBuilder append |
(StringBuffer sb) |
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.
public StringBuilder append |
(CharSequence s) |
Depending on which class implements the character sequence csq, the entire sequence may not be appended. For instance, if csq is a CharBuffer then the subsequence to append is defined by the buffer's position and limit.
public StringBuilder append |
Characters of the argument s, starting at index start, are appended, in order, to the contents of this sequence up to the (exclusive) index end. The length of this sequence is increased by the value of end - start.
Let n be the length of this character sequence just prior to execution of the append method. Then the character at index k in this character sequence becomes equal to the character at index k in this sequence, if k is less than n; otherwise, it is equal to the character at index k+start-n in the argument s.
If s is null, then this method appends characters as if the s parameter was a sequence containing the four characters "null".
public StringBuilder append |
(char[] str) |
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.
public StringBuilder append |
(char[] str, int offset, int len) |
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.
public StringBuilder append |
(boolean b) |
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.
public StringBuilder append |
(char c) |
The argument is appended to the contents of this sequence. The length of this sequence 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 character sequence.
public StringBuilder append |
(int i) |
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.
public StringBuilder append |
(long lng) |
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.
public StringBuilder append |
(float f) |
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.
public StringBuilder append |
(double d) |
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.
public StringBuilder appendCodePoint |
(int codePoint) |
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.
public StringBuilder delete |
(int start, int end) |
public StringBuilder deleteCharAt |
(int index) |
Note: If the character at the given index is a supplementary character, this method does not remove the entire character. If correct handling of supplementary characters is required, determine the number of chars to remove by calling Character.charCount(thisSequence.codePointAt(index)), where thisSequence is this sequence.
public StringBuilder replace |
public StringBuilder insert |
(int index, char[] str, int offset, int len) |
public StringBuilder insert |
(int offset, Object obj) |
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.
public StringBuilder insert |
(int offset, String str) |
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 offset argument must be greater than or equal to 0, and less than or equal to the length of this sequence.
public StringBuilder insert |
(int offset, char[] str) |
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.
public StringBuilder insert |
(int dstOffset, CharSequence s) |
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.
If s is null, then the four characters "null" are inserted into this sequence.
public StringBuilder insert |
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 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 nonnegative, 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".
public StringBuilder insert |
(int offset, boolean b) |
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.
public StringBuilder insert |
(int offset, char c) |
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.
public StringBuilder insert |
(int offset, int i) |
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.
public StringBuilder insert |
(int offset, long l) |
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.
public StringBuilder insert |
(int offset, float f) |
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.
public StringBuilder insert |
(int offset, double d) |
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.
public int indexOf |
(String str) |
The returned index is the smallest value k for which:
this.toString().startsWith(str, k)
If no such value of k exists, then -1 is returned.
public int indexOf |
(String str, int fromIndex) |
The returned index is the smallest value k for which:
k >= Math.min(fromIndex, this.length()) &&
this.toString().startsWith(str, k)
If no such value of k exists, then -1 is returned.
public int lastIndexOf |
(String str) |
The returned index is the largest value k for which:
this.toString().startsWith(str, k)
If no such value of k exists, then -1 is returned.
public int lastIndexOf |
(String str, int fromIndex) |
The returned index is the largest value k for which:
k <= Math.min(fromIndex, this.length()) &&
this.toString().startsWith(str, k)
If no such value of k exists, then -1 is returned.
public StringBuilder reverse |
() |
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.
public String toString |
() |
|
FlexDoc/Javadoc 2.0 Demo Java Doc |