## Uses of Class
org.apache.commons.text.TextStringBuilder

- Packages that use TextStringBuilder
  Package | Description
  --- | ---
  org.apache.commons.text | Basic classes for text handling.

- - ### Uses of TextStringBuilder in org.apache.commons.text

    Methods in org.apache.commons.text that return TextStringBuilder
    Modifier and Type | Method | Description
    --- | --- | ---
    `TextStringBuilder` | TextStringBuilder.`append​(boolean value)` | Appends a boolean value to the string builder.
    `TextStringBuilder` | TextStringBuilder.`append​(char ch)` | Appends a char value to the string builder.
    `TextStringBuilder` | TextStringBuilder.`append​(char[] chars)` | Appends a char array to the string builder.
    `TextStringBuilder` | TextStringBuilder.`append​(char[] chars, int startIndex, int length)` | Appends a char array to the string builder.
    `TextStringBuilder` | TextStringBuilder.`append​(double value)` | Appends a double value to the string builder using `String.valueOf`.
    `TextStringBuilder` | TextStringBuilder.`append​(float value)` | Appends a float value to the string builder using `String.valueOf`.
    `TextStringBuilder` | TextStringBuilder.`append​(int value)` | Appends an int value to the string builder using `String.valueOf`.
    `TextStringBuilder` | TextStringBuilder.`append​(long value)` | Appends a long value to the string builder using `String.valueOf`.
    `TextStringBuilder` | TextStringBuilder.`append​(CharSequence seq)` | Appends a CharSequence to this string builder.
    `TextStringBuilder` | TextStringBuilder.`append​(CharSequence seq, int startIndex, int length)` | Appends part of a CharSequence to this string builder.
    `TextStringBuilder` | TextStringBuilder.`append​(Object obj)` | Appends an object to this string builder.
    `TextStringBuilder` | TextStringBuilder.`append​(String str)` | Appends a string to this string builder.
    `TextStringBuilder` | TextStringBuilder.`append​(StringBuffer str)` | Appends a string buffer to this string builder.
    `TextStringBuilder` | TextStringBuilder.`append​(StringBuffer str, int startIndex, int length)` | Appends part of a string buffer to this string builder.
    `TextStringBuilder` | TextStringBuilder.`append​(StringBuilder str)` | Appends a StringBuilder to this string builder.
    `TextStringBuilder` | TextStringBuilder.`append​(StringBuilder str, int startIndex, int length)` | Appends part of a StringBuilder to this string builder.
    `TextStringBuilder` | TextStringBuilder.`append​(String str, int startIndex, int length)` | Appends part of a string to this string builder.
    `TextStringBuilder` | TextStringBuilder.`append​(String format, Object... objs)` | Calls `String.format(String, Object...)` and appends the result.
    `TextStringBuilder` | TextStringBuilder.`append​(CharBuffer buf)` | Appends the contents of a char buffer to this string builder.
    `TextStringBuilder` | TextStringBuilder.`append​(CharBuffer buf, int startIndex, int length)` | Appends the contents of a char buffer to this string builder.
    `TextStringBuilder` | TextStringBuilder.`append​(TextStringBuilder str)` | Appends another string builder to this string builder.
    `TextStringBuilder` | TextStringBuilder.`append​(TextStringBuilder str, int startIndex, int length)` | Appends part of a string builder to this string builder.
    `TextStringBuilder` | TextStringBuilder.`appendAll​(Iterable<?> iterable)` | Appends each item in an iterable to the builder without any separators.
    `TextStringBuilder` | TextStringBuilder.`appendAll​(Iterator<?> it)` | Appends each item in an iterator to the builder without any separators.
    `<T> TextStringBuilder` | TextStringBuilder.`appendAll​(T... array)` | Appends each item in an array to the builder without any separators.
    `TextStringBuilder` | TextStringBuilder.`appendFixedWidthPadLeft​(int value, int width, char padChar)` | Appends an object to the builder padding on the left to a fixed width.
    `TextStringBuilder` | TextStringBuilder.`appendFixedWidthPadLeft​(Object obj, int width, char padChar)` | Appends an object to the builder padding on the left to a fixed width.
    `TextStringBuilder` | TextStringBuilder.`appendFixedWidthPadRight​(int value, int width, char padChar)` | Appends an object to the builder padding on the right to a fixed length.
    `TextStringBuilder` | TextStringBuilder.`appendFixedWidthPadRight​(Object obj, int width, char padChar)` | Appends an object to the builder padding on the right to a fixed length.
    `TextStringBuilder` | TextStringBuilder.`appendln​(boolean value)` | Appends a boolean value followed by a new line to the string builder.
    `TextStringBuilder` | TextStringBuilder.`appendln​(char ch)` | Appends a char value followed by a new line to the string builder.
    `TextStringBuilder` | TextStringBuilder.`appendln​(char[] chars)` | Appends a char array followed by a new line to the string builder.
    `TextStringBuilder` | TextStringBuilder.`appendln​(char[] chars, int startIndex, int length)` | Appends a char array followed by a new line to the string builder.
    `TextStringBuilder` | TextStringBuilder.`appendln​(double value)` | Appends a double value followed by a new line to the string builder using `String.valueOf`.
    `TextStringBuilder` | TextStringBuilder.`appendln​(float value)` | Appends a float value followed by a new line to the string builder using `String.valueOf`.
    `TextStringBuilder` | TextStringBuilder.`appendln​(int value)` | Appends an int value followed by a new line to the string builder using `String.valueOf`.
    `TextStringBuilder` | TextStringBuilder.`appendln​(long value)` | Appends a long value followed by a new line to the string builder using `String.valueOf`.
    `TextStringBuilder` | TextStringBuilder.`appendln​(Object obj)` | Appends an object followed by a new line to this string builder.
    `TextStringBuilder` | TextStringBuilder.`appendln​(String str)` | Appends a string followed by a new line to this string builder.
    `TextStringBuilder` | TextStringBuilder.`appendln​(StringBuffer str)` | Appends a string buffer followed by a new line to this string builder.
    `TextStringBuilder` | TextStringBuilder.`appendln​(StringBuffer str, int startIndex, int length)` | Appends part of a string buffer followed by a new line to this string builder.
    `TextStringBuilder` | TextStringBuilder.`appendln​(StringBuilder str)` | Appends a string builder followed by a new line to this string builder.
    `TextStringBuilder` | TextStringBuilder.`appendln​(StringBuilder str, int startIndex, int length)` | Appends part of a string builder followed by a new line to this string builder.
    `TextStringBuilder` | TextStringBuilder.`appendln​(String str, int startIndex, int length)` | Appends part of a string followed by a new line to this string builder.
    `TextStringBuilder` | TextStringBuilder.`appendln​(String format, Object... objs)` | Calls `String.format(String, Object...)` and appends the result.
    `TextStringBuilder` | TextStringBuilder.`appendln​(TextStringBuilder str)` | Appends another string builder followed by a new line to this string builder.
    `TextStringBuilder` | TextStringBuilder.`appendln​(TextStringBuilder str, int startIndex, int length)` | Appends part of a string builder followed by a new line to this string builder.
    `TextStringBuilder` | TextStringBuilder.`appendNewLine()` | Appends the new line string to this string builder.
    `TextStringBuilder` | TextStringBuilder.`appendNull()` | Appends the text representing `null` to this string builder.
    `TextStringBuilder` | TextStringBuilder.`appendPadding​(int length, char padChar)` | Appends the pad character to the builder the specified number of times.
    `TextStringBuilder` | TextStringBuilder.`appendSeparator​(char separator)` | Appends a separator if the builder is currently non-empty.
    `TextStringBuilder` | TextStringBuilder.`appendSeparator​(char standard, char defaultIfEmpty)` | Append one of both separators to the builder If the builder is currently empty it will append the defaultIfEmpty-separator Otherwise it will append the standard-separator The separator is appended using `append(char)`.
    `TextStringBuilder` | TextStringBuilder.`appendSeparator​(char separator, int loopIndex)` | Appends a separator to the builder if the loop index is greater than zero.
    `TextStringBuilder` | TextStringBuilder.`appendSeparator​(String separator)` | Appends a separator if the builder is currently non-empty.
    `TextStringBuilder` | TextStringBuilder.`appendSeparator​(String separator, int loopIndex)` | Appends a separator to the builder if the loop index is greater than zero.
    `TextStringBuilder` | TextStringBuilder.`appendSeparator​(String standard, String defaultIfEmpty)` | Appends one of both separators to the StrBuilder.
    `TextStringBuilder` | TextStringBuilder.`appendWithSeparators​(Iterable<?> iterable, String separator)` | Appends an iterable placing separators between each value, but not before the first or after the last.
    `TextStringBuilder` | TextStringBuilder.`appendWithSeparators​(Object[] array, String separator)` | Appends an array placing separators between each value, but not before the first or after the last.
    `TextStringBuilder` | TextStringBuilder.`appendWithSeparators​(Iterator<?> it, String separator)` | Appends an iterator placing separators between each value, but not before the first or after the last.
    `TextStringBuilder` | TextStringBuilder.`clear()` | Clears the string builder (convenience Collections API style method).
    `TextStringBuilder` | TextStringBuilder.`delete​(int startIndex, int endIndex)` | Deletes the characters between the two specified indices.
    `TextStringBuilder` | TextStringBuilder.`deleteAll​(char ch)` | Deletes the character wherever it occurs in the builder.
    `TextStringBuilder` | TextStringBuilder.`deleteAll​(String str)` | Deletes the string wherever it occurs in the builder.
    `TextStringBuilder` | TextStringBuilder.`deleteAll​(StringMatcher matcher)` | Deletes all parts of the builder that the matcher matches.
    `TextStringBuilder` | TextStringBuilder.`deleteCharAt​(int index)` | Deletes the character at the specified index.
    `TextStringBuilder` | TextStringBuilder.`deleteFirst​(char ch)` | Deletes the character wherever it occurs in the builder.
    `TextStringBuilder` | TextStringBuilder.`deleteFirst​(String str)` | Deletes the string wherever it occurs in the builder.
    `TextStringBuilder` | TextStringBuilder.`deleteFirst​(StringMatcher matcher)` | Deletes the first match within the builder using the specified matcher.
    `TextStringBuilder` | TextStringBuilder.`ensureCapacity​(int capacity)` | Checks the capacity and ensures that it is at least the size specified.
    `TextStringBuilder` | TextStringBuilder.`insert​(int index, boolean value)` | Inserts the value into this builder.
    `TextStringBuilder` | TextStringBuilder.`insert​(int index, char value)` | Inserts the value into this builder.
    `TextStringBuilder` | TextStringBuilder.`insert​(int index, char[] chars)` | Inserts the character array into this builder.
    `TextStringBuilder` | TextStringBuilder.`insert​(int index, char[] chars, int offset, int length)` | Inserts part of the character array into this builder.
    `TextStringBuilder` | TextStringBuilder.`insert​(int index, double value)` | Inserts the value into this builder.
    `TextStringBuilder` | TextStringBuilder.`insert​(int index, float value)` | Inserts the value into this builder.
    `TextStringBuilder` | TextStringBuilder.`insert​(int index, int value)` | Inserts the value into this builder.
    `TextStringBuilder` | TextStringBuilder.`insert​(int index, long value)` | Inserts the value into this builder.
    `TextStringBuilder` | TextStringBuilder.`insert​(int index, Object obj)` | Inserts the string representation of an object into this builder.
    `TextStringBuilder` | TextStringBuilder.`insert​(int index, String str)` | Inserts the string into this builder.
    `TextStringBuilder` | TextStringBuilder.`minimizeCapacity()` | Minimizes the capacity to the actual length of the string.
    `TextStringBuilder` | TextStringBuilder.`replace​(int startIndex, int endIndex, String replaceStr)` | Replaces a portion of the string builder with another string.
    `TextStringBuilder` | TextStringBuilder.`replace​(StringMatcher matcher, String replaceStr, int startIndex, int endIndex, int replaceCount)` | Advanced search and replaces within the builder using a matcher.
    `TextStringBuilder` | TextStringBuilder.`replaceAll​(char search, char replace)` | Replaces the search character with the replace character throughout the builder.
    `TextStringBuilder` | TextStringBuilder.`replaceAll​(String searchStr, String replaceStr)` | Replaces the search string with the replace string throughout the builder.
    `TextStringBuilder` | TextStringBuilder.`replaceAll​(StringMatcher matcher, String replaceStr)` | Replaces all matches within the builder with the replace string.
    `TextStringBuilder` | TextStringBuilder.`replaceFirst​(char search, char replace)` | Replaces the first instance of the search character with the replace character in the builder.
    `TextStringBuilder` | TextStringBuilder.`replaceFirst​(String searchStr, String replaceStr)` | Replaces the first instance of the search string with the replace string.
    `TextStringBuilder` | TextStringBuilder.`replaceFirst​(StringMatcher matcher, String replaceStr)` | Replaces the first match within the builder with the replace string.
    `TextStringBuilder` | TextStringBuilder.`reverse()` | Reverses the string builder placing each character in the opposite index.
    `TextStringBuilder` | TextStringBuilder.`setCharAt​(int index, char ch)` | Sets the character at the specified index.
    `TextStringBuilder` | TextStringBuilder.`setLength​(int length)` | Updates the length of the builder by either dropping the last characters or adding filler of Unicode zero.
    `TextStringBuilder` | TextStringBuilder.`setNewLineText​(String newLine)` | Sets the text to be appended when a new line is added.
    `TextStringBuilder` | TextStringBuilder.`setNullText​(String nullText)` | Sets the text to be appended when null is added.
    `TextStringBuilder` | TextStringBuilder.`trim()` | Trims the builder by removing characters less than or equal to a space from the beginning and end.

    Methods in org.apache.commons.text with parameters of type TextStringBuilder
    Modifier and Type | Method | Description
    --- | --- | ---
    `TextStringBuilder` | TextStringBuilder.`append​(TextStringBuilder str)` | Appends another string builder to this string builder.
    `TextStringBuilder` | TextStringBuilder.`append​(TextStringBuilder str, int startIndex, int length)` | Appends part of a string builder to this string builder.
    `TextStringBuilder` | TextStringBuilder.`appendln​(TextStringBuilder str)` | Appends another string builder followed by a new line to this string builder.
    `TextStringBuilder` | TextStringBuilder.`appendln​(TextStringBuilder str, int startIndex, int length)` | Appends part of a string builder followed by a new line to this string builder.
    `boolean` | TextStringBuilder.`equals​(TextStringBuilder other)` | Checks the contents of this builder against another to see if they contain the same character content.
    `boolean` | TextStringBuilder.`equalsIgnoreCase​(TextStringBuilder other)` | Checks the contents of this builder against another to see if they contain the same character content ignoring case.
    `String` | StringSubstitutor.`replace​(TextStringBuilder source)` | Replaces all the occurrences of variables with their matching values from the resolver using the given source builder as a template.
    `String` | StringSubstitutor.`replace​(TextStringBuilder source, int offset, int length)` | Replaces all the occurrences of variables with their matching values from the resolver using the given source builder as a template.
    `boolean` | StringSubstitutor.`replaceIn​(TextStringBuilder source)` | Replaces all the occurrences of variables within the given source builder with their matching values from the resolver.
    `boolean` | StringSubstitutor.`replaceIn​(TextStringBuilder source, int offset, int length)` | Replaces all the occurrences of variables within the given source builder with their matching values from the resolver.
    `protected String` | StringSubstitutor.`resolveVariable​(String variableName, TextStringBuilder buf, int startPos, int endPos)` | Internal method that resolves the value of a variable.
    `protected boolean` | StringSubstitutor.`substitute​(TextStringBuilder buf, int offset, int length)` | Internal method that substitutes the variables.