TextBuilder (Javolution Core (Java) 6.0.0 API)

java.lang.Object
- javolution.text.TextBuilder

All Implemented Interfaces:

Serializable, Appendable, CharSequence
```
public class TextBuilder
extends Object
implements Appendable, CharSequence, Serializable
```
An Appendable text whose capacity expands gently without incurring expensive resize/copy operations ever.

This class is not intended for large documents manipulations which should be performed with the Text class directly (O(Log(n)) insertion and deletion capabilities).

The textual format of any appended object is retrieved from the current TextContext.

Version:

5.3, January 20, 2008

Author:

Jean-Marie Dautelle

See Also:
Serialized Form

Constructor Summary

Constructors
Constructor and Description
`TextBuilder()` Creates a text builder of small initial capacity.
`TextBuilder(int capacity)` Creates a text builder of specified initial capacity.
`TextBuilder(String str)` Creates a text builder holding the specified `String` (convenience method).

Method Summary

Methods
Modifier and Type	Method and Description
`TextBuilder`	`append(boolean b)` Appends the textual representation of the specified `boolean` argument.
`TextBuilder`	`append(char c)` Appends the specified character.
`TextBuilder`	`append(char[] chars)` Appends the characters from the char array argument.
`TextBuilder`	`append(char[] chars, int offset, int length)` Appends the characters from a subarray of the char array argument.
`TextBuilder`	`append(CharSequence csq)` Appends the specified character sequence.
`TextBuilder`	`append(CharSequence csq, int start, int end)` Appends a subsequence of the specified character sequence.
`TextBuilder`	`append(double d)` Appends the textual representation of the specified `double`; the number of digits is 17 or 16 when the 16 digits representation can be parsed back to the same `double` (mimic the standard library formatting).
`TextBuilder`	`append(double d, int digits, boolean scientific, boolean showZero)` Appends the textual representation of the specified `double` according to the specified formatting arguments.
`TextBuilder`	`append(float f)` Appends the textual representation of the specified `float`.
`TextBuilder`	`append(int i)` Appends the decimal representation of the specified `int` argument.
`TextBuilder`	`append(int i, int radix)` Appends the radix representation of the specified `int` argument.
`TextBuilder`	`append(long l)` Appends the decimal representation of the specified `long` argument.
`TextBuilder`	`append(long l, int radix)` Appends the radix representation of the specified `long` argument.
`TextBuilder`	`append(Object obj)` Appends the textual representation of the specified object.
`TextBuilder`	`append(String str)` Appends the specified string to this text builder.
`TextBuilder`	`append(String str, int start, int end)` Appends a subsequence of the specified string.
`TextBuilder`	`append(Text txt)` Appends the specified text to this text builder.
`TextBuilder`	`append(Text txt, int start, int end)` Appends a subsequence of the specified text.
`char`	`charAt(int index)` Returns the character at the specified index.
`TextBuilder`	`clear()` Removes all the characters of this text builder (equivalent to `this.delete(start, this.length())`).
`boolean`	`contentEquals(CharSequence csq)` Indicates if this text builder has the same character content as the specified character sequence.
`TextBuilder`	`delete(int start, int end)` Removes the characters between the specified indices.
`boolean`	`equals(Object obj)` Compares this text builder against the specified object for equality.
`void`	`getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin)` Copies the character from this text builder into the destination character array.
`int`	`hashCode()` Returns the hash code for this text builder.
`TextBuilder`	`insert(int index, CharSequence csq)` Inserts the specified character sequence at the specified location.
`int`	`length()` Returns the length (character count) of this text builder.
`TextBuilder`	`reverse()` Reverses this character sequence.
`void`	`setCharAt(int index, char c)` Sets the character at the specified position.
`void`	`setLength(int newLength)` Convenience method equivalent to `setLength(newLength, '')`.
`void`	`setLength(int newLength, char fillChar)` Sets the length of this character builder.
`CharSequence`	`subSequence(int start, int end)` Returns a `CharSequence` corresponding to the character sequence between the specified indexes.
`CharArray`	`toCharArray()` Returns the `CharArray` representation of this `TextBuilder`.
`String`	`toString()` Returns the `String` representation of this `TextBuilder`.
`Text`	`toText()` Returns the `Text` corresponding to this `TextBuilder`.

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

- Constructor Detail
  - TextBuilder
```
public TextBuilder()
```
    Creates a text builder of small initial capacity.
  - TextBuilder
```
public TextBuilder(String str)
```
    Creates a text builder holding the specified String (convenience method).
    
    Parameters:
    str - the initial string content of this text builder.
  - TextBuilder
```
public TextBuilder(int capacity)
```
    Creates a text builder of specified initial capacity. Unless the text length exceeds the specified capacity, operations on this text builder will not allocate memory.
    
    Parameters:
    capacity - the initial capacity.
- Method Detail
  - length
```
public final int length()
```
    Returns the length (character count) of this text builder.
    
    Specified by:
    
    length in interface CharSequence
    
    Returns:
    the number of characters (16-bits Unicode).
  - charAt
```
public final char charAt(int index)
```
    Returns the character at the specified index.
    
    Specified by:
    
    charAt in interface CharSequence
    
    Parameters:
    index - the index of the character.
    
    Returns:
    the character at the specified index.
    
    Throws:
    
    IndexOutOfBoundsException - if (index < 0) || (index >= this.length()).
  - getChars
```
public final void getChars(int srcBegin,
            int srcEnd,
            char[] dst,
            int dstBegin)
```
    Copies the character from this text builder into the destination character array.
    
    Parameters:
    srcBegin - this text start index.
    srcEnd - this text end index (not included).
    dst - the destination array to copy the data into.
    dstBegin - the offset into the destination array.
    
    Throws:
    
    IndexOutOfBoundsException - if (srcBegin < 0) || (dstBegin < 0) || (srcBegin > srcEnd) || (srcEnd > this.length()) || ((dstBegin + srcEnd - srcBegin) > dst.length)
  - setCharAt
```
public final void setCharAt(int index,
             char c)
```
    Sets the character at the specified position.
    
    Parameters:
    index - the index of the character to modify.
    c - the new character.
    
    Throws:
    
    IndexOutOfBoundsException - if (index < 0) || (index >= this.length())
  - setLength
```
public final void setLength(int newLength)
```
    Convenience method equivalent to setLength(newLength, '').
    
    Parameters:
    newLength - the new length of this builder.
    
    Throws:
    
    IndexOutOfBoundsException - if (newLength < 0)
  - setLength
```
public final void setLength(int newLength,
             char fillChar)
```
    Sets the length of this character builder. If the length is greater than the current length; the specified character is inserted.
    
    Parameters:
    newLength - the new length of this builder.
    fillChar - the character to be appended if required.
    
    Throws:
    
    IndexOutOfBoundsException - if (newLength < 0)
  - subSequence
```
public final CharSequence subSequence(int start,
                       int end)
```
    Returns a CharSequence corresponding to the character sequence between the specified indexes.
    
    Specified by:
    
    subSequence in interface CharSequence
    
    Parameters:
    start - the index of the first character inclusive.
    end - the index of the last character exclusive.
    
    Returns:
    a character sequence.
    
    Throws:
    
    IndexOutOfBoundsException - if (start < 0) || (end < 0) || (start > end) || (end > this.length())
  - append
```
public final TextBuilder append(char c)
```
    Appends the specified character.
    
    Specified by:
    
    append in interface Appendable
    
    Parameters:
    c - the character to append.
    
    Returns:
    this
  - append
```
public final TextBuilder append(Object obj)
```
    Appends the textual representation of the specified object. This method is equivalent to TextContext.getFormat(obj.getClass()).format(obj, this)
  - append
```
public final TextBuilder append(CharSequence csq)
```
    Appends the specified character sequence. If the specified character sequence is null this method is equivalent to append("null").
    
    Specified by:
    
    append in interface Appendable
    
    Parameters:
    csq - the character sequence to append or null.
    
    Returns:
    this
  - append
```
public final TextBuilder append(CharSequence csq,
                 int start,
                 int end)
```
    Appends a subsequence of the specified character sequence. If the specified character sequence is null this method is equivalent to append("null").
    
    Specified by:
    
    append in interface Appendable
    
    Parameters:
    csq - the character sequence to append or null.
    start - the index of the first character to append.
    end - the index after the last character to append.
    
    Returns:
    this
    
    Throws:
    
    IndexOutOfBoundsException - if (start < 0) || (end < 0) || (start > end) || (end > csq.length())
  - append
```
public final TextBuilder append(String str)
```
    Appends the specified string to this text builder. If the specified string is null this method is equivalent to append("null").
    
    Parameters:
    str - the string to append or null.
    
    Returns:
    this
  - append
```
public final TextBuilder append(String str,
                 int start,
                 int end)
```
    Appends a subsequence of the specified string. If the specified character sequence is null this method is equivalent to append("null").
    
    Parameters:
    str - the string to append or null.
    start - the index of the first character to append.
    end - the index after the last character to append.
    
    Returns:
    this
    
    Throws:
    
    IndexOutOfBoundsException - if (start < 0) || (end < 0) || (start > end) || (end > str.length())
  - append
```
public final TextBuilder append(Text txt)
```
    Appends the specified text to this text builder. If the specified text is null this method is equivalent to append("null").
    
    Parameters:
    txt - the text to append or null.
    
    Returns:
    this
  - append
```
public final TextBuilder append(Text txt,
                 int start,
                 int end)
```
    Appends a subsequence of the specified text. If the specified character sequence is null this method is equivalent to append("null").
    
    Parameters:
    txt - the text to append or null.
    start - the index of the first character to append.
    end - the index after the last character to append.
    
    Returns:
    this
    
    Throws:
    
    IndexOutOfBoundsException - if (start < 0) || (end < 0) || (start > end) || (end > txt.length())
  - append
```
public final TextBuilder append(char[] chars)
```
    Appends the characters from the char array argument.
    
    Parameters:
    chars - the character array source.
    
    Returns:
    this
  - append
```
public final TextBuilder append(char[] chars,
                 int offset,
                 int length)
```
    Appends the characters from a subarray of the char array argument.
    
    Parameters:
    chars - the character array source.
    offset - the index of the first character to append.
    length - the number of character to append.
    
    Returns:
    this
    
    Throws:
    
    IndexOutOfBoundsException - if (offset < 0) || (length < 0) || ((offset + length) > chars.length)
  - append
```
public final TextBuilder append(boolean b)
```
    Appends the textual representation of the specified boolean argument.
    
    Parameters:
    b - the boolean to format.
    
    Returns:
    this
    See Also:
    TypeFormat
  - append
```
public final TextBuilder append(int i)
```
    Appends the decimal representation of the specified int argument.
    
    Parameters:
    i - the int to format.
    
    Returns:
    this
  - append
```
public final TextBuilder append(int i,
                 int radix)
```
    Appends the radix representation of the specified int argument.
    
    Parameters:
    i - the int to format.
    radix - the radix (e.g. 16 for hexadecimal).
    
    Returns:
    this
  - append
```
public final TextBuilder append(long l)
```
    Appends the decimal representation of the specified long argument.
    
    Parameters:
    l - the long to format.
    
    Returns:
    this
  - append
```
public final TextBuilder append(long l,
                 int radix)
```
    Appends the radix representation of the specified long argument.
    
    Parameters:
    l - the long to format.
    radix - the radix (e.g. 16 for hexadecimal).
    
    Returns:
    this
  - append
```
public final TextBuilder append(float f)
```
    Appends the textual representation of the specified float.
    
    Parameters:
    f - the float to format.
    
    Returns:
    append(f, 10, (abs(f) >= 1E7) || (abs(f) < 0.001), false)
  - append
```
public final TextBuilder append(double d)
```
    Appends the textual representation of the specified double; the number of digits is 17 or 16 when the 16 digits representation can be parsed back to the same double (mimic the standard library formatting).
    
    Parameters:
    d - the double to format.
    
    Returns:
    append(d, -1, (MathLib.abs(d) >= 1E7) || (MathLib.abs(d) < 0.001), false)
  - append
```
public final TextBuilder append(double d,
                 int digits,
                 boolean scientific,
                 boolean showZero)
```
    Appends the textual representation of the specified double according to the specified formatting arguments.
    
    Parameters:
    d - the double value.
    digits - the number of significative digits (excludes exponent) or -1 to mimic the standard library (16 or 17 digits).
    scientific - true to forces the use of the scientific notation (e.g. 1.23E3); false otherwise.
    showZero - true if trailing fractional zeros are represented; false otherwise.
    
    Returns:
    TypeFormat.format(d, digits, scientific, showZero, this)
    
    Throws:
    
    IllegalArgumentException - if (digits > 19))
  - insert
```
public final TextBuilder insert(int index,
                 CharSequence csq)
```
    Inserts the specified character sequence at the specified location.
    
    Parameters:
    index - the insertion position.
    csq - the character sequence being inserted.
    
    Returns:
    this
    
    Throws:
    
    IndexOutOfBoundsException - if (index < 0) || (index > this.length())
  - clear
```
public final TextBuilder clear()
```
    Removes all the characters of this text builder (equivalent to this.delete(start, this.length())).
    
    Returns:
    this.delete(0, this.length())
  - delete
```
public final TextBuilder delete(int start,
                 int end)
```
    Removes the characters between the specified indices.
    
    Parameters:
    start - the beginning index, inclusive.
    end - the ending index, exclusive.
    
    Returns:
    this
    
    Throws:
    
    IndexOutOfBoundsException - if (start < 0) || (end < 0) || (start > end) || (end > this.length())
  - reverse
```
public final TextBuilder reverse()
```
    Reverses this character sequence.
    
    Returns:
    this
  - toText
```
public final Text toText()
```
    Returns the Text corresponding to this TextBuilder.
    
    Returns:
    the corresponding Text instance.
  - toString
```
public final String toString()
```
    Returns the String representation of this TextBuilder.
    
    Specified by:
    
    toString in interface CharSequence
    
    Overrides:
    
    toString in class Object
    
    Returns:
    the java.lang.String for this text builder.
  - toCharArray
```
public final CharArray toCharArray()
```
    Returns the CharArray representation of this TextBuilder.
    
    Returns:
    the corresponding CharArray instance.
  - hashCode
```
public final int hashCode()
```
    Returns the hash code for this text builder.
    
    Overrides:
    
    hashCode in class Object
    
    Returns:
    the hash code value.
  - equals
```
public final boolean equals(Object obj)
```
    Compares this text builder against the specified object for equality. Returns true if the specified object is a text builder having the same character content.
    
    Overrides:
    
    equals in class Object
    
    Parameters:
    obj - the object to compare with or null.
    
    Returns:
    true if that is a text builder with the same character content as this text; false otherwise.
  - contentEquals
```
public final boolean contentEquals(CharSequence csq)
```
    Indicates if this text builder has the same character content as the specified character sequence.
    
    Parameters:
    csq - the character sequence to compare with.
    
    Returns:
    true if the specified character sequence has the same character content as this text; false otherwise.

Class TextBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TextBuilder

TextBuilder

TextBuilder

Method Detail

length

charAt

getChars

setCharAt

setLength

setLength

subSequence

append

append

append

append

append

append

append

append

append

append

append

append

append

append

append

append

append

append

insert

clear

delete

reverse

toText

toString

toCharArray

hashCode

equals

contentEquals