StringBuffer4D (TotalCrossSDK 6.1.0 API)

java.lang.Object
- totalcross.lang.StringBuffer4D

```
public final class StringBuffer4D
extends java.lang.Object
```
This class is a growable buffer for characters. It is mainly used to create Strings. The compiler uses it to implement the "+" operator. For example:
```
 "a" + 4 + "c"
 
```
is compiled to:
```
 new StringBuffer().append("a").append(4).append("c").toString()
 
```
... to concatenate multiple strings together. In the code shown, the compiler generates references to the StringBuffer class to append the objects together.
If you use it in loop, consider creating a new StringBuffer with an initial number of characters, and calling setLength before each use. This can improve the performance up to 10x. Example:
```
 StringBuffer sb = new StringBuffer(1024);
 for (...)
 {
    sb.setLength(0);
    sb.append(...).append(...).append(...);
    String s = sb.toString();
 }
 
```
IMPORTANT: the totalcross.lang package is the java.lang that will be used in the device. You CANNOT use nor import totalcross.lang package in desktop. When tc.Deploy is called, all references to java.lang are replaced by totalcross.lang automatically. Given this, you must use only the classes and methods that exists BOTH in java.lang and totalcross.lang. For example, you can't use java.lang.ClassLoader because there are no totalcross.lang.ClassLoader. Another example, you can't use java.lang.String.indexOfIgnoreCase because there are no totalcross.lang.String.indexOfIgnoreCase method. Trying to use a class or method from the java.lang package that has no correspondence with totalcross.lang will make the tc.Deploy program to abort, informing where the problem occured. A good idea is to always refer to this javadoc to know what is and what isn't available.

Field Summary

Fields
Modifier and Type Field and Description

static int STARTING_SIZE

Fields
Modifier and Type	Field and Description
`static int`	`STARTING_SIZE`

Constructor Summary

Constructors
Constructor and Description
`StringBuffer4D()` Constructs an empty String buffer.
`StringBuffer4D(int length)` Constructs an empty String buffer with the specified initial length.
`StringBuffer4D(String4D str)` Constructs a String buffer with the specified initial buffer.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StringBuffer4D`	`append(boolean b)` Appends a boolean to the end of this buffer.
`StringBuffer4D`	`append(char c)` Appends a character to the end of this buffer.
`StringBuffer4D`	`append(char[] str)` Appends an array of characters to the end of this buffer.
`StringBuffer4D`	`append(char[] str, int offset, int len)` Appends a range of an array of characters to the end of this buffer.
`StringBuffer4D`	`append(java.lang.CharSequence seq)`
`StringBuffer4D`	`append(java.lang.CharSequence seq, int start, int end)`
`StringBuffer4D`	`append(double d)` Appends a double to the end of this buffer.
`StringBuffer4D`	`append(int i)` Appends an integer to the end of this buffer.
`StringBuffer4D`	`append(long l)` Appends a long to the end of this buffer.
`StringBuffer4D`	`append(java.lang.Object obj)` Appends an object to the end of this buffer.
`StringBuffer4D`	`append(java.lang.String str)` Appends a String to the end of this buffer.
`StringBuffer4D`	`append(StringBuffer4D stringBuffer)` Append the `StringBuffer4D` value of the argument to this `StringBuffer4D`.
`StringBuffer4D`	`append(java.lang.String str, int start, int end)` Appends a String to the end of this buffer.
`int`	`capacity()` Returns the current capacity of the String buffer.
`char`	`charAt(int index)` Returns the character at the specified index.
`StringBuffer4D`	`delete4D(int start, int end)` Removes the characters in a substring of this `StringBuffer`.
`StringBuffer4D`	`deleteCharAt(int index)` Delete a character from this `StringBuffer4D`.
`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)` Copies the characters of the specified substring (determined by srcBegin and srcEnd) into the character array, starting at the array's dstBegin location.
`int`	`indexOf(String4D str)` Finds the first instance of a substring in this StringBuilder.
`int`	`indexOf(String4D str, int fromIndex)` Finds the first instance of a String in this StringBuffer, starting at a given index.
`StringBuffer4D`	`insert(int offset, boolean bool)` Insert the `String` value of the argument into this `StringBuffer4D`.
`StringBuffer4D`	`insert(int offset, char ch)` Insert the `char` argument into this `StringBuffer4D`.
`StringBuffer4D`	`insert(int offset, char[] data)` Insert the `char[]` argument into this `StringBuffer4D`.
`StringBuffer4D`	`insert(int offset, char[] str, int str_offset, int len)` Insert a subarray of the `char[]` argument into this `StringBuffer4D`.
`StringBuffer4D`	`insert(int offset, double dnum)` Insert the `String` value of the argument into this `StringBuffer4D`.
`StringBuffer4D`	`insert(int offset, int inum)` Insert the `String` value of the argument into this `StringBuffer4D`.
`StringBuffer4D`	`insert(int offset, long lnum)` Insert the `String` value of the argument into this `StringBuffer4D`.
`StringBuffer4D`	`insert(int offset, java.lang.Object obj)` Insert the `String` value of the argument into this `StringBuffer4D`.
`StringBuffer4D`	`insert(int offset, String4D str)` Insert the `String` argument into this `StringBuffer4D`.
`int`	`lastIndexOf(String4D str)` Finds the last instance of a substring in this StringBuffer.
`int`	`lastIndexOf(String4D str, int fromIndex)` Finds the last instance of a String in this StringBuffer, starting at a given index.
`int`	`length()` Returns the number of characters in the buffer.
`StringBuffer4D`	`replace(int start, int end, String4D str)` Replace characters between index `start` (inclusive) and `end` (exclusive) with `str`.
`StringBuffer4D`	`reverse()` Reverses the string.
`void`	`setCharAt(int index, char ch)` Replaces the char at the given index.
`void`	`setLength(int newLength)` Sets the length of the String.
`String4D`	`substring(int beginIndex)` Creates a substring of this StringBuffer4D, starting at a specified index and ending at the end of this StringBuffer4D.
`String4D`	`substring(int beginIndex, int endIndex)` Creates a substring of this StringBuffer4D, starting at a specified index and ending at one character before a specified index.
`java.lang.String`	`toString()` Converts to a String representing the data in the buffer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - STARTING_SIZE
```
public static final int STARTING_SIZE
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - StringBuffer4D
```
public StringBuffer4D()
```
    Constructs an empty String buffer. Consider using the other constructor where you pass an initial size.
  - StringBuffer4D
```
public StringBuffer4D(int length)
```
    Constructs an empty String buffer with the specified initial length.
    
    Parameters:
    
    length - the initial length
  - StringBuffer4D
```
public StringBuffer4D(String4D str)
```
    Constructs a String buffer with the specified initial buffer.
    
    Parameters:
    
    str - the initial buffer of the buffer
- Method Detail
  - length
```
public int length()
```
    Returns the number of characters in the buffer.
  - setCharAt
```
public void setCharAt(int index,
                      char ch)
```
    Replaces the char at the given index.
    
    Since:
    
    SuperWaba 4.02
  - 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 a buffer reallocation will occur.
  - ensureCapacity
```
public void ensureCapacity(int minimumCapacity)
```
    Ensures that the capacity of the buffer is at least equal to the specified minimum.
    
    Parameters:
    
    minimumCapacity - the minimum desired capacity in characters
  - setLength
```
public void setLength(int newLength)
```
    Sets the length of the String. If the length is reduced, characters are lost. If the length is extended, the values of the new characters are set to 0.
    
    Parameters:
    
    newLength - the new length of the buffer
  - charAt
```
public char charAt(int index)
```
    Returns the character at the specified index. An index ranges from 0..length()-1.
    
    Parameters:
    
    index - the index of the desired character
  - getChars
```
public void getChars(int srcBegin,
                     int srcEnd,
                     char[] dst,
                     int dstBegin)
```
    Copies the characters of the specified substring (determined by srcBegin and srcEnd) into the character array, starting at the array's dstBegin location. Both srcBegin and srcEnd must be legal indexes into the buffer.
    
    Parameters:
    
    srcBegin - begin copy at this offset in the String
    
    srcEnd - stop copying at this offset in the String
    
    dst - the array to copy the data into
    
    dstBegin - offset into dst
  - append
```
public StringBuffer4D append(java.lang.Object obj)
```
    Appends an object to the end of this buffer.
    
    Parameters:
    
    obj - the object to be appended
    
    Returns:
    
    the StringBuffer itself, NOT a new one.
  - append
```
public StringBuffer4D append(java.lang.String str)
```
    Appends a String to the end of this buffer.
    
    Parameters:
    
    str - the String to be appended
    
    Returns:
    
    the StringBuffer itself, NOT a new one.
  - append
```
public StringBuffer4D append(java.lang.String str,
                             int start,
                             int end)
```
    Appends a String to the end of this buffer.
    
    Parameters:
    
    str - the String that has a part to be appended
    
    start - the start index of the substring to be appended
    
    end - the end index of the Substring to be appended
    
    Returns:
    
    the StringBuffer itself, NOT a new one.
  - append
```
public StringBuffer4D append(java.lang.CharSequence seq)
```
  - append
```
public StringBuffer4D append(java.lang.CharSequence seq,
                             int start,
                             int end)
```
  - append
```
public StringBuffer4D append(char[] str)
```
    Appends an array of characters to the end of this buffer.
    
    Parameters:
    
    str - the characters to be appended
    
    Returns:
    
    the StringBuffer itself, NOT a new one.
  - append
```
public StringBuffer4D append(char[] str,
                             int offset,
                             int len)
```
    Appends a range of an array of characters to the end of this buffer.
    
    Parameters:
    
    str - the characters to be appended
    
    offset - where to start
    
    len - the number of characters to add
    
    Returns:
    
    the StringBuffer itself, NOT a new one.
  - append
```
public StringBuffer4D append(boolean b)
```
    Appends a boolean to the end of this buffer.
    
    Parameters:
    
    b - the boolean to be appended
    
    Returns:
    
    the StringBuffer itself, NOT a new one.
  - append
```
public StringBuffer4D append(char c)
```
    Appends a character to the end of this buffer.
    
    Parameters:
    
    c - the character to be appended
    
    Returns:
    
    the StringBuffer itself, NOT a new one.
  - append
```
public StringBuffer4D append(int i)
```
    Appends an integer to the end of this buffer.
    
    Parameters:
    
    i - the integer to be appended
    
    Returns:
    
    the StringBuffer itself, NOT a new one.
  - append
```
public StringBuffer4D append(long l)
```
    Appends a long to the end of this buffer.
    
    Parameters:
    
    l - the long to be appended
    
    Returns:
    
    the StringBuffer itself, NOT a new one.
  - append
```
public StringBuffer4D append(double d)
```
    Appends a double to the end of this buffer.
    
    Parameters:
    
    d - the double to be appended
    
    Returns:
    
    the StringBuffer itself, NOT a new one.
  - toString
```
public java.lang.String toString()
```
    Converts to a String representing the data in the buffer.
    
    Overrides:
    
    toString in class java.lang.Object
  - delete4D
```
public StringBuffer4D delete4D(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. If start is equal to end, no changes are made. If any paramter goes beyond limits, it is enforced into limits. If start > end, the string is emptied; Returns this StringBuffer.
  - reverse
```
public StringBuffer4D reverse()
```
    Reverses the string.
    
    Since:
    
    SuperWaba 4.5
  - append
```
public StringBuffer4D append(StringBuffer4D stringBuffer)
```
    Append the StringBuffer4D value of the argument to this StringBuffer4D. This behaves the same as append((Object) stringBuffer), except it is more efficient.
    
    Parameters:
    
    stringBuffer - the StringBuffer4D to convert and append
    
    Returns:
    
    this StringBuffer4D
    
    See Also:
    
    append(Object)
  - deleteCharAt
```
public StringBuffer4D deleteCharAt(int index)
```
    Delete a character from this StringBuffer4D.
    
    Parameters:
    
    index - the index of the character to delete
    
    Returns:
    
    this StringBuffer4D
    
    Throws:
    
    java.lang.StringIndexOutOfBoundsException - if index is out of bounds
  - replace
```
public StringBuffer4D replace(int start,
                              int end,
                              String4D str)
```
    Replace characters between index start (inclusive) and end (exclusive) with str. If end is larger than the size of this StringBuffer4D, all characters after start are replaced.
    
    Parameters:
    
    start - the beginning index of characters to delete (inclusive)
    
    end - the ending index of characters to delete (exclusive)
    
    str - the new String to insert
    
    Returns:
    
    this StringBuffer4D
    
    Throws:
    
    java.lang.StringIndexOutOfBoundsException - if start or end are out of bounds
    
    java.lang.NullPointerException - if str is null
  - substring
```
public String4D substring(int beginIndex)
```
    Creates a substring of this StringBuffer4D, starting at a specified index and ending at the end of this StringBuffer4D.
    
    Parameters:
    
    beginIndex - index to start substring (base 0)
    
    Returns:
    
    new String which is a substring of this StringBuffer4D
    
    Throws:
    
    java.lang.StringIndexOutOfBoundsException - if beginIndex is out of bounds
    
    See Also:
    
    substring(int, int)
  - substring
```
public String4D substring(int beginIndex,
                          int endIndex)
```
    Creates a substring of this StringBuffer4D, starting at a specified index and ending at one character before a specified index.
    
    Parameters:
    
    beginIndex - index to start at (inclusive, base 0)
    
    endIndex - index to end at (exclusive)
    
    Returns:
    
    new String which is a substring of this StringBuffer4D
    
    Throws:
    
    java.lang.StringIndexOutOfBoundsException - if beginIndex or endIndex is out of bounds
  - insert
```
public StringBuffer4D insert(int offset,
                             char[] str,
                             int str_offset,
                             int len)
```
    Insert a subarray of the char[] argument into this StringBuffer4D.
    
    Parameters:
    
    offset - the place to insert in this buffer
    
    str - the char[] to insert
    
    str_offset - the index in str to start inserting from
    
    len - the number of characters to insert
    
    Returns:
    
    this StringBuffer4D
    
    Throws:
    
    java.lang.NullPointerException - if str is null
    
    java.lang.StringIndexOutOfBoundsException - if any index is out of bounds
  - insert
```
public StringBuffer4D insert(int offset,
                             java.lang.Object obj)
```
    Insert the String value of the argument into this StringBuffer4D. Uses String.valueOf() to convert to String.
    
    Parameters:
    
    offset - the place to insert in this buffer
    
    obj - the Object to convert and insert
    
    Returns:
    
    this StringBuffer4D
    
    Throws:
    
    java.lang.StringIndexOutOfBoundsException - if offset is out of bounds
    
    See Also:
    
    String.valueOf(Object)
  - insert
```
public StringBuffer4D insert(int offset,
                             String4D str)
```
    Insert the String argument into this StringBuffer4D. If str is null, the String "null" is used instead.
    
    Parameters:
    
    offset - the place to insert in this buffer
    
    str - the String to insert
    
    Returns:
    
    this StringBuffer4D
    
    Throws:
    
    java.lang.StringIndexOutOfBoundsException - if offset is out of bounds
  - insert
```
public StringBuffer4D insert(int offset,
                             char[] data)
```
    Insert the char[] argument into this StringBuffer4D.
    
    Parameters:
    
    offset - the place to insert in this buffer
    
    data - the char[] to insert
    
    Returns:
    
    this StringBuffer4D
    
    Throws:
    
    java.lang.NullPointerException - if data is null
    
    java.lang.StringIndexOutOfBoundsException - if offset is out of bounds
    
    See Also:
    
    insert(int, char[], int, int)
  - insert
```
public StringBuffer4D insert(int offset,
                             boolean bool)
```
    Insert the String value of the argument into this StringBuffer4D. Uses String.valueOf() to convert to String.
    
    Parameters:
    
    offset - the place to insert in this buffer
    
    bool - the boolean to convert and insert
    
    Returns:
    
    this StringBuffer4D
    
    Throws:
    
    java.lang.StringIndexOutOfBoundsException - if offset is out of bounds
    
    See Also:
    
    String.valueOf(boolean)
  - insert
```
public StringBuffer4D insert(int offset,
                             char ch)
```
    Insert the char argument into this StringBuffer4D.
    
    Parameters:
    
    offset - the place to insert in this buffer
    
    ch - the char to insert
    
    Returns:
    
    this StringBuffer4D
    
    Throws:
    
    java.lang.StringIndexOutOfBoundsException - if offset is out of bounds
  - insert
```
public StringBuffer4D insert(int offset,
                             int inum)
```
    Insert the String value of the argument into this StringBuffer4D. Uses String.valueOf() to convert to String.
    
    Parameters:
    
    offset - the place to insert in this buffer
    
    inum - the int to convert and insert
    
    Returns:
    
    this StringBuffer4D
    
    Throws:
    
    java.lang.StringIndexOutOfBoundsException - if offset is out of bounds
    
    See Also:
    
    String.valueOf(int)
  - insert
```
public StringBuffer4D insert(int offset,
                             long lnum)
```
    Insert the String value of the argument into this StringBuffer4D. Uses String.valueOf() to convert to String.
    
    Parameters:
    
    offset - the place to insert in this buffer
    
    lnum - the long to convert and insert
    
    Returns:
    
    this StringBuffer4D
    
    Throws:
    
    java.lang.StringIndexOutOfBoundsException - if offset is out of bounds
    
    See Also:
    
    String.valueOf(long)
  - insert
```
public StringBuffer4D insert(int offset,
                             double dnum)
```
    Insert the String value of the argument into this StringBuffer4D. Uses String.valueOf() to convert to String.
    
    Parameters:
    
    offset - the place to insert in this buffer
    
    dnum - the double to convert and insert
    
    Returns:
    
    this StringBuffer4D
    
    Throws:
    
    java.lang.StringIndexOutOfBoundsException - if offset is out of bounds
    
    See Also:
    
    String.valueOf(double)
  - indexOf
```
public int indexOf(String4D str)
```
    Finds the first instance of a substring in this StringBuilder.
    
    Parameters:
    
    str - String to find
    
    Returns:
    
    location (base 0) of the String, or -1 if not found
    
    Throws:
    
    java.lang.NullPointerException - if str is null
  - indexOf
```
public int indexOf(String4D str,
                   int fromIndex)
```
    Finds the first instance of a String in this StringBuffer, starting at a given index. If starting index is less than 0, the search starts at the beginning of this String. If the starting index is greater than the length of this String, or the substring is not found, -1 is returned.
    
    Parameters:
    
    str - String to find
    
    fromIndex - index to start the search
    
    Returns:
    
    location (base 0) of the String, or -1 if not found
    
    Throws:
    
    java.lang.NullPointerException - if str is null
    
    Since:
    
    1.4
  - lastIndexOf
```
public int lastIndexOf(String4D str)
```
    Finds the last instance of a substring in this StringBuffer.
    
    Parameters:
    
    str - String to find
    
    Returns:
    
    location (base 0) of the String, or -1 if not found
    
    Throws:
    
    java.lang.NullPointerException - if str is null
  - lastIndexOf
```
public int lastIndexOf(String4D str,
                       int fromIndex)
```
    Finds the last instance of a String in this StringBuffer, starting at a given index. If starting index is greater than the maximum valid index, then the search begins at the end of this String. If the starting index is less than zero, or the substring is not found, -1 is returned.
    
    Parameters:
    
    str - String to find
    
    fromIndex - index to start the search
    
    Returns:
    
    location (base 0) of the String, or -1 if not found
    
    Throws:
    
    java.lang.NullPointerException - if str is null

Class StringBuffer4D

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

STARTING_SIZE

Constructor Detail

StringBuffer4D

StringBuffer4D

StringBuffer4D

Method Detail

length

setCharAt

capacity

ensureCapacity

setLength

charAt

getChars

append

append

append

append

append

append

append

append

append

append

append

append

toString

delete4D

reverse

append

deleteCharAt

replace

substring

substring

insert

insert

insert

insert

insert

insert

insert

insert

insert

indexOf

indexOf

lastIndexOf

lastIndexOf