StringBuffer (JanosRuntime JavaDOC)

java.lang.Object
- java.lang.StringBuffer

public final class StringBuffer
extends Object

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StringBuffer`	`append(boolean bool)` Appends "true" or "false" boolean value to content.
`StringBuffer`	`append(char ch)` Appends character to content.
`StringBuffer`	`append(char[] arr)` Appends character array data to content.
`StringBuffer`	`append(char[] arr, int ofs, int len)` Append character data from array starting at offset for the defined length.
`StringBuffer`	`append(double val)` Appends the value of (@code double) to content.
`StringBuffer`	`append(float val)` Appends the value of (@code float) to content.
`StringBuffer`	`append(int val)` Appends the value of (@code int) to content.
`StringBuffer`	`append(long val)` Appends the value of (@code long) to content.
`StringBuffer`	`append(Object obj)` Append string representation of the object to content.
`StringBuffer`	`append(String str)` Appends the provided string.
`StringBuffer`	`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 idx)` Returns the (@code char) value at the specified index.
`StringBuffer`	`delete(int start, int end)` Removes the specified range from the content array.
`StringBuffer`	`deleteCharAt(int idx)` Removes the character from the content sequence.
`void`	`ensureCapacity(int cap)` Make sure that the character array is large enough to store the specified number of characters.
`void`	`getChars(int start, int end, char[] arr, int ofs)` 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.
`StringBuffer`	`insert(int ofs, boolean bool)` Inserts "true" or "false" into the string at the specified offset based upon a boolean value.
`StringBuffer`	`insert(int ofs, char ch)` Inserts the a character into the string at the specified offset.
`StringBuffer`	`insert(int ofs, char[] arr)` Inserts the character array into the string at the specified offset.
`StringBuffer`	`insert(int idx, char[] arr, int ofs, int len)` Inserts a subset of a character array into the string at the specified offset.
`StringBuffer`	`insert(int ofs, double val)` Inserts the string representation of a double value into the string at the specified offset.
`StringBuffer`	`insert(int ofs, float val)` Inserts the string representation of a float value into the string at the specified offset.
`StringBuffer`	`insert(int ofs, int val)` Inserts the string representation of a int value into the string at the specified offset.
`StringBuffer`	`insert(int ofs, long val)` Inserts the string representation of a long value into the string at the specified offset.
`StringBuffer`	`insert(int ofs, Object obj)` Inserts a string representation of the object into the string at the specified offset.
`StringBuffer`	`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
`StringBuffer`	`replace(int start, int end, String str)` Replaces a section in the content sequence.
`void`	`setCharAt(int idx, 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 start)` Returns the balance of the string from a specified starting index.
`String`	`substring(int start, int end)` Returns a portion of the string.
`String`	`toString()` Returns a a new copy of the string.
`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
  - StringBuffer
```
public StringBuffer()
```
    Constructs a string buffer with initial capacity of 32.
  - StringBuffer
```
public StringBuffer(int cap)
```
    Constructs a string buffer with the specified initial capacity.
    
    Parameters:
    
    cap - the initial capacity.
    
    Throws:
    
    NegativeArraySizeException - if the argument is less than 0
  - StringBuffer
```
public StringBuffer(String str)
```
    Constructs a string buffer initialized to the contents of the specified string.
    
    Parameters:
    
    str - initial contents
- Method Detail
  - 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 cap)
```
    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:
    
    cap - 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
  - charAt
```
public char charAt(int idx)
```
    Returns the (@code char) value at the specified index.
    
    Parameters:
    
    idx - the index of the character
    
    Returns:
    
    the (@code char) value at the index
  - getChars
```
public void getChars(int start,
                     int end,
                     char[] arr,
                     int ofs)
```
    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:
    
    start - starting index for data in the content array
    
    end - ending index in the content array
    
    arr - supplied destination character array
    
    ofs - destination starting point to receive data
  - setCharAt
```
public void setCharAt(int idx,
                      char ch)
```
    The character at the specified index is set to the supplied value.
    
    Parameters:
    
    idx - index in the content array
    
    ch - value to be stored
  - append
```
public StringBuffer append(Object obj)
```
    Append string representation of the object to content.
    
    Parameters:
    
    obj - object to append
    
    Returns:
    
    this
  - append
```
public StringBuffer append(String str)
```
    Appends the provided string.
    
    Parameters:
    
    str - string appended to content
    
    Returns:
    
    this
  - append
```
public StringBuffer 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 StringBuffer append(char[] arr)
```
    Appends character array data to content.
    
    Parameters:
    
    arr - character array to be appended
    
    Returns:
    
    this
  - append
```
public StringBuffer append(char[] arr,
                           int ofs,
                           int len)
```
    Append character data from array starting at offset for the defined length.
    
    Parameters:
    
    arr - character array containing data to append
    
    ofs - starting index of the data
    
    len - length of data to append
    
    Returns:
    
    this
  - append
```
public StringBuffer append(boolean bool)
```
    Appends "true" or "false" boolean value to content.
    
    Parameters:
    
    bool - boolean whose value is to be appended
    
    Returns:
    
    this
  - append
```
public StringBuffer append(char ch)
```
    Appends character to content.
    
    Parameters:
    
    ch - character value to append
    
    Returns:
    
    this
  - append
```
public StringBuffer append(int val)
```
    Appends the value of (@code int) to content.
    
    Parameters:
    
    val - (@code int) value whose textual representation is to be appended
    
    Returns:
    
    this
  - append
```
public StringBuffer append(long val)
```
    Appends the value of (@code long) to content.
    
    Parameters:
    
    val - (@code long) value whose textual representation is to be appended
    
    Returns:
    
    this
  - append
```
public StringBuffer append(float val)
```
    Appends the value of (@code float) to content.
    
    Parameters:
    
    val - (@code float) value whose textual representation is to be appended
    
    Returns:
    
    this
  - append
```
public StringBuffer append(double val)
```
    Appends the value of (@code double) to content.
    
    Parameters:
    
    val - (@code double) value whose textual representation is to be appended
    
    Returns:
    
    this
  - delete
```
public StringBuffer delete(int start,
                           int end)
```
    Removes the specified range from the content array.
    
    Parameters:
    
    start - starting index
    
    end - ending index
    
    Returns:
    
    this
  - deleteCharAt
```
public StringBuffer deleteCharAt(int idx)
```
    Removes the character from the content sequence.
    
    Parameters:
    
    idx - index to remove
    
    Returns:
    
    this
  - replace
```
public StringBuffer 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
  - substring
```
public String substring(int start)
```
    Returns the balance of the string from a specified starting index.
    
    Parameters:
    
    start - starting index of the substring
    
    Returns:
    
    new String representing the specified substring
  - substring
```
public String substring(int start,
                        int end)
```
    Returns a portion of the string.
    
    Parameters:
    
    start - starting index of the substring
    
    end - index following the substring (excluded)
    
    Returns:
    
    new String representing the specified substring
  - insert
```
public StringBuffer 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 StringBuffer 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 StringBuffer 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 StringBuffer 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 StringBuffer 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 StringBuffer 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 StringBuffer 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 StringBuffer 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 StringBuffer 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 StringBuffer 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()
```
    Returns a a new copy of the string.
    
    Returns:
    
    new string

Class StringBuffer

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StringBuffer

StringBuffer

StringBuffer

Method Detail

length

capacity

ensureCapacity

trimToSize

setLength

charAt

getChars

setCharAt

append

append

append

append

append

append

append

append

append

append

append

delete

deleteCharAt

replace

substring

substring

insert

insert

insert

insert

insert

insert

insert

insert

insert

insert

indexOf

indexOf

lastIndexOf

lastIndexOf

toString