StringBuilder (JanosRuntime JavaDOC)

java.lang.Object
- java.lang.StringBuilder

public final class StringBuilder
extends Object

Constructor Summary

Constructors
Constructor and Description
`StringBuilder()` Constructs a string builder with initial capacity of 32.
`StringBuilder(int cap)` Constructs a string builder with initial capacity specified.
`StringBuilder(String str)` Constructs a string builder initialized to the contents of the specified string.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StringBuilder`	`append(boolean b)` Appends "true" or "false" boolean value to content.
`StringBuilder`	`append(char c)` Appends character to content.
`StringBuilder`	`append(char[] str)` Appends character array data to content.
`StringBuilder`	`append(char[] str, int ofs, int len)` Append character data from array starting at offset for the defined length.
`StringBuilder`	`append(double d)` Appends the value of (@code double) to content.
`StringBuilder`	`append(float f)` Appends the value of (@code float) to content.
`StringBuilder`	`append(int i)` Appends the value of (@code int) to content.
`StringBuilder`	`append(long lng)` Appends the value of (@code long) to content.
`StringBuilder`	`append(Object obj)` Append string representation of the object to content.
`StringBuilder`	`append(String str)` Appends the provided string.
`StringBuilder`	`append(StringBuffer sb)` Appends content from the supplied (@code StringBuffer) to content.
`int`	`capacity()` Returns the current size of the array (capacity)
`char`	`charAt(int index)` Returns the (@code char) value at the specified index.
`StringBuilder`	`delete(int start, int end)` Removes the specified range from the content array.
`StringBuilder`	`deleteCharAt(int idx)` Removes the character from the content sequence.
`void`	`ensureCapacity(int size)` Make sure that the character array is large enough to store the specified number of characters.
`void`	`getChars(int from, int to, char[] arr, int start)` Moves characters from the starting index to the ending index-1 from the content character array into the supplied array at the specified starting index.
`int`	`indexOf(String str)` Returns the index within this string of the first occurrence of the specified substring.
`int`	`indexOf(String str, int from)` Returns the index within this string of the first occurrence of the specified substring.
`StringBuilder`	`insert(int ofs, boolean bool)` Inserts "true" or "false" into the string at the specified offset based upon a boolean value.
`StringBuilder`	`insert(int ofs, char ch)` Inserts the a character into the string at the specified offset.
`StringBuilder`	`insert(int ofs, char[] arr)` Inserts the character array into the string at the specified offset.
`StringBuilder`	`insert(int idx, char[] arr, int ofs, int len)` Inserts a subset of a character array into the string at the specified offset.
`StringBuilder`	`insert(int ofs, double val)` Inserts the string representation of a double value into the string at the specified offset.
`StringBuilder`	`insert(int ofs, float val)` Inserts the string representation of a float value into the string at the specified offset.
`StringBuilder`	`insert(int ofs, int val)` Inserts the string representation of a int value into the string at the specified offset.
`StringBuilder`	`insert(int ofs, long val)` Inserts the string representation of a long value into the string at the specified offset.
`StringBuilder`	`insert(int ofs, Object obj)` Inserts a string representation of the object into the string at the specified offset.
`StringBuilder`	`insert(int ofs, String str)` Inserts into the string at the specified offset.
`int`	`lastIndexOf(String str)` Returns the index within this string of the last occurrence of the specified substring.
`int`	`lastIndexOf(String str, int from)` Returns the index within this string of the last occurrence of the specified substring.
`int`	`length()` Returns the length of the current content
`StringBuilder`	`replace(int start, int end, String str)` Replaces a section in the content sequence.
`void`	`setCharAt(int index, char ch)` The character at the specified index is set to the supplied value.
`void`	`setLength(int len)` Sets the length of the string content.
`String`	`substring(int from)` Returns the (@code String) representation of the substring from starting index to the end of the content array.
`String`	`substring(int from, int to)` Returns the (@code String) representation of the substring from starting index to the ending index-1 from the content array.
`String`	`toString()` Return a string representation.
`void`	`trimToSize()` Trims the array to the current content.

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

- Constructor Detail
  - StringBuilder
```
public StringBuilder()
```
    Constructs a string builder with initial capacity of 32.
  - StringBuilder
```
public StringBuilder(int cap)
```
    Constructs a string builder with initial capacity specified.
    
    Parameters:
    
    cap - initial capacity
    
    Throws:
    
    NegativeArraySizeException - if argument is less than 0
  - StringBuilder
```
public StringBuilder(String str)
```
    Constructs a string builder initialized to the contents of the specified string.
    
    Parameters:
    
    str - initial contents
- Method Detail
  - append
```
public StringBuilder append(Object obj)
```
    Append string representation of the object to content.
    
    Parameters:
    
    obj - object to append
    
    Returns:
    
    this
  - append
```
public StringBuilder append(String str)
```
    Appends the provided string.
    
    Parameters:
    
    str - string appended to content
    
    Returns:
    
    this
  - append
```
public StringBuilder append(StringBuffer sb)
```
    Appends content from the supplied (@code StringBuffer) to content.
    
    Parameters:
    
    sb - (@code StringBuffer) object containing data to append
    
    Returns:
    
    this
  - append
```
public StringBuilder append(char[] str)
```
    Appends character array data to content.
    
    Parameters:
    
    str - character array to be appended
    
    Returns:
    
    this
  - append
```
public StringBuilder append(char[] str,
                            int ofs,
                            int len)
```
    Append character data from array starting at offset for the defined length.
    
    Parameters:
    
    str - character array containing data to append
    
    ofs - starting index of the data
    
    len - length of data to append
    
    Returns:
    
    this
  - append
```
public StringBuilder append(boolean b)
```
    Appends "true" or "false" boolean value to content.
    
    Parameters:
    
    b - boolean whose value is to be appended
    
    Returns:
    
    this
  - append
```
public StringBuilder append(char c)
```
    Appends character to content.
    
    Parameters:
    
    c - character value to append
    
    Returns:
    
    this
  - append
```
public StringBuilder append(int i)
```
    Appends the value of (@code int) to content.
    
    Parameters:
    
    i - (@code int) value whose textual representation is to be appended
    
    Returns:
    
    this
  - append
```
public StringBuilder append(long lng)
```
    Appends the value of (@code long) to content.
    
    Parameters:
    
    lng - (@code long) value whose textual representation is to be appended
    
    Returns:
    
    this
  - append
```
public StringBuilder append(float f)
```
    Appends the value of (@code float) to content.
    
    Parameters:
    
    f - (@code float) value whose textual representation is to be appended
    
    Returns:
    
    this
  - append
```
public StringBuilder append(double d)
```
    Appends the value of (@code double) to content.
    
    Parameters:
    
    d - (@code double) value whose textual representation is to be appended
    
    Returns:
    
    this
  - delete
```
public StringBuilder delete(int start,
                            int end)
```
    Removes the specified range from the content array.
    
    Parameters:
    
    start - starting index
    
    end - ending index
    
    Returns:
    
    this
  - deleteCharAt
```
public StringBuilder deleteCharAt(int idx)
```
    Removes the character from the content sequence.
    
    Parameters:
    
    idx - index to remove
    
    Returns:
    
    this
  - replace
```
public StringBuilder replace(int start,
                             int end,
                             String str)
```
    Replaces a section in the content sequence.
    
    Parameters:
    
    start - staring index
    
    end - ending index
    
    str - string content to use as the replacement
    
    Returns:
    
    this
  - insert
```
public StringBuilder insert(int idx,
                            char[] arr,
                            int ofs,
                            int len)
```
    Inserts a subset of a character array into the string at the specified offset.
    
    Parameters:
    
    idx - point within the string to insert a portion of the character array
    
    arr - character array
    
    ofs - offset into the character array specifying the portion to insert
    
    len - length of substring from the array to be inserted
    
    Returns:
    
    this object
  - insert
```
public StringBuilder insert(int ofs,
                            Object obj)
```
    Inserts a string representation of the object into the string at the specified offset.
    
    Parameters:
    
    ofs - point within the string to insert the object
    
    obj - the object to insert
    
    Returns:
    
    this object
  - insert
```
public StringBuilder insert(int ofs,
                            String str)
```
    Inserts into the string at the specified offset.
    
    Parameters:
    
    ofs - point within the string to insert
    
    str - string to be inserted
    
    Returns:
    
    this object
  - insert
```
public StringBuilder insert(int ofs,
                            char[] arr)
```
    Inserts the character array into the string at the specified offset.
    
    Parameters:
    
    ofs - point within the string to insert the character array
    
    arr - character array
    
    Returns:
    
    this object
  - insert
```
public StringBuilder insert(int ofs,
                            boolean bool)
```
    Inserts "true" or "false" into the string at the specified offset based upon a boolean value.
    
    Parameters:
    
    ofs - point within the string to insert the boolean
    
    bool - true inserts "true", false inserts "false"
    
    Returns:
    
    this object
  - insert
```
public StringBuilder insert(int ofs,
                            char ch)
```
    Inserts the a character into the string at the specified offset.
    
    Parameters:
    
    ofs - point within the string to insert the character
    
    ch - character to insert
    
    Returns:
    
    this object
  - insert
```
public StringBuilder insert(int ofs,
                            int val)
```
    Inserts the string representation of a int value into the string at the specified offset.
    
    Parameters:
    
    ofs - point within the string to insert the number
    
    val - int value to represent
    
    Returns:
    
    this object
  - insert
```
public StringBuilder insert(int ofs,
                            long val)
```
    Inserts the string representation of a long value into the string at the specified offset.
    
    Parameters:
    
    ofs - point within the string to insert the number
    
    val - long value to represent
    
    Returns:
    
    this object
  - insert
```
public StringBuilder insert(int ofs,
                            float val)
```
    Inserts the string representation of a float value into the string at the specified offset.
    
    Parameters:
    
    ofs - point within the string to insert the number
    
    val - float value to represent
    
    Returns:
    
    this object
  - insert
```
public StringBuilder insert(int ofs,
                            double val)
```
    Inserts the string representation of a double value into the string at the specified offset.
    
    Parameters:
    
    ofs - point within the string to insert the number
    
    val - double value to represent
    
    Returns:
    
    this object
  - indexOf
```
public int indexOf(String str)
```
    Returns the index within this string of the first occurrence of the specified substring.
    
    Parameters:
    
    str - substring to match
    
    Returns:
    
    index of the first occurrence of the substring
  - indexOf
```
public int indexOf(String str,
                   int from)
```
    Returns the index within this string of the first occurrence of the specified substring. The search can begin at a specified offset.
    
    Parameters:
    
    str - substring to match
    
    from - index offset to begin search
    
    Returns:
    
    index of the first occurrence of the substring
  - lastIndexOf
```
public int lastIndexOf(String str)
```
    Returns the index within this string of the last occurrence of the specified substring.
    
    Parameters:
    
    str - substring to match
    
    Returns:
    
    index of the last occurrence of the substring
  - lastIndexOf
```
public int lastIndexOf(String str,
                       int from)
```
    Returns the index within this string of the last occurrence of the specified substring. The search can begin at a specified offset.
    
    Parameters:
    
    str - substring to match
    
    from - index offset to begin search
    
    Returns:
    
    index of the last occurrence of the substring
  - toString
```
public String toString()
```
    Return a string representation.
    
    Returns:
    
    a string representation of the object.
  - length
```
public int length()
```
    Returns the length of the current content
    
    Returns:
    
    length of the string
  - capacity
```
public int capacity()
```
    Returns the current size of the array (capacity)
    
    Returns:
    
    size of the array
  - ensureCapacity
```
public void ensureCapacity(int size)
```
    Make sure that the character array is large enough to store the specified number of characters. It the array is not large enough this will expand its capacity.
    
    Parameters:
    
    size - minimum required capacity
  - trimToSize
```
public void trimToSize()
```
    Trims the array to the current content.
  - setLength
```
public void setLength(int len)
```
    Sets the length of the string content. This truncates the string if the new length is less than the original. Otherwise it will pad the content as necessary with null characters.
    
    Parameters:
    
    len - new content length
    
    Throws:
    
    IndexOutOfBoundsException - as necessary
  - charAt
```
public char charAt(int index)
```
    Returns the (@code char) value at the specified index.
    
    Parameters:
    
    index - the index of the character
    
    Returns:
    
    the (@code char) value at the index
    
    Throws:
    
    IndexOutOfBoundsException - as necessary
  - getChars
```
public void getChars(int from,
                     int to,
                     char[] arr,
                     int start)
```
    Moves characters from the starting index to the ending index-1 from the content character array into the supplied array at the specified starting index.
    
    Parameters:
    
    from - starting index for data in the content array
    
    to - ending index in the content array
    
    arr - supplied destination character array
    
    start - destination starting point to receive data
  - setCharAt
```
public void setCharAt(int index,
                      char ch)
```
    The character at the specified index is set to the supplied value.
    
    Parameters:
    
    index - index in the content array
    
    ch - value to be stored
  - substring
```
public String substring(int from)
```
    Returns the (@code String) representation of the substring from starting index to the end of the content array.
    
    Parameters:
    
    from - staring index
    
    Returns:
    
    (@code String) representation of the character set
  - substring
```
public String substring(int from,
                        int to)
```
    Returns the (@code String) representation of the substring from starting index to the ending index-1 from the content array.
    
    Parameters:
    
    from - staring index
    
    to - ending index
    
    Returns:
    
    (@code String) representation of the character set

Class StringBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StringBuilder

StringBuilder

StringBuilder

Method Detail

append

append

append

append

append

append

append

append

append

append

append

delete

deleteCharAt

replace

insert

insert

insert

insert

insert

insert

insert

insert

insert

insert

indexOf

indexOf

lastIndexOf

lastIndexOf

toString

length

capacity

ensureCapacity

trimToSize

setLength

charAt

getChars

setCharAt

substring

substring