Package net.sf.saxon.tree.util
Class FastStringBuffer
java.lang.Object
net.sf.saxon.tree.util.FastStringBuffer
- All Implemented Interfaces:
CharSequence
,AppendableCharSequence
,CharSequenceConsumer
public final class FastStringBuffer
extends Object
implements AppendableCharSequence, CharSequenceConsumer
A simple implementation of a class similar to StringBuffer. Unlike
StringBuffer it is not synchronized. It also offers the capability
to remove unused space. (This class could possibly be replaced by
StringBuilder in JDK 1.5, but using our own class gives more control.)
-
Field Summary
Fields -
Constructor Summary
ConstructorsConstructorDescriptionFastStringBuffer
(int initialSize) Create a FastStringBuffer with a given initial capacityCreate a FastStringBuffer with initial content -
Method Summary
Modifier and TypeMethodDescriptionvoid
append
(char[] srcArray) Append the entire contents of a character array to the buffervoid
append
(char[] srcArray, int start, int length) Append the contents of a character array to the buffervoid
Append the contents of a general CharSequence to the buffervoid
Append the contents of a String to the buffervoid
Append the contents of a StringBuffer to the buffervoid
append
(UnicodeString str) Append a UnicodeString to the buffer (using surrogate pairs if necessary)void
Append the contents of a CharSlice to the buffervoid
Append the contents of a FastStringBuffer to the buffervoid
appendWideChar
(int ch) Append a wide character to the buffer (as a surrogate pair if necessary)cat
(char ch) Append a character to the buffercat
(CharSequence s) Append the contents of a general CharSequence to the bufferAppend the contents of a String to the bufferchar
charAt
(int index) Returns thechar
value at the specified index.condense()
Remove surplus space from the array.static String
Diagnostic print of the contents of a CharSequence.void
ensureCapacity
(int extra) Expand the character array if necessary to ensure capacity for appended databoolean
Compare equalityvoid
getChars
(int srcBegin, int srcEnd, char[] dst, int dstBegin) Copies characters from this FastStringBuffer into the destination character array.int
hashCode()
Generate a hash codeint
indexOf
(char ch) Get the index of the first character equal to a given valuevoid
insert
(int index, char ch) Insert a character at a particular offsetvoid
insertWideChar
(int index, int ch) Insert wide character at a particular offsetboolean
isEmpty()
Ask whether the string buffer is emptyint
length()
Returns the length of this character sequence.void
prepend
(char ch) Insert a given character at the start of the buffervoid
prepend
(CharSequence str) Insert a given string at the start of the buffervoid
prependRepeated
(char ch, int repeat) Insert a given character N times at the start of the buffervoid
prependWideChar
(int ch) Prepend a wide character to the buffer (as a surrogate pair if necessary)void
removeCharAt
(int index) Remove a character at a particular offsetvoid
setCharAt
(int index, char ch) Set the character at a particular offsetvoid
setLength
(int length) Set the length.subSequence
(int start, int end) Returns a newCharSequence
that is a subsequence of this sequence.char[]
Get a char[] array containing the characters.toString()
Convert contents of the FastStringBuffer to a stringvoid
Write the value to a writerMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
Methods inherited from interface java.lang.CharSequence
chars, codePoints
Methods inherited from interface net.sf.saxon.tree.util.CharSequenceConsumer
close, open
-
Field Details
-
C16
public static final int C16- See Also:
-
C64
public static final int C64- See Also:
-
C256
public static final int C256- See Also:
-
C1024
public static final int C1024- See Also:
-
-
Constructor Details
-
FastStringBuffer
public FastStringBuffer(int initialSize) Create a FastStringBuffer with a given initial capacity- Parameters:
initialSize
- the initial capacity
-
FastStringBuffer
Create a FastStringBuffer with initial content- Parameters:
cs
- the initial content. The buffer is created with just enough capacity for this content (it will be expanded if more content is added later).
-
-
Method Details
-
cat
Append the contents of a String to the buffer- Parameters:
s
- the String to be appended- Returns:
- the FastStringBuffer with the new contents
-
append
Append the contents of a String to the buffer- Parameters:
s
- the String to be appended
-
append
Append the contents of a CharSlice to the buffer- Parameters:
s
- the String to be appended
-
append
Append the contents of a FastStringBuffer to the buffer- Parameters:
s
- the FastStringBuffer to be appended
-
append
Append the contents of a StringBuffer to the buffer- Parameters:
s
- the StringBuffer to be appended
-
cat
Append the contents of a general CharSequence to the buffer- Specified by:
cat
in interfaceAppendableCharSequence
- Specified by:
cat
in interfaceCharSequenceConsumer
- Parameters:
s
- the CharSequence to be appended- Returns:
- the result of the concatenation
-
append
Append the contents of a general CharSequence to the buffer- Parameters:
s
- the CharSequence to be appended
-
append
public void append(char[] srcArray, int start, int length) Append the contents of a character array to the buffer- Parameters:
srcArray
- the array whose contents are to be addedstart
- the offset of the first character in the array to be copiedlength
- the number of characters to be copied
-
append
public void append(char[] srcArray) Append the entire contents of a character array to the buffer- Parameters:
srcArray
- the array whose contents are to be added
-
cat
Append a character to the buffer- Specified by:
cat
in interfaceAppendableCharSequence
- Specified by:
cat
in interfaceCharSequenceConsumer
- Parameters:
ch
- the character to be added- Returns:
- this FastStringBuffer
-
appendWideChar
public void appendWideChar(int ch) Append a wide character to the buffer (as a surrogate pair if necessary)- Parameters:
ch
- the character, as a 32-bit Unicode codepoint
-
append
Append a UnicodeString to the buffer (using surrogate pairs if necessary)- Parameters:
str
- the UnicodeString
-
prependWideChar
public void prependWideChar(int ch) Prepend a wide character to the buffer (as a surrogate pair if necessary)- Parameters:
ch
- the character, as a 32-bit Unicode codepoint
-
length
public int length()Returns the length of this character sequence. The length is the number of 16-bitchar
s in the sequence.- Specified by:
length
in interfaceCharSequence
- Returns:
- the number of
char
s in this sequence
-
isEmpty
public boolean isEmpty()Ask whether the string buffer is empty- Specified by:
isEmpty
in interfaceCharSequence
- Returns:
- true if the buffer is empty (length()==0)
-
charAt
public char charAt(int index) Returns thechar
value at the specified index. An index ranges from zero to length() - 1. The firstchar
value of the sequence is at index zero, the next at index one, and so on, as for array indexing.If the
char
value specified by the index is a surrogate, the surrogate value is returned.- Specified by:
charAt
in interfaceCharSequence
- Parameters:
index
- the index of thechar
value to be returned- Returns:
- the specified
char
value - Throws:
IndexOutOfBoundsException
- if the index argument is negative or not less than length()
-
subSequence
Returns a newCharSequence
that is a subsequence of this sequence. The subsequence starts with thechar
value at the specified index and ends with thechar
value at index end - 1. The length (inchar
s) of the returned sequence is end - start, so if start == end then an empty sequence is returned.- Specified by:
subSequence
in interfaceCharSequence
- Parameters:
start
- the start index, inclusiveend
- the end index, exclusive- Returns:
- the specified subsequence
- Throws:
IndexOutOfBoundsException
- if start or end are negative, if end is greater than length(), or if start is greater than end
-
getChars
public void getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin) Copies characters from this FastStringBuffer into the destination character array.The first character to be copied is at index
srcBegin
; the last character to be copied is at indexsrcEnd-1
(thus the total number of characters to be copied issrcEnd-srcBegin
). The characters are copied into the subarray ofdst
starting at indexdstBegin
and ending at index:dstbegin + (srcEnd-srcBegin) - 1
- Parameters:
srcBegin
- index of the first character in the string to copy.srcEnd
- index after the last character in the string to copy.dst
- the destination array.dstBegin
- the start offset in the destination array.- Throws:
IndexOutOfBoundsException
- If any of the following is true:srcBegin
is negative.srcBegin
is greater thansrcEnd
srcEnd
is greater than the length of this stringdstBegin
is negativedstBegin+(srcEnd-srcBegin)
is larger thandst.length
-
indexOf
public int indexOf(char ch) Get the index of the first character equal to a given value- Parameters:
ch
- the character to search for- Returns:
- the position of the first occurrence, or -1 if not found
-
toString
Convert contents of the FastStringBuffer to a string- Specified by:
toString
in interfaceCharSequence
- Overrides:
toString
in classObject
-
equals
Compare equality -
hashCode
public int hashCode()Generate a hash code -
toCharArray
public char[] toCharArray()Get a char[] array containing the characters. The caller should not modify the array.- Returns:
- a char[] array containing the characters.
-
setCharAt
public void setCharAt(int index, char ch) Set the character at a particular offset- Parameters:
index
- the index of the character to be setch
- the new character to overwrite the existing character at that location- Throws:
IndexOutOfBoundsException
- if int<0 or int>=length()
-
insert
public void insert(int index, char ch) Insert a character at a particular offset- Parameters:
index
- the index of the character to be setch
- the new character to insert at that location- Throws:
IndexOutOfBoundsException
- if int<0 or int>=length()
-
insertWideChar
public void insertWideChar(int index, int ch) Insert wide character at a particular offset- Parameters:
index
- the index of the character to be setch
- the character, as a 32-bit Unicode codepoint- Throws:
IndexOutOfBoundsException
- if int<0 or int>=length()
-
removeCharAt
public void removeCharAt(int index) Remove a character at a particular offset- Parameters:
index
- the index of the character to be set- Throws:
IndexOutOfBoundsException
- if int<0 or int>=length()
-
prepend
public void prepend(char ch) Insert a given character at the start of the buffer- Parameters:
ch
- the character to insert
-
prepend
Insert a given string at the start of the buffer- Parameters:
str
- the string to insert
-
prependRepeated
public void prependRepeated(char ch, int repeat) Insert a given character N times at the start of the buffer- Parameters:
ch
- the character to insertrepeat
- the number of occurrences required. Supplying 0 or a negative number is OK, and is treated as a no-op.
-
setLength
public void setLength(int length) Set the length. If this exceeds the current length, this method is a no-op. If this is less than the current length, characters beyond the specified point are deleted.- Specified by:
setLength
in interfaceAppendableCharSequence
- Parameters:
length
- the new length
-
ensureCapacity
public void ensureCapacity(int extra) Expand the character array if necessary to ensure capacity for appended data- Parameters:
extra
- the amount of additional capacity needed, in characters
-
condense
Remove surplus space from the array. This doesn't reduce the array to the minimum possible size; it only reclaims space if it seems worth doing. Specifically, it contracts the array if the amount of wasted space is more than 256 characters, or more than half the allocated size and more than 20 chars.- Returns:
- the buffer after removing unused space
-
write
Write the value to a writer- Parameters:
writer
- the writer to which the content is to be written- Throws:
IOException
-
diagnosticPrint
Diagnostic print of the contents of a CharSequence. Ordinary printable ASCII characters are displayed as themselves; anything else is displayed as a \\uNNNN escape sequence- Parameters:
in
- the CharSequence whose contents are to be displayed.- Returns:
- the diagnostic output
-