diff options
Diffstat (limited to 'sal/inc/rtl/strbuf.hxx')
| -rw-r--r-- | sal/inc/rtl/strbuf.hxx | 60 |
1 files changed, 34 insertions, 26 deletions
diff --git a/sal/inc/rtl/strbuf.hxx b/sal/inc/rtl/strbuf.hxx index 2732d1b1d..fc32b57cb 100644 --- a/sal/inc/rtl/strbuf.hxx +++ b/sal/inc/rtl/strbuf.hxx @@ -2,9 +2,9 @@ * * $RCSfile: strbuf.hxx,v $ * - * $Revision: 1.5 $ + * $Revision: 1.6 $ * - * last change: $Author: sb $ $Date: 2001-10-15 07:58:51 $ + * last change: $Author: sb $ $Date: 2001-10-30 13:41:07 $ * * The Contents of this file are made available subject to the terms of * either of the following licenses @@ -74,7 +74,8 @@ namespace rtl { -/** +/** @HTML + A string buffer implements a mutable sequence of characters. <p> String buffers are safe for use by multiple threads. The methods @@ -155,7 +156,9 @@ public: /** Constructs a string buffer so that it represents the same - sequence of characters as the string argument. The initial + sequence of characters as the string argument. + + The initial capacity of the string buffer is <code>16</code> plus the length of the string argument. @@ -191,7 +194,8 @@ public: } /** - Fill the string data in the new string and clear the buffer.<BR> + Fill the string data in the new string and clear the buffer. + This method is more efficient than the contructor of the string. It does not copy the buffer. @@ -216,7 +220,9 @@ public: } /** - Returns the current capacity of the String buffer. The capacity + Returns the current capacity of the String buffer. + + The capacity is the amount of storage available for newly inserted characters. The real buffer size is 2 bytes longer, because all strings are 0 terminated. @@ -231,6 +237,7 @@ public: /** Ensures that the capacity of the buffer is at least equal to the specified minimum. + If the current capacity of this string buffer is less than the argument, then a new internal buffer is allocated with greater capacity. The new capacity is the larger of: @@ -250,6 +257,7 @@ public: /** Sets the length of this String buffer. + If the <code>newLength</code> argument is less than the current length of the string buffer, the string buffer is truncated to contain exactly the number of characters given by the @@ -276,7 +284,7 @@ public: /** Returns the character at a specific index in this string buffer. - <p> + The first character of a string buffer is at index <code>0</code>, the next at index <code>1</code>, and so on, for array indexing. @@ -306,7 +314,7 @@ public: /** The character at the specified index of this string buffer is set to <code>ch</code>. - <p> + The offset argument must be greater than or equal to <code>0</code>, and less than the length of this string buffer. @@ -321,7 +329,7 @@ public: /** Appends the string to this string buffer. - <p> + The characters of the <code>String</code> argument are appended, in order, to the contents of this string buffer, increasing the length of this string buffer by the length of the argument. @@ -337,7 +345,7 @@ public: /** Appends the string representation of the <code>char</code> array argument to this string buffer. - <p> + The characters of the array argument are appended, in order, to the contents of this string buffer. The length of this string buffer increases by the length of the argument. @@ -353,7 +361,7 @@ public: /** Appends the string representation of the <code>char</code> array argument to this string buffer. - <p> + Characters of the character array <code>str</code> are appended, in order, to the contents of this string buffer. The length of this string buffer increases by the value of <code>len</code>. @@ -372,7 +380,7 @@ public: /** Appends the string representation of the <code>sal_Bool</code> argument to the string buffer. - <p> + The argument is converted to a string as if by the method <code>String.valueOf</code>, and the characters of that string are then appended to this string buffer. @@ -389,7 +397,7 @@ public: /** Appends the string representation of the <code>char</code> argument to this string buffer. - <p> + The argument is appended to the contents of this string buffer. The length of this string buffer increases by <code>1</code>. @@ -404,7 +412,7 @@ public: /** Appends the string representation of the <code>sal_Int32</code> argument to this string buffer. - <p> + The argument is converted to a string as if by the method <code>String.valueOf</code>, and the characters of that string are then appended to this string buffer. @@ -421,7 +429,7 @@ public: /** Appends the string representation of the <code>long</code> argument to this string buffer. - <p> + The argument is converted to a string as if by the method <code>String.valueOf</code>, and the characters of that string are then appended to this string buffer. @@ -438,7 +446,7 @@ public: /** Appends the string representation of the <code>float</code> argument to this string buffer. - <p> + The argument is converted to a string as if by the method <code>String.valueOf</code>, and the characters of that string are then appended to this string buffer. @@ -455,7 +463,7 @@ public: /** Appends the string representation of the <code>double</code> argument to this string buffer. - <p> + The argument is converted to a string as if by the method <code>String.valueOf</code>, and the characters of that string are then appended to this string buffer. @@ -471,7 +479,7 @@ public: /** Inserts the string into this string buffer. - <p> + The characters of the <code>String</code> argument are inserted, in order, into this string buffer at the indicated offset. The length of this string buffer is increased by the length of the argument. @@ -492,7 +500,7 @@ public: /** Inserts the string representation of the <code>char</code> array argument into this string buffer. - <p> + The characters of the array argument are inserted into the contents of this string buffer at the position indicated by <code>offset</code>. The length of this string buffer increases by @@ -510,7 +518,7 @@ public: /** Inserts the string representation of the <code>char</code> array argument into this string buffer. - <p> + The characters of the array argument are inserted into the contents of this string buffer at the position indicated by <code>offset</code>. The length of this string buffer increases by @@ -531,7 +539,7 @@ public: /** Inserts the string representation of the <code>sal_Bool</code> argument into this string buffer. - <p> + The second argument is converted to a string as if by the method <code>String.valueOf</code>, and the characters of that string are then inserted into this string buffer at the indicated @@ -554,7 +562,7 @@ public: /** Inserts the string representation of the <code>char</code> argument into this string buffer. - <p> + The second argument is inserted into the contents of this string buffer at the position indicated by <code>offset</code>. The length of this string buffer increases by one. @@ -575,7 +583,7 @@ public: /** Inserts the string representation of the second <code>sal_Int32</code> argument into this string buffer. - <p> + The second argument is converted to a string as if by the method <code>String.valueOf</code>, and the characters of that string are then inserted into this string buffer at the indicated @@ -598,7 +606,7 @@ public: /** Inserts the string representation of the <code>long</code> argument into this string buffer. - <p> + The second argument is converted to a string as if by the method <code>String.valueOf</code>, and the characters of that string are then inserted into this string buffer at the indicated @@ -621,7 +629,7 @@ public: /** Inserts the string representation of the <code>float</code> argument into this string buffer. - <p> + The second argument is converted to a string as if by the method <code>String.valueOf</code>, and the characters of that string are then inserted into this string buffer at the indicated @@ -644,7 +652,7 @@ public: /** Inserts the string representation of the <code>double</code> argument into this string buffer. - <p> + The second argument is converted to a string as if by the method <code>String.valueOf</code>, and the characters of that string are then inserted into this string buffer at the indicated |