CStringBuilder (Codename One API)

java.lang.Object
- com.codename1.util.CStringBuilder

Deprecated.
we will be moving to the proper string builder very soon
```
public final class CStringBuilder
extends Object
```
This is generally the Apache String builder class refactored here so we can use it regardless of vm limitations/differences for increased performance. A modifiable sequence of characters for use in creating and modifying Strings. This class is intended as a direct replacement of StringBuffer for non-concurrent use; unlike StringBuffer this class is not synchronized for thread safety.
The majority of the modification methods on this class return StringBuilder, so that, like StringBuffers, they can be used in chaining method calls together. For example, new StringBuilder("One should ").append("always strive ").append("to achieve Harmony").

Since:

1.5

See Also:

CharSequence, Appendable, StringBuffer, String

Constructor Summary

Constructors
Constructor and Description
`CStringBuilder()` Deprecated. Constructs an instance with an initial capacity of `16`.
`CStringBuilder(int capacity)` Deprecated. Constructs an instance with the specified capacity.
`CStringBuilder(String str)` Deprecated. Constructs an instance that's initialized with the contents of the specified `String`.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`CStringBuilder`	`append(boolean b)` Deprecated. Appends the string representation of the specified `boolean` value.
`CStringBuilder`	`append(char c)` Deprecated. Appends the string representation of the specified `char` value.
`CStringBuilder`	`append(char[] ch)` Deprecated. Appends the string representation of the specified `char[]`.
`CStringBuilder`	`append(char[] str, int offset, int len)` Deprecated. Appends the string representation of the specified subset of the `char[]`.
`CStringBuilder`	`append(double d)` Deprecated. Appends the string representation of the specified `double` value.
`CStringBuilder`	`append(float f)` Deprecated. Appends the string representation of the specified `float` value.
`CStringBuilder`	`append(int i)` Deprecated. Appends the string representation of the specified `int` value.
`CStringBuilder`	`append(long lng)` Deprecated. Appends the string representation of the specified `long` value.
`CStringBuilder`	`append(Object obj)` Deprecated. Appends the string representation of the specified `Object`.
`CStringBuilder`	`append(String str)` Deprecated. Appends the contents of the specified string.
`CStringBuilder`	`appendCodePoint(int codePoint)` Deprecated. Appends the encoded Unicode code point.
`int`	`capacity()` Returns the number of characters that can be held without growing.
`char`	`charAt(int index)` Retrieves the character at the `index`.
`int`	`codePointAt(int index)` Retrieves the Unicode code point value at the `index`.
`int`	`codePointBefore(int index)` Retrieves the Unicode code point value that precedes the `index`.
`int`	`codePointCount(int beginIndex, int endIndex)` Calculates the number of Unicode code points between `beginIndex` and `endIndex`.
`CStringBuilder`	`delete(int start, int end)` Deprecated. Deletes a sequence of characters specified by `start` and `end`.
`CStringBuilder`	`deleteCharAt(int index)` Deprecated. Deletes the character at the specified index.
`void`	`ensureCapacity(int min)` Ensures that this object has a minimum capacity available before requiring the internal buffer to be enlarged.
`void`	`getChars(int start, int end, char[] dest, int destStart)` Copies the requested sequence of characters to the `char[]` passed starting at `destStart`.
`int`	`indexOf(String string)` Searches for the first index of the specified character.
`int`	`indexOf(String subString, int start)` Searches for the index of the specified character.
`CStringBuilder`	`insert(int offset, boolean b)` Deprecated. Inserts the string representation of the specified `boolean` value at the specified `offset`.
`CStringBuilder`	`insert(int offset, char c)` Deprecated. Inserts the string representation of the specified `char` value at the specified `offset`.
`CStringBuilder`	`insert(int offset, char[] ch)` Deprecated. Inserts the string representation of the specified `char[]` at the specified `offset`.
`CStringBuilder`	`insert(int offset, char[] str, int strOffset, int strLen)` Deprecated. Inserts the string representation of the specified subsequence of the `char[]` at the specified `offset`.
`CStringBuilder`	`insert(int offset, double d)` Deprecated. Inserts the string representation of the specified `double` value at the specified `offset`.
`CStringBuilder`	`insert(int offset, float f)` Deprecated. Inserts the string representation of the specified `float` value at the specified `offset`.
`CStringBuilder`	`insert(int offset, int i)` Deprecated. Inserts the string representation of the specified `int` value at the specified `offset`.
`CStringBuilder`	`insert(int offset, long l)` Deprecated. Inserts the string representation of the specified `long` value at the specified `offset`.
`CStringBuilder`	`insert(int offset, Object obj)` Deprecated. Inserts the string representation of the specified `Object` at the specified `offset`.
`CStringBuilder`	`insert(int offset, String str)` Deprecated. Inserts the specified string at the specified `offset`.
`int`	`lastIndexOf(String string)` Searches for the last index of the specified character.
`int`	`lastIndexOf(String subString, int start)` Searches for the index of the specified character.
`int`	`length()` The current length.
`int`	`offsetByCodePoints(int index, int codePointOffset)` Returns the index that is offset `codePointOffset` code points from `index`.
`CStringBuilder`	`replace(int start, int end, String str)` Deprecated. Replaces the specified subsequence in this builder with the specified string.
`CStringBuilder`	`reverse()` Deprecated. Reverses the order of characters in this builder.
`void`	`setCharAt(int index, char ch)` Sets the character at the `index`.
`void`	`setLength(int length)` Sets the current length to a new value.
`String`	`substring(int start)` Returns the String value of the subsequence from the `start` index to the current end.
`String`	`substring(int start, int end)` Returns the String value of the subsequence from the `start` index to the `end` index.
`String`	`toString()` Deprecated. Returns the contents of this builder.
`void`	`trimToSize()` Trims off any extra capacity beyond the current length.

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

- Constructor Detail
  - CStringBuilder
```
public CStringBuilder()
```
    Deprecated.
    
    Constructs an instance with an initial capacity of 16.
    
    See Also:
    
    capacity()
  - CStringBuilder
```
public CStringBuilder(int capacity)
```
    Deprecated.
    
    Constructs an instance with the specified capacity.
    
    Parameters:
    
    capacity - the initial capacity to use.
    
    Throws:
    
    NegativeArraySizeException - if the specified capacity is negative.
    
    See Also:
    
    capacity()
  - CStringBuilder
```
public CStringBuilder(String str)
```
    Deprecated.
    
    Constructs an instance that's initialized with the contents of the specified String. The capacity of the new builder will be the length of the String plus 16.
    
    Parameters:
    
    str - the String to copy into the builder.
    
    Throws:
    
    NullPointerException - if str is null.
- Method Detail
  - append
```
public CStringBuilder append(boolean b)
```
    Deprecated.
    
    Appends the string representation of the specified boolean value. The boolean value is converted to a String according to the rule defined by String.valueOf(boolean).
    
    Parameters:
    
    b - the boolean value to append.
    
    Returns:
    
    this builder.
    
    See Also:
    
    String.valueOf(boolean)
  - append
```
public CStringBuilder append(char c)
```
    Deprecated.
    
    Appends the string representation of the specified char value. The char value is converted to a string according to the rule defined by String.valueOf(char).
    
    Parameters:
    
    c - the char value to append.
    
    Returns:
    
    this builder.
    
    See Also:
    
    String.valueOf(char)
  - append
```
public CStringBuilder append(int i)
```
    Deprecated.
    
    Appends the string representation of the specified int value. The int value is converted to a string according to the rule defined by String.valueOf(int).
    
    Parameters:
    
    i - the int value to append.
    
    Returns:
    
    this builder.
    
    See Also:
    
    String.valueOf(int)
  - append
```
public CStringBuilder append(long lng)
```
    Deprecated.
    
    Appends the string representation of the specified long value. The long value is converted to a string according to the rule defined by String.valueOf(long).
    
    Parameters:
    
    lng - the long value.
    
    Returns:
    
    this builder.
    
    See Also:
    
    String.valueOf(long)
  - append
```
public CStringBuilder append(float f)
```
    Deprecated.
    
    Appends the string representation of the specified float value. The float value is converted to a string according to the rule defined by String.valueOf(float).
    
    Parameters:
    
    f - the float value to append.
    
    Returns:
    
    this builder.
    
    See Also:
    
    String.valueOf(float)
  - append
```
public CStringBuilder append(double d)
```
    Deprecated.
    
    Appends the string representation of the specified double value. The double value is converted to a string according to the rule defined by String.valueOf(double).
    
    Parameters:
    
    d - the double value to append.
    
    Returns:
    
    this builder.
    
    See Also:
    
    String.valueOf(double)
  - append
```
public CStringBuilder append(Object obj)
```
    Deprecated.
    
    Appends the string representation of the specified Object. The Object value is converted to a string according to the rule defined by String.valueOf(Object).
    
    Parameters:
    
    obj - the Object to append.
    
    Returns:
    
    this builder.
    
    See Also:
    
    String.valueOf(Object)
  - append
```
public CStringBuilder append(String str)
```
    Deprecated.
    
    Appends the contents of the specified string. If the string is null, then the string "null" is appended.
    
    Parameters:
    
    str - the string to append.
    
    Returns:
    
    this builder.
  - append
```
public CStringBuilder append(char[] ch)
```
    Deprecated.
    
    Appends the string representation of the specified char[]. The char[] is converted to a string according to the rule defined by String.valueOf(char[]).
    
    Parameters:
    
    ch - the char[] to append..
    
    Returns:
    
    this builder.
    
    See Also:
    
    String.valueOf(char[])
  - append
```
public CStringBuilder append(char[] str,
                             int offset,
                             int len)
```
    Deprecated.
    
    Appends the string representation of the specified subset of the char[]. The char[] value is converted to a String according to the rule defined by String.valueOf(char[],int,int).
    
    Parameters:
    
    str - the char[] to append.
    
    offset - the inclusive offset index.
    
    len - the number of characters.
    
    Returns:
    
    this builder.
    
    Throws:
    
    ArrayIndexOutOfBoundsException - if offset and len do not specify a valid subsequence.
    
    See Also:
    
    String.valueOf(char[],int,int)
  - appendCodePoint
```
public CStringBuilder appendCodePoint(int codePoint)
```
    Deprecated.
    
    Appends the encoded Unicode code point. The code point is converted to a char[] as defined by Character.toChars(int).
    
    Parameters:
    
    codePoint - the Unicode code point to encode and append.
    
    Returns:
    
    this builder.
    
    See Also:
    
    Character.toChars(int)
  - delete
```
public CStringBuilder delete(int start,
                             int end)
```
    Deprecated.
    
    Deletes a sequence of characters specified by start and end. Shifts any remaining characters to the left.
    
    Parameters:
    
    start - the inclusive start index.
    
    end - the exclusive end index.
    
    Returns:
    
    this builder.
    
    Throws:
    
    StringIndexOutOfBoundsException - if start is less than zero, greater than the current length or greater than end.
  - deleteCharAt
```
public CStringBuilder deleteCharAt(int index)
```
    Deprecated.
    
    Deletes the character at the specified index. shifts any remaining characters to the left.
    
    Parameters:
    
    index - the index of the character to delete.
    
    Returns:
    
    this builder.
    
    Throws:
    
    StringIndexOutOfBoundsException - if index is less than zero or is greater than or equal to the current length.
  - insert
```
public CStringBuilder insert(int offset,
                             boolean b)
```
    Deprecated.
    
    Inserts the string representation of the specified boolean value at the specified offset. The boolean value is converted to a string according to the rule defined by String.valueOf(boolean).
    
    Parameters:
    
    offset - the index to insert at.
    
    b - the boolean value to insert.
    
    Returns:
    
    this builder.
    
    Throws:
    
    StringIndexOutOfBoundsException - if offset is negative or greater than the current length.
    
    See Also:
    
    String.valueOf(boolean)
  - insert
```
public CStringBuilder insert(int offset,
                             char c)
```
    Deprecated.
    
    Inserts the string representation of the specified char value at the specified offset. The char value is converted to a string according to the rule defined by String.valueOf(char).
    
    Parameters:
    
    offset - the index to insert at.
    
    c - the char value to insert.
    
    Returns:
    
    this builder.
    
    Throws:
    
    IndexOutOfBoundsException - if offset is negative or greater than the current length().
    
    See Also:
    
    String.valueOf(char)
  - insert
```
public CStringBuilder insert(int offset,
                             int i)
```
    Deprecated.
    
    Inserts the string representation of the specified int value at the specified offset. The int value is converted to a String according to the rule defined by String.valueOf(int).
    
    Parameters:
    
    offset - the index to insert at.
    
    i - the int value to insert.
    
    Returns:
    
    this builder.
    
    Throws:
    
    StringIndexOutOfBoundsException - if offset is negative or greater than the current length().
    
    See Also:
    
    String.valueOf(int)
  - insert
```
public CStringBuilder insert(int offset,
                             long l)
```
    Deprecated.
    
    Inserts the string representation of the specified long value at the specified offset. The long value is converted to a String according to the rule defined by String.valueOf(long).
    
    Parameters:
    
    offset - the index to insert at.
    
    l - the long value to insert.
    
    Returns:
    
    this builder.
    
    Throws:
    
    StringIndexOutOfBoundsException - if offset is negative or greater than the current {code length()}.
    
    See Also:
    
    String.valueOf(long)
  - insert
```
public CStringBuilder insert(int offset,
                             float f)
```
    Deprecated.
    
    Inserts the string representation of the specified float value at the specified offset. The float value is converted to a string according to the rule defined by String.valueOf(float).
    
    Parameters:
    
    offset - the index to insert at.
    
    f - the float value to insert.
    
    Returns:
    
    this builder.
    
    Throws:
    
    StringIndexOutOfBoundsException - if offset is negative or greater than the current length().
    
    See Also:
    
    String.valueOf(float)
  - insert
```
public CStringBuilder insert(int offset,
                             double d)
```
    Deprecated.
    
    Inserts the string representation of the specified double value at the specified offset. The double value is converted to a String according to the rule defined by String.valueOf(double).
    
    Parameters:
    
    offset - the index to insert at.
    
    d - the double value to insert.
    
    Returns:
    
    this builder.
    
    Throws:
    
    StringIndexOutOfBoundsException - if offset is negative or greater than the current length().
    
    See Also:
    
    String.valueOf(double)
  - insert
```
public CStringBuilder insert(int offset,
                             Object obj)
```
    Deprecated.
    
    Inserts the string representation of the specified Object at the specified offset. The Object value is converted to a String according to the rule defined by String.valueOf(Object).
    
    Parameters:
    
    offset - the index to insert at.
    
    obj - the Object to insert.
    
    Returns:
    
    this builder.
    
    Throws:
    
    StringIndexOutOfBoundsException - if offset is negative or greater than the current length().
    
    See Also:
    
    String.valueOf(Object)
  - insert
```
public CStringBuilder insert(int offset,
                             String str)
```
    Deprecated.
    
    Inserts the specified string at the specified offset. If the specified string is null, then the String "null" is inserted.
    
    Parameters:
    
    offset - the index to insert at.
    
    str - the String to insert.
    
    Returns:
    
    this builder.
    
    Throws:
    
    StringIndexOutOfBoundsException - if offset is negative or greater than the current length().
  - insert
```
public CStringBuilder insert(int offset,
                             char[] ch)
```
    Deprecated.
    
    Inserts the string representation of the specified char[] at the specified offset. The char[] value is converted to a String according to the rule defined by String.valueOf(char[]).
    
    Parameters:
    
    offset - the index to insert at.
    
    ch - the char[] to insert.
    
    Returns:
    
    this builder.
    
    Throws:
    
    StringIndexOutOfBoundsException - if offset is negative or greater than the current length().
    
    See Also:
    
    String.valueOf(char[])
  - insert
```
public CStringBuilder insert(int offset,
                             char[] str,
                             int strOffset,
                             int strLen)
```
    Deprecated.
    
    Inserts the string representation of the specified subsequence of the char[] at the specified offset. The char[] value is converted to a String according to the rule defined by String.valueOf(char[],int,int).
    
    Parameters:
    
    offset - the index to insert at.
    
    str - the char[] to insert.
    
    strOffset - the inclusive index.
    
    strLen - the number of characters.
    
    Returns:
    
    this builder.
    
    Throws:
    
    StringIndexOutOfBoundsException - if offset is negative or greater than the current length(), or strOffset and strLen do not specify a valid subsequence.
    
    See Also:
    
    String.valueOf(char[],int,int)
  - replace
```
public CStringBuilder replace(int start,
                              int end,
                              String str)
```
    Deprecated.
    
    Replaces the specified subsequence in this builder with the specified string.
    
    Parameters:
    
    start - the inclusive begin index.
    
    end - the exclusive end index.
    
    str - the replacement string.
    
    Returns:
    
    this builder.
    
    Throws:
    
    StringIndexOutOfBoundsException - if start is negative, greater than the current length() or greater than end.
    
    NullPointerException - if str is null.
  - reverse
```
public CStringBuilder reverse()
```
    Deprecated.
    
    Reverses the order of characters in this builder.
    
    Returns:
    
    this buffer.
  - toString
```
public String toString()
```
    Deprecated.
    
    Returns the contents of this builder.
    
    Returns:
    
    the string representation of the data in this builder.
  - capacity
```
public int capacity()
```
    Returns the number of characters that can be held without growing.
    
    Returns:
    
    the capacity
    
    See Also:
    
    ensureCapacity(int), length()
  - charAt
```
public char charAt(int index)
```
    Retrieves the character at the index.
    
    Parameters:
    
    index - the index of the character to retrieve.
    
    Returns:
    
    the char value.
    
    Throws:
    
    IndexOutOfBoundsException - if index is negative or greater than or equal to the current length().
  - ensureCapacity
```
public void ensureCapacity(int min)
```
    Ensures that this object has a minimum capacity available before requiring the internal buffer to be enlarged. The general policy of this method is that if the minimumCapacity is larger than the current capacity(), then the capacity will be increased to the largest value of either the minimumCapacity or the current capacity multiplied by two plus two. Although this is the general policy, there is no guarantee that the capacity will change.
    
    Parameters:
    
    min - the new minimum capacity to set.
  - getChars
```
public void getChars(int start,
                     int end,
                     char[] dest,
                     int destStart)
```
    Copies the requested sequence of characters to the char[] passed starting at destStart.
    
    Parameters:
    
    start - the inclusive start index of the characters to copy.
    
    end - the exclusive end index of the characters to copy.
    
    dest - the char[] to copy the characters to.
    
    destStart - the inclusive start index of dest to begin copying to.
    
    Throws:
    
    IndexOutOfBoundsException - if the start is negative, the destStart is negative, the start is greater than end, the end is greater than the current length() or destStart + end - begin is greater than dest.length.
  - length
```
public int length()
```
    The current length.
    
    Returns:
    
    the number of characters contained in this instance.
  - setCharAt
```
public void setCharAt(int index,
                      char ch)
```
    Sets the character at the index.
    
    Parameters:
    
    index - the zero-based index of the character to replace.
    
    ch - the character to set.
    
    Throws:
    
    IndexOutOfBoundsException - if index is negative or greater than or equal to the current length().
  - setLength
```
public void setLength(int length)
```
    Sets the current length to a new value. If the new length is larger than the current length, then the new characters at the end of this object will contain the char value of .
    
    Parameters:
    
    length - the new length of this StringBuffer.
    
    Throws:
    
    IndexOutOfBoundsException - if length < 0.
    
    See Also:
    
    length()
  - substring
```
public String substring(int start)
```
    Returns the String value of the subsequence from the start index to the current end.
    
    Parameters:
    
    start - the inclusive start index to begin the subsequence.
    
    Returns:
    
    a String containing the subsequence.
    
    Throws:
    
    StringIndexOutOfBoundsException - if start is negative or greater than the current length().
  - substring
```
public String substring(int start,
                        int end)
```
    Returns the String value of the subsequence from the start index to the end index.
    
    Parameters:
    
    start - the inclusive start index to begin the subsequence.
    
    end - the exclusive end index to end the subsequence.
    
    Returns:
    
    a String containing the subsequence.
    
    Throws:
    
    StringIndexOutOfBoundsException - if start is negative, greater than end or if end is greater than the current length().
  - indexOf
```
public int indexOf(String string)
```
    Searches for the first index of the specified character. The search for the character starts at the beginning and moves towards the end.
    
    Parameters:
    
    string - the string to find.
    
    Returns:
    
    the index of the specified character, -1 if the character isn't found.
    
    Since:
    
    1.4
    
    See Also:
    
    lastIndexOf(String)
  - indexOf
```
public int indexOf(String subString,
                   int start)
```
    Searches for the index of the specified character. The search for the character starts at the specified offset and moves towards the end.
    
    Parameters:
    
    subString - the string to find.
    
    start - the starting offset.
    
    Returns:
    
    the index of the specified character, -1 if the character isn't found
    
    Since:
    
    1.4
    
    See Also:
    
    lastIndexOf(String,int)
  - lastIndexOf
```
public int lastIndexOf(String string)
```
    Searches for the last index of the specified character. The search for the character starts at the end and moves towards the beginning.
    
    Parameters:
    
    string - the string to find.
    
    Returns:
    
    the index of the specified character, -1 if the character isn't found.
    
    Throws:
    
    NullPointerException - if string is null.
    
    Since:
    
    1.4
    
    See Also:
    
    String.lastIndexOf(java.lang.String)
  - lastIndexOf
```
public int lastIndexOf(String subString,
                       int start)
```
    Searches for the index of the specified character. The search for the character starts at the specified offset and moves towards the beginning.
    
    Parameters:
    
    subString - the string to find.
    
    start - the starting offset.
    
    Returns:
    
    the index of the specified character, -1 if the character isn't found.
    
    Throws:
    
    NullPointerException - if subString is null.
    
    Since:
    
    1.4
    
    See Also:
    
    String.lastIndexOf(String,int)
  - trimToSize
```
public void trimToSize()
```
    Trims off any extra capacity beyond the current length. Note, this method is NOT guaranteed to change the capacity of this object.
    
    Since:
    
    1.5
  - codePointAt
```
public int codePointAt(int index)
```
    Retrieves the Unicode code point value at the index.
    
    Parameters:
    
    index - the index to the char code unit.
    
    Returns:
    
    the Unicode code point value.
    
    Throws:
    
    IndexOutOfBoundsException - if index is negative or greater than or equal to length().
    
    Since:
    
    1.5
    
    See Also:
    
    Character, Character.codePointAt(char[], int, int)
  - codePointBefore
```
public int codePointBefore(int index)
```
    Retrieves the Unicode code point value that precedes the index.
    
    Parameters:
    
    index - the index to the char code unit within this object.
    
    Returns:
    
    the Unicode code point value.
    
    Throws:
    
    IndexOutOfBoundsException - if index is less than 1 or greater than length().
    
    Since:
    
    1.5
    
    See Also:
    
    Character, Character.codePointBefore(char[], int, int)
  - codePointCount
```
public int codePointCount(int beginIndex,
                          int endIndex)
```
    Calculates the number of Unicode code points between beginIndex and endIndex.
    
    Parameters:
    
    beginIndex - the inclusive beginning index of the subsequence.
    
    endIndex - the exclusive end index of the subsequence.
    
    Returns:
    
    the number of Unicode code points in the subsequence.
    
    Throws:
    
    IndexOutOfBoundsException - if beginIndex is negative or greater than endIndex or endIndex is greater than length().
    
    Since:
    
    1.5
    
    See Also:
    
    Character, Character.codePointCount(char[], int, int)
  - offsetByCodePoints
```
public int offsetByCodePoints(int index,
                              int codePointOffset)
```
    Returns the index that is offset codePointOffset code points from index.
    
    Parameters:
    
    index - the index to calculate the offset from.
    
    codePointOffset - the number of code points to count.
    
    Returns:
    
    the index that is codePointOffset code points away from index.
    
    Throws:
    
    IndexOutOfBoundsException - if index is negative or greater than length() or if there aren't enough code points before or after index to match codePointOffset.
    
    Since:
    
    1.5
    
    See Also:
    
    Character, Character.offsetByCodePoints(char[], int, int, int, int)

Class CStringBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CStringBuilder

CStringBuilder

CStringBuilder

Method Detail

append

append

append

append

append

append

append

append

append

append

appendCodePoint

delete

deleteCharAt

insert

insert

insert

insert

insert

insert

insert

insert

insert

insert

replace

reverse

toString

capacity

charAt

ensureCapacity

getChars

length

setCharAt

setLength

substring

substring

indexOf

indexOf

lastIndexOf

lastIndexOf

trimToSize

codePointAt

codePointBefore

codePointCount

offsetByCodePoints