com.amx.duet.tools.text
Class StringBufferExt

java.lang.Object
  extended bycom.amx.duet.tools.text.StringBufferExt

public class StringBufferExt
extends java.lang.Object

Extension to the J2ME StringBuffer class.


Constructor Summary
StringBufferExt()
          Constructs a string buffer with no characters in it and an initial capacity of 16 characters.
StringBufferExt(int capacity)
          Constructs a string buffer with no characters in it and the specified initial capacity.
StringBufferExt(java.lang.String str)
          Constructs a string buffer initialized to the contents of the specified string.
 
Method Summary
 StringBufferExt append(boolean b)
          Appends the string representation of the boolean argument to the string buffer.
 StringBufferExt append(char c)
          Appends the string representation of the char argument to this string buffer.
 StringBufferExt append(char[] str)
          Appends the string representation of the char array argument to this string buffer.
 StringBufferExt append(char[] str, int offset, int len)
          Appends the string representation of a subarray of the char array argument to this string buffer.
 StringBufferExt append(double d)
          Appends the string representation of the double argument to this string buffer.
 StringBufferExt append(float f)
          Appends the string representation of the float argument to this string buffer.
 StringBufferExt append(int i)
          Appends the string representation of the int argument to this string buffer.
 StringBufferExt append(long l)
          Appends the string representation of the long argument to this string buffer.
 StringBufferExt append(java.lang.Object obj)
          Appends the string representation of the Object argument to this string buffer.
 StringBufferExt append(java.lang.String str)
          Appends the string to this string buffer.
 StringBufferExt append(java.lang.StringBuffer sb)
          Appends the specified StringBuffer to this sequence.
 StringBufferExt append(StringBufferExt sb)
          Appends the specified StringBufferExt to this sequence.
 int capacity()
          Returns the current capacity of the String buffer.
 char charAt(int index)
          The specified character of the sequence currently represented by the string buffer, as indicated by the index argument, is returned.
 StringBufferExt delete()
          Removes the entire contents of this string buffer from beginning to end.
 StringBufferExt delete(int len)
          Removes the characters in a substring of this StringBufferExt up to the specified length.
 StringBufferExt delete(int start, int end)
          Removes the characters in a substring of this StringBufferExt.
 StringBufferExt deleteCharAt(int index)
          Removes the character at the specified position in this StringBufferExt (shortening the StringBufferExt by one character).
 boolean endsWith(java.lang.String str)
          Tests if this string ends with the specified suffix.
 void ensureCapacity(int minimumCapacity)
          Ensures that the capacity of the buffer is at least equal to the specified minimum.
 void getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin)
          Characters are copied from this string buffer into the destination character array dst.
 int indexOf(int ch)
          Returns the index within this string of the first occurrence of the specified character.
 int indexOf(int ch, int fromIndex)
          Returns the index within this string of the first occurrence of the specified character, starting the search at the specified index.
 int indexOf(java.lang.String str)
          Returns the index within this string buffer of the first occurrence of the specified substring.
 int indexOf(java.lang.String str, int fromIndex)
          Returns the index within this string buffer of the first occurrence of the specified substring, starting at the specified index.
 StringBufferExt insert(int offset, boolean b)
          Inserts the string representation of the boolean argument into this string buffer.
 StringBufferExt insert(int offset, char c)
          Inserts the string representation of the char argument into this string buffer.
 StringBufferExt insert(int offset, char[] str)
          Inserts the string representation of the char array argument into this string buffer.
 StringBufferExt insert(int index, char[] str, int offset, int len)
          Inserts the string representation of a subarray of the str array argument into this string buffer.
 StringBufferExt insert(int offset, double d)
          Inserts the string representation of the double argument into this string buffer.
 StringBufferExt insert(int offset, float f)
          Inserts the string representation of the float argument into this string buffer.
 StringBufferExt insert(int offset, int i)
          Inserts the string representation of the second int argument into this string buffer.
 StringBufferExt insert(int offset, long l)
          Inserts the string representation of the long argument into this string buffer.
 StringBufferExt insert(int offset, java.lang.Object obj)
          Inserts the string representation of the Object argument into this string buffer.
 StringBufferExt insert(int offset, java.lang.String str)
          Inserts the string into this string buffer.
 int lastIndexOf(int ch)
          Returns the index within this string of the last occurrence of the specified character.
 int lastIndexOf(int ch, int fromIndex)
          Returns the index within this string of the last occurrence of the specified character, searching backward starting at the specified index.
 int lastIndexOf(java.lang.String str)
          Returns the index within this string buffer of the rightmost occurrence of the specified substring.
 int lastIndexOf(java.lang.String str, int fromIndex)
          Returns the index within this string buffer of the last occurrence of the specified substring.
 int length()
          Returns the length (character count) of this string buffer.
 StringBufferExt replace(int start, int end, java.lang.String str)
          Replaces the characters in a substring of this StringBufferExt with characters in the specified String.
 StringBufferExt reverse()
          The character sequence contained in this string buffer is replaced by the reverse of the sequence.
 StringBufferExt set(boolean b)
          Set this string buffer to the string representation of the boolean argument.
 StringBufferExt set(char c)
          Sets this string buffer to the string representation of the char argument.
 StringBufferExt set(char[] str)
          Sets this string buffer to the string representation of the char array argument.
 StringBufferExt set(char[] str, int offset, int len)
          Sets this string buffer to the string representation of a subarray of the char array argument.
 StringBufferExt set(double d)
          Sets this string buffer to the string representation of the double argument.
 StringBufferExt set(float f)
          Sets this string buffer to the string representation of the float argument.
 StringBufferExt set(int i)
          Set this string buffer to the string representation of the int argument.
 StringBufferExt set(long l)
          Sets this string buffer to the string representation of the long argument.
 StringBufferExt set(java.lang.Object obj)
          Sets this string buffer to the string representation of the Object argument.
 StringBufferExt set(java.lang.String str)
          Sets this string buffer to the string argument.
 StringBufferExt set(java.lang.StringBuffer sb)
          Sets this sequence to the specified StringBufferExt.
 StringBufferExt set(StringBufferExt sb)
          Sets this string buffer to the specified StringBufferExt sequence.
 void setCharAt(int index, char ch)
          The character at the specified index of this string buffer is set to ch.
 void setLength(int newLength)
          Sets the length of this String buffer.
 boolean startsWith(java.lang.String str)
          Tests if this string buffer starts with the specified prefix.
 java.lang.String substring(int start)
          Returns a new String that contains a subsequence of characters currently contained in this StringBufferExt.The substring begins at the specified index and extends to the end of the StringBufferExt.
 java.lang.String substring(int start, int end)
          Returns a new String that contains a subsequence of characters currently contained in this StringBufferExt.
 java.lang.String toString()
          Converts to a string representing the data in this string buffer.
 java.lang.StringBuffer toStringBuffer()
          Converts to a StringBuffer representing the data in this string buffer object.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

StringBufferExt

public StringBufferExt()
Constructs a string buffer with no characters in it and an initial capacity of 16 characters.


StringBufferExt

public StringBufferExt(int capacity)
Constructs a string buffer with no characters in it and the specified initial capacity.

Parameters:
capacity - the initial capacity.
Throws:
java.lang.NegativeArraySizeException - if the capacity argument is less than 0.

StringBufferExt

public StringBufferExt(java.lang.String str)
Constructs a string buffer initialized to the contents of the specified 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.
Throws:
java.lang.NullPointerException - if str is null
Method Detail

length

public int length()
Returns the length (character count) of this string buffer.

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

capacity

public int capacity()
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.

ensureCapacity

public 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. The new capacity is the larger of: If the minimumCapacity argument is nonpositive, this method takes no action and simply returns.

Parameters:
minimumCapacity - the minimum desired capacity.

setLength

public 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. 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 ''. 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.
Throws:
java.lang.IndexOutOfBoundsException - if the newLength argument is negative.
See Also:
length()

charAt

public char charAt(int index)
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.
Returns:
the character at the specified index of this string buffer.
Throws:
java.lang.IndexOutOfBoundsException - if index is negative or greater than or equal to length().
See Also:
length()

getChars

public void getChars(int srcBegin,
                     int srcEnd,
                     char[] dst,
                     int dstBegin)
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.
Throws:
java.lang.NullPointerException - if dst is null.
java.lang.IndexOutOfBoundsException - if any of the following is true:
  • srcBegin is negative
  • dstBegin 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

setCharAt

public void setCharAt(int index,
                      char ch)
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.
ch - the new character.
Throws:
java.lang.IndexOutOfBoundsException - if index is negative or greater than or equal to length().
See Also:
length()

set

public StringBufferExt set(java.lang.Object obj)
Sets this string buffer to the string representation of the Object argument.

The argument is converted to a string as if by the method String.valueOf, and the characters of that string replace the original contents of this string buffer.

Parameters:
obj - an Object.
Returns:
a reference to this StringBufferExt object.
See Also:
String.valueOf(java.lang.Object), append(java.lang.Object)

set

public StringBufferExt set(java.lang.String str)
Sets this string buffer to the string argument.

The characters of the String argument are added, in order, deleting the contents of this string buffer, and replacing the length of this string buffer with the length of the argument. If str is null, then the four characters "null" are appended to this string buffer.

Parameters:
str - a string.
Returns:
a reference to this StringBufferExt.
See Also:
append(java.lang.String)

set

public StringBufferExt set(java.lang.StringBuffer sb)
Sets this sequence to the specified StringBufferExt.

The characters of the StringBuffer argument are added, in order, deleting the old contents from this StringBufferExt, and replacing the length of this StringBufferExt with the length of the argument. If sb is null, then the four characters "null" are appended to this StringBufferExt.

This method synchronizes on this (the destination) object but does not synchronize on the source (sb).

Parameters:
sb - the StringBuffer to set.
Returns:
a reference to this object.
See Also:
append(java.lang.StringBuffer)

set

public StringBufferExt set(StringBufferExt sb)
Sets this string buffer to the specified StringBufferExt sequence.

The characters of the StringBufferExt argument are added, in order, deleting the old contents from this StringBufferExt, and replacing the length of this StringBufferExt with the length of the argument. If sb is null, then the four characters "null" are appended to this StringBufferExt.

This method synchronizes on this (the destination) object but does not synchronize on the source (sb).

Parameters:
sb - the StringBufferExt to set.
Returns:
a reference to this object.
See Also:
append(com.amx.duet.tools.text.StringBufferExt)

set

public StringBufferExt set(char[] str)
Sets this string buffer to the string representation of the char array argument.

The characters of the array argument are added, in order, deleting the old contents from this string buffer, and replacing the length of this string buffer with 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 set to this StringBufferExt object.

Parameters:
str - the characters to set.
Returns:
a reference to this StringBufferExt object.
See Also:
append(char[])

set

public StringBufferExt set(char[] str,
                           int offset,
                           int len)
Sets this string buffer to the string representation of a subarray of the char array argument.

Characters of the character array str, starting at index offset, are added, in order, deleting the previous contents from this string buffer, and replacing the length of this string buffer with the length of the argument 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 StringBufferExt object.

Parameters:
str - the characters to be added.
offset - the index of the first character to set.
len - the number of characters to set.
Returns:
a reference to this StringBufferExt object.

set

public StringBufferExt set(boolean b)
Set this string buffer to the string representation of the boolean argument.

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

Parameters:
b - a boolean.
Returns:
a reference to this StringBufferExt.
See Also:
String.valueOf(boolean), set(java.lang.String)

set

public StringBufferExt set(char c)
Sets this string buffer to the string representation of the char argument.

The contents of this string buffer are set to the argument. The length of this string buffer is set to 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 was then set to this StringBufferExt object.

Parameters:
c - a char.
Returns:
a reference to this StringBufferExt object.

set

public StringBufferExt set(int i)
Set this string buffer to the string representation of the int argument.

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

Parameters:
i - an int.
Returns:
a reference to this StringBufferExt object.
See Also:
String.valueOf(int), set(java.lang.String)

set

public StringBufferExt set(long l)
Sets this string buffer to the string representation of the long argument.

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

Parameters:
l - a long.
Returns:
a referenct to this StringBufferExt object.
See Also:
String.valueOf(long), set(java.lang.String)

set

public StringBufferExt set(float f)
Sets this string buffer to the string representation of the float argument.

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

Parameters:
f - a float.
Returns:
a reference to this StringBufferExt object.
See Also:
String.valueOf(float), set(java.lang.String)

set

public StringBufferExt set(double d)
Sets this string buffer to the string representation of the double argument.

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

Parameters:
d - a double.
Returns:
a reference to this StringBufferExt object.
See Also:
String.valueOf(double), set(java.lang.String)

append

public StringBufferExt append(java.lang.Object obj)
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 StringBufferExt object.
See Also:
String.valueOf(java.lang.Object), append(java.lang.String)

append

public StringBufferExt append(java.lang.String str)
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 StringBufferExt.

append

public StringBufferExt append(java.lang.StringBuffer sb)
Appends the specified StringBuffer to this sequence.

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.

This method synchronizes on this (the destination) object but does not synchronize on the source (sb).

Parameters:
sb - the StringBuffer to append.
Returns:
a reference to this object.
Since:
1.4

append

public StringBufferExt append(StringBufferExt sb)
Appends the specified StringBufferExt to this sequence.

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

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

This method synchronizes on this (the destination) object but does not synchronize on the source (sb).

Parameters:
sb - the StringBufferExt to append.
Returns:
a reference to this object.
Since:
1.4

append

public StringBufferExt append(char[] str)
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 StringBufferExt object.

Parameters:
str - the characters to be appended.
Returns:
a reference to this StringBufferExt object.

append

public StringBufferExt append(char[] str,
                              int offset,
                              int len)
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 StringBufferExt 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 StringBufferExt object.

append

public StringBufferExt append(boolean b)
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 StringBufferExt.
See Also:
String.valueOf(boolean), append(java.lang.String)

append

public StringBufferExt append(char c)
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 StringBufferExt object.

Parameters:
c - a char.
Returns:
a reference to this StringBufferExt object.

append

public StringBufferExt append(int i)
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 StringBufferExt object.
See Also:
String.valueOf(int), append(java.lang.String)

append

public StringBufferExt append(long l)
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 referenct to this StringBufferExt object.
See Also:
String.valueOf(long), append(java.lang.String)

append

public StringBufferExt 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.
Returns:
a reference to this StringBufferExt object.
See Also:
String.valueOf(float), append(java.lang.String)

append

public StringBufferExt 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.
Returns:
a reference to this StringBufferExt object.
See Also:
String.valueOf(double), append(java.lang.String)

delete

public StringBufferExt delete()
Removes the entire contents of this string buffer from beginning to end.

Returns:
An empty string buffer.

delete

public StringBufferExt delete(int len)
Removes the characters in a substring of this StringBufferExt up to the specified length. The substring starts from the beginning and extends to the character at index len - 1 or to the end of the StringBufferExt if no such character exists.

Parameters:
len - The number of characters to remove from beginning to len.
Returns:
This string buffer.

delete

public StringBufferExt delete(int start,
                              int end)
Removes the characters in a substring of this StringBufferExt. The substring begins at the specified start and extends to the character at index end - 1 or to the end of the StringBufferExt 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.
Throws:
java.lang.StringIndexOutOfBoundsException - if start is negative, greater than length(), or greater than end.

deleteCharAt

public StringBufferExt deleteCharAt(int index)
Removes the character at the specified position in this StringBufferExt (shortening the StringBufferExt by one character).

Parameters:
index - Index of character to remove
Returns:
This string buffer.
Throws:
java.lang.StringIndexOutOfBoundsException - if the index is negative or greater than or equal to length().

replace

public StringBufferExt replace(int start,
                               int end,
                               java.lang.String str)
Replaces the characters in a substring of this StringBufferExt 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 StringBufferExt if no such character exists. First the characters in the substring are removed and then the specified String is inserted at start. (The StringBufferExt 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.
Throws:
java.lang.StringIndexOutOfBoundsException - if start is negative, greater than length(), or greater than end.

substring

public java.lang.String substring(int start)
Returns a new String that contains a subsequence of characters currently contained in this StringBufferExt.The substring begins at the specified index and extends to the end of the StringBufferExt.

Parameters:
start - The beginning index, inclusive.
Returns:
The new string.
Throws:
java.lang.StringIndexOutOfBoundsException - if start is less than zero, or greater than the length of this StringBufferExt.

substring

public java.lang.String substring(int start,
                                  int end)
Returns a new String that contains a subsequence of characters currently contained in this StringBufferExt. 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.
Throws:
java.lang.StringIndexOutOfBoundsException - if start or end are negative or greater than length(), or start is greater than end.

insert

public StringBufferExt insert(int index,
                              char[] str,
                              int offset,
                              int len)
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 StringBufferExt 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.
Throws:
java.lang.StringIndexOutOfBoundsException - if index is negative or greater than length(), or offset or len are negative, or (offset+len) is greater than str.length.

insert

public StringBufferExt insert(int offset,
                              java.lang.Object obj)
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 StringBufferExt object.
Throws:
java.lang.StringIndexOutOfBoundsException - if the offset is invalid.
See Also:
String.valueOf(java.lang.Object), insert(int, java.lang.String), length()

insert

public StringBufferExt insert(int offset,
                              java.lang.String str)
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 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 StringBufferExt object.
Throws:
java.lang.StringIndexOutOfBoundsException - if the offset is invalid.
See Also:
length()

insert

public StringBufferExt insert(int offset,
                              char[] str)
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 StringBufferExt object at the position indicated by offset.

Parameters:
offset - the offset.
str - a character array.
Returns:
a reference to this StringBufferExt object.
Throws:
java.lang.StringIndexOutOfBoundsException - if the offset is invalid.

insert

public StringBufferExt insert(int offset,
                              boolean b)
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 StringBufferExt object.
Throws:
java.lang.StringIndexOutOfBoundsException - if the offset is invalid.
See Also:
String.valueOf(boolean), insert(int, java.lang.String), length()

insert

public StringBufferExt insert(int offset,
                              char c)
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 StringBufferExt 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 StringBufferExt object.
Throws:
java.lang.IndexOutOfBoundsException - if the offset is invalid.
See Also:
length()

insert

public StringBufferExt insert(int offset,
                              int i)
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 StringBufferExt object.
Throws:
java.lang.StringIndexOutOfBoundsException - if the offset is invalid.
See Also:
String.valueOf(int), insert(int, java.lang.String), length()

insert

public StringBufferExt insert(int offset,
                              long l)
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 StringBufferExt object.
Throws:
java.lang.StringIndexOutOfBoundsException - if the offset is invalid.
See Also:
String.valueOf(long), insert(int, java.lang.String), length()

insert

public StringBufferExt 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.
f - a float.
Returns:
a reference to this StringBufferExt object.
Throws:
java.lang.StringIndexOutOfBoundsException - if the offset is invalid.
See Also:
String.valueOf(float), insert(int, java.lang.String), length()

insert

public StringBufferExt 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.
d - a double.
Returns:
a reference to this StringBufferExt object.
Throws:
java.lang.StringIndexOutOfBoundsException - if the offset is invalid.
See Also:
String.valueOf(double), insert(int, java.lang.String), length()

indexOf

public int indexOf(int ch)
Returns the index within this string of the first occurrence of the specified character. If a character with value ch occurs in the character sequence represented by this String object, then the index of the first such occurrence is returned -- that is, the smallest value k such that:
 this.charAt(k) == ch
 
is true. If no such character occurs in this string, then -1 is returned.

Parameters:
ch - a character.
Returns:
the index of the first occurrence of the character in the character sequence represented by this object, or -1 if the character does not occur.

indexOf

public int indexOf(int ch,
                   int fromIndex)
Returns the index within this string of the first occurrence of the specified character, starting the search at the specified index.

If a character with value ch occurs in the character sequence represented by this String object at an index no smaller than fromIndex, then the index of the first such occurrence is returned--that is, the smallest value k such that:

 (this.charAt(k) == ch) && (k >= fromIndex)
 
is true. If no such character occurs in this string at or after position fromIndex, then -1 is returned.

There is no restriction on the value of fromIndex. If it is negative, it has the same effect as if it were zero: this entire string may be searched. If it is greater than the length of this string, it has the same effect as if it were equal to the length of this string: -1 is returned.

Parameters:
ch - a character.
fromIndex - the index to start the search from.
Returns:
the index of the first occurrence of the character in the character sequence represented by this object that is greater than or equal to fromIndex, or -1 if the character does not occur.

lastIndexOf

public int lastIndexOf(int ch)
Returns the index within this string of the last occurrence of the specified character. That is, the index returned is the largest value k such that:
 this.charAt(k) == ch
 
is true. The String is searched backwards starting at the last character.

Parameters:
ch - a character.
Returns:
the index of the last occurrence of the character in the character sequence represented by this object, or -1 if the character does not occur.

lastIndexOf

public int lastIndexOf(int ch,
                       int fromIndex)
Returns the index within this string of the last occurrence of the specified character, searching backward starting at the specified index. That is, the index returned is the largest value k such that:
 this.charAt(k) == ch) && (k <= fromIndex)
 
is true.

Parameters:
ch - a character.
fromIndex - the index to start the search from. There is no restriction on the value of fromIndex. If it is greater than or equal to the length of this string, it has the same effect as if it were equal to one less than the length of this string: this entire string may be searched. If it is negative, it has the same effect as if it were -1: -1 is returned.
Returns:
the index of the last occurrence of the character in the character sequence represented by this object that is less than or equal to fromIndex, or -1 if the character does not occur before that point.

indexOf

public int indexOf(java.lang.String str)
Returns the index within this string buffer of the first occurrence of the specified substring. The integer returned is the smallest value k such that:
 this.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.
Throws:
java.lang.NullPointerException - if str is null.
See Also:
String.indexOf(java.lang.String)

indexOf

public int indexOf(java.lang.String str,
                   int fromIndex)
Returns the index within this string buffer of the first occurrence of the specified substring, starting at the specified index. The integer returned is the smallest value k such that:
 this.startsWith(str, k) && (k >= fromIndex)
 
is true.

There is no restriction on the value of fromIndex. If it is negative, it has the same effect as if it were zero: this entire string buffer may be searched. If it is greater than the length of this string buffer, it has the same effect as if it were equal to the length of this string buffer: -1 is returned.

Parameters:
str - the substring to search for.
fromIndex - the index to start the search from.
Returns:
If the string argument occurs as a substring within this object at a starting index no smaller than fromIndex, then the index of the first character of the first such substring is returned. If it does not occur as a substring starting at fromIndex or beyond, -1 is returned.
Throws:
java.lang.NullPointerException - if str is null
See Also:
String.indexOf(java.lang.String, int)

lastIndexOf

public int lastIndexOf(java.lang.String str)
Returns the index within this string buffer 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.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.
Throws:
java.lang.NullPointerException - if str is null.

lastIndexOf

public int lastIndexOf(java.lang.String str,
                       int fromIndex)
Returns the index within this string buffer of the last occurrence of the specified substring. The returned index indicates the start of the substring, and it must be equal to or less than fromIndex. That is, the index returned is the largest value k such that:
 this.startsWith(str, k) && (k <= fromIndex)
 

Parameters:
str - the substring to search for.
fromIndex - the index to start the search from. There is no restriction on the value of fromIndex. If it is greater than the length of this string buffer, it has the same effect as if it were equal to the length of this string buffer: this entire string buffer may be searched. If it is negative, it has the same effect as if it were -1: -1 is returned.
Returns:
If the string argument occurs one or more times as a substring within this object at a starting index no greater than fromIndex, then the index of the first character of the last such substring is returned. If it does not occur as a substring starting at fromIndex or earlier, -1 is returned.
Throws:
java.lang.NullPointerException - if str is null.

startsWith

public boolean startsWith(java.lang.String str)
Tests if this string buffer starts with the specified prefix.

Parameters:
str - the prefix
Returns:
true if the character sequence represented by the argument is a prefix of the character sequence represented by this string buffer; false otherwise. Note also that true will be returned if the argument is an empty string or is equal to this StringBufferExt object as determined by the equals(Object) method.

endsWith

public boolean endsWith(java.lang.String str)
Tests if this string ends with the specified suffix.

Parameters:
str - the suffix.
Returns:
true if the character sequence represented by the argument is a suffix of the character sequence represented by this object; false otherwise. Note that the result will be true if the argument is the empty string or is equal to this StringBufferExt object as determined by the equals(Object) method.

reverse

public StringBufferExt reverse()
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 object..

toStringBuffer

public java.lang.StringBuffer toStringBuffer()
Converts to a StringBuffer representing the data in this string buffer object. The StringBuffer returned has already been allocated and initialized to contain the character sequence currently represented by this object. Subsequent changes to this string buffer object do not affect the contents of the returned StringBuffer.

Returns:
the StringBuffer representation of this object.

toString

public java.lang.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. 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.

Returns:
a string representation of the string buffer.


Copyright © 2008 AMX LLC. All Rights Reserved.