From 2f0b80463d442fcfc1074465eb383d95efaf39e3 Mon Sep 17 00:00:00 2001 From: michelou Date: Thu, 21 Feb 2008 18:45:45 +0000 Subject: removed RichString methods and @throws --- src/dotnet-library/scala/StringBuilder.scala | 364 +++++++++++++++++++++++---- 1 file changed, 317 insertions(+), 47 deletions(-) (limited to 'src/dotnet-library') diff --git a/src/dotnet-library/scala/StringBuilder.scala b/src/dotnet-library/scala/StringBuilder.scala index 683f0afa70..2c606f0ed4 100644 --- a/src/dotnet-library/scala/StringBuilder.scala +++ b/src/dotnet-library/scala/StringBuilder.scala @@ -6,7 +6,7 @@ ** |/ ** \* */ -// $Id: $ +// $Id: StringBuilder.scala 14093 2008-02-21 16:55:26Z michelou $ package scala @@ -20,9 +20,10 @@ import Predef._ *

* * @author Stephane Micheloud + * @version 1.0 */ -@throws(classOf[NullPointerException]) -final class StringBuilder(initCapacity: Int, private val initValue: String) extends (Int => Char) with Proxy { +final class StringBuilder(initCapacity: Int, private val initValue: String) +extends (Int => Char) with Proxy { if (initCapacity < 0) throw new IllegalArgumentException if (initValue eq null) throw new NullPointerException @@ -32,11 +33,20 @@ final class StringBuilder(initCapacity: Int, private val initValue: String) exte /** The count is the number of characters used. */ private var count: Int = 0 + /** Constructs a string builder with no characters in it and an + * initial capacity of 16 characters. + */ def this() = this(16, "") + /** Constructs a string builder with no characters in it and an + * initial capacity specified by the capacity argument. + * + * @param capacity the initial capacity. + * @throws NegativeArraySizeException if the capacity + * argument is less than 0. + */ def this(capacity: Int) = this(capacity, "") - @throws(classOf[NullPointerException]) def this(str: String) = this(16, str) append(initValue) @@ -49,7 +59,11 @@ final class StringBuilder(initCapacity: Int, private val initValue: String) exte def length_=(n: Int) { setLength(n) } - @throws(classOf[StringIndexOutOfBoundsException]) + /** Sets the length of the character sequence. + * + * @param newLength the new length + * @throws IndexOutOfBoundsException if the n argument is negative. + */ def setLength(n: Int) { if (n < 0) throw new StringIndexOutOfBoundsException//(n) @@ -62,10 +76,33 @@ final class StringBuilder(initCapacity: Int, private val initValue: String) exte count = n } + /** Returns the current capacity. The capacity is the amount of storage + * available for newly inserted characters, beyond which an allocation + * will occur. + * + * @return the current capacity + */ def capacity: Int = value.length + /** Same as ensureCapacity. */ def capacity_=(n: Int) { ensureCapacity(n) } + /**

+ * Ensures that the capacity is at least equal to the specified minimum. + * If the current capacity is less than the argument, then a new internal + * array is allocated with greater capacity. The new capacity is the larger of: + *

+ * + *

+ * If the n argument is non-positive, this + * method takes no action and simply returns. + *

+ * + * @param n the minimum desired capacity. + */ def ensureCapacity(n: Int) { if (n > value.length) expandCapacity(n) } @@ -78,17 +115,40 @@ final class StringBuilder(initCapacity: Int, private val initValue: String) exte ) } - @throws(classOf[StringIndexOutOfBoundsException]) + /**

+ * Returns the Char value in this sequence at the specified index. + * The first Char value is at index 0, the next at index + * 1, and so on, as in array indexing. + *

+ *

+ * The index argument must be greater than or equal to + * 0, and less than the length of this sequence. + *

+ * + * @param index the index of the desired Char value. + * @return the Char value at the specified index. + * @throws IndexOutOfBoundsException if index is + * negative or greater than or equal to length(). + */ def charAt(index: Int): Char = { if (index < 0 || index >= count) throw new StringIndexOutOfBoundsException//(index) value(index) } - @throws(classOf[StringIndexOutOfBoundsException]) + /** Same as charAt. */ def apply(i: Int): Char = charAt(i) - @throws(classOf[StringIndexOutOfBoundsException]) + /**

+ * Removes the Char at the specified position in this + * sequence. This sequence is shortened by one Char. + *

+ * + * @param index Index of Char to remove + * @return This object. + * @throws StringIndexOutOfBoundsException if the index + * is negative or greater than or equal to length(). + */ def deleteCharAt(index: Int): StringBuilder = { if (index < 0 || index >= count) throw new StringIndexOutOfBoundsException//(index) @@ -97,20 +157,56 @@ final class StringBuilder(initCapacity: Int, private val initValue: String) exte this } - @throws(classOf[StringIndexOutOfBoundsException]) - def setCharAt(index: Int, c: Char) { + /**

+ * The character at the specified index is set to ch. This + * sequence is altered to represent a new character sequence that is + * identical to the old character sequence, except that it contains the + * character ch at position index. + *

+ *

+ * The index argument must be greater than or equal to + * 0, and less than the length of this sequence. + *

+ * + * @param index the index of the character to modify. + * @param ch the new character. + * @throws IndexOutOfBoundsException if index is + * negative or greater than or equal to length(). + */ + def setCharAt(index: Int, ch: Char) { if (index < 0 || index >= count) throw new StringIndexOutOfBoundsException//(index) - value(index) = c + value(index) = ch } - @throws(classOf[StringIndexOutOfBoundsException]) + /** Same as setCharAt. */ def update(i: Int, c: Char) { setCharAt(i, c) } - @throws(classOf[StringIndexOutOfBoundsException]) + /** Returns a new String that contains a subsequence of + * characters currently contained in this character sequence. The + * substring begins at the specified index and extends to the end of + * this sequence. + * + * @param start The beginning index, inclusive. + * @return The new string. + * @throws StringIndexOutOfBoundsException if start is + * less than zero, or greater than the length of this object. + */ def substring(start: Int): String = substring(start, count) - @throws(classOf[StringIndexOutOfBoundsException]) + /** Returns a new String that contains a subsequence of + * characters currently contained in this sequence. The + * substring begins at the specified start and + * extends to the character at index end - 1. + * + * @param start The beginning index, inclusive. + * @param end The ending index, exclusive. + * @return The new string. + * @throws StringIndexOutOfBoundsException if start + * or end are negative or greater than + * length(), or start is + * greater than end. + */ def substring(start: Int, end: Int): String = { if (start < 0) throw new StringIndexOutOfBoundsException//(start) @@ -121,13 +217,26 @@ final class StringBuilder(initCapacity: Int, private val initValue: String) exte new String(value, start, end - start) } + /**

+ * Appends the string representation of the Any + * argument. + *

+ *

+ * The argument is converted to a string as if by the method + * System.Convert.ToString, and the characters of + * that string are then appended to this sequence. + *

+ * + * @param x an Any object. + * @return a reference to this object. + */ def append(x: Any): StringBuilder = append(System.Convert.ToString(x)) /** Appends the specified string to this character sequence. * - * @param s - * @return + * @param s a string. + * @return a reference to this object. */ def append(s: String): StringBuilder = { val str = if (s == null) "null" else s @@ -135,7 +244,7 @@ final class StringBuilder(initCapacity: Int, private val initValue: String) exte if (len > 0) { val newCount = count + len if (newCount > value.length) expandCapacity(newCount) - compat.Platform.arraycopy(str.toArray: Array[Char], 0, value, count, len) + compat.Platform.arraycopy(str.ToCharArray, 0, value, count, len) count = newCount } this @@ -158,9 +267,38 @@ final class StringBuilder(initCapacity: Int, private val initValue: String) exte this } + /**

+ * Appends the string representation of the Char array + * argument to this sequence. + *

+ *

+ * The characters of the array argument are appended, in order, to + * the contents of this sequence. The length of this sequence + * increases by the length of the argument. + *

+ * + * @param x the characters to be appended. + * @return a reference to this object. + */ def append(x: Array[Char]): StringBuilder = append(x, 0, x.length) + /**

+ * Appends the string representation of a subarray of the + * char array argument to this sequence. + *

+ *

+ * Characters of the Char array x, starting at + * index offset, are appended, in order, to the contents + * of this sequence. The length of this sequence increases + * by the value of len. + *

+ * + * @param x the characters to be appended. + * @param offset the index of the first Char to append. + * @param len the number of Chars to append. + * @return a reference to this object. + */ def append(x: Array[Char], offset: Int, len: Int): StringBuilder = { val newCount = count + len if (newCount > value.length) expandCapacity(newCount) @@ -169,6 +307,19 @@ final class StringBuilder(initCapacity: Int, private val initValue: String) exte this } + /**

+ * Appends the string representation of the Boolean + * argument to the sequence. + *

+ *

+ * The argument is converted to a string as if by the method + * System.Convert.ToString, and the characters of + * that string are then appended to this sequence. + *

+ * + * @param x a Boolean. + * @return a reference to this object. + */ def append(x: Boolean): StringBuilder = { if (x) { val newCount = count + 4 @@ -208,7 +359,19 @@ final class StringBuilder(initCapacity: Int, private val initValue: String) exte def append(x: Double): StringBuilder = append(System.Convert.ToString(x)) - @throws(classOf[StringIndexOutOfBoundsException]) + /** Removes the characters in a substring of this sequence. + * The substring begins at the specified start and extends to + * the character at index end - 1 or to the end of the + * sequence if no such character exists. If + * start is equal to end, no changes are made. + * + * @param start The beginning index, inclusive. + * @param end The ending index, exclusive. + * @return This object. + * @throws StringIndexOutOfBoundsException if start + * is negative, greater than length(), or + * greater than end. + */ def delete(start: Int, end: Int): StringBuilder = { if (start < 0 || start > end) throw new StringIndexOutOfBoundsException//(start) @@ -221,7 +384,21 @@ final class StringBuilder(initCapacity: Int, private val initValue: String) exte this } - @throws(classOf[StringIndexOutOfBoundsException]) + /** Replaces the characters in a substring of this sequence + * with characters in the specified String. The substring + * begins at the specified start and extends to the character + * at index end - 1 or to the end of the sequence if no such + * character exists. First the characters in the substring are removed and + * then the specified String is inserted at start. + * + * @param start The beginning index, inclusive. + * @param end The ending index, exclusive. + * @param str String that will replace previous contents. + * @return This object. + * @throws StringIndexOutOfBoundsException if start + * is negative, greater than length(), or + * greater than end. + */ def replace(start: Int, end: Int, str: String) { if (start < 0 || start > count || start > end) throw new StringIndexOutOfBoundsException//(start) @@ -232,12 +409,31 @@ final class StringBuilder(initCapacity: Int, private val initValue: String) exte if (newCount > value.length) expandCapacity(newCount) compat.Platform.arraycopy(value, end, value, start + len, count - end) - compat.Platform.arraycopy(str.toArray, 0, value, start, len) + compat.Platform.arraycopy(str.ToCharArray, 0, value, start, len) count = newCount this } - @throws(classOf[StringIndexOutOfBoundsException]) + /** Inserts the string representation of a subarray of the str + * array argument into this sequence. The subarray begins at the specified + * offset and extends len chars. + * The characters of the subarray are inserted into this sequence at + * the position indicated by index. The length of this + * sequence increases by len Chars. + * + * @param index position at which to insert subarray. + * @param str a Char array. + * @param offset the index of the first char in subarray to + * be inserted. + * @param len the number of Chars in the subarray to + * be inserted. + * @return This object + * @throws StringIndexOutOfBoundsException if index + * is negative or greater than length(), or + * offset or len are negative, or + * (offset+len) is greater than + * str.length. + */ def insert(index: Int, str: Array[Char], offset: Int, len: Int): StringBuilder = { if (index < 0 || index > count) throw new StringIndexOutOfBoundsException//(index) @@ -253,11 +449,37 @@ final class StringBuilder(initCapacity: Int, private val initValue: String) exte this } - @throws(classOf[StringIndexOutOfBoundsException]) + /**

+ * Inserts the string representation of the Any + * argument into this character sequence. + *

+ *

+ * The second argument is converted to a string as if by the method + * System.Convert.ToString, and the characters of that + * string are then inserted into this sequence at the indicated + * offset. + *

+ *

+ * The offset argument must be greater than or equal to + * 0, and less than or equal to the length of this + * sequence. + *

+ * + * @param offset the offset. + * @param x an Any value. + * @return a reference to this object. + * @throws StringIndexOutOfBoundsException if the offset is invalid. + */ def insert(at: Int, x: Any): StringBuilder = insert(at, System.Convert.ToString(x)) - @throws(classOf[StringIndexOutOfBoundsException]) + /** Inserts the string into this character sequence. + * + * @param at the offset position. + * @param x a string. + * @return a reference to this object. + * @throws StringIndexOutOfBoundsException if the offset is invalid. + */ def insert(at: Int, x: String): StringBuilder = { if (at < 0 || at > count) throw new StringIndexOutOfBoundsException//(at) @@ -266,12 +488,19 @@ final class StringBuilder(initCapacity: Int, private val initValue: String) exte val newCount = count + len if (newCount > value.length) expandCapacity(newCount) compat.Platform.arraycopy(value, at, value, at + len, count - at) - compat.Platform.arraycopy(str.toArray: Array[Char], 0, value, at, len) + compat.Platform.arraycopy(str.ToCharArray, 0, value, at, len) count = newCount this } - @throws(classOf[StringIndexOutOfBoundsException]) + /** Inserts the string representation of the Char array + * argument into this sequence. + * + * @param at the offset position. + * @param x a character array. + * @return a reference to this object. + * @throws StringIndexOutOfBoundsException if the offset is invalid. + */ def insert(at: Int, x: Array[Char]): StringBuilder = { if (at < 0 || at > count) throw new StringIndexOutOfBoundsException//(at) @@ -284,11 +513,9 @@ final class StringBuilder(initCapacity: Int, private val initValue: String) exte this } - @throws(classOf[StringIndexOutOfBoundsException]) def insert(at: Int, x: Boolean): StringBuilder = insert(at, System.Convert.ToString(x)) - @throws(classOf[StringIndexOutOfBoundsException]) def insert(at: Int, x: Char): StringBuilder = { if (at < 0 || at > count) throw new StringIndexOutOfBoundsException//(at) @@ -300,36 +527,76 @@ final class StringBuilder(initCapacity: Int, private val initValue: String) exte this } - @throws(classOf[StringIndexOutOfBoundsException]) def insert(at: Int, x: Int): StringBuilder = insert(at, System.Convert.ToString(x)) - @throws(classOf[StringIndexOutOfBoundsException]) def insert(at: Int, x: Long): StringBuilder = - insert(at, System.Convert.ToString(x)) + insert(at, System.Convert.ToString(x)) - @throws(classOf[StringIndexOutOfBoundsException]) def insert(at: Int, x: Float): StringBuilder = insert(at, System.Convert.ToString(x)) - @throws(classOf[StringIndexOutOfBoundsException]) def insert(at: Int, x: Double): StringBuilder = insert(at, System.Convert.ToString(x)) - @throws(classOf[NullPointerException]) + /** Returns the index within this string of the first occurrence of the + * specified substring. The integer returned is the smallest value + * k such that: + * 
+   *  this.toString().startsWith(str, k)
+   *
+ * is true. + * + * @param str any string. + * @return if the string argument occurs as a substring within this + * object, then the index of the first character of the first + * such substring is returned; if it does not occur as a + * substring, -1 is returned. + * @throws NullPointerException if str is null. + */ def indexOf(str: String): Int = indexOf(str, 0) - @throws(classOf[NullPointerException]) def indexOf(str: String, fromIndex: Int): Int = - StringBuilder.indexOf(value, 0, count, str.toArray, 0, str.length(), fromIndex) - - @throws(classOf[NullPointerException]) + StringBuilder.indexOf(value, 0, count, str.ToCharArray, 0, str.length(), fromIndex) + + /** Returns the index within this string of the rightmost occurrence + * of the specified substring. The rightmost empty string "" is + * considered to occur at the index value this.length(). + * The returned index is the largest value k such that + * 
+   *  this.toString().startsWith(str, k)
+   *
+ * is true. + * + * @param str the substring to search for. + * @return if the string argument occurs one or more times as a substring + * within this object, then the index of the first character of + * the last such substring is returned. If it does not occur as + * a substring, -1 is returned. + * @throws NullPointerException if str is null. + */ def lastIndexOf(str: String): Int = lastIndexOf(str, count) - @throws(classOf[NullPointerException]) def lastIndexOf(str: String, fromIndex: Int): Int = - StringBuilder.lastIndexOf(value, 0, count, str.toArray, 0, str.length(), fromIndex) - + StringBuilder.lastIndexOf(value, 0, count, str.ToCharArray, 0, str.length(), fromIndex) + + /**

+ * Causes this character sequence to be replaced by the reverse of the + * sequence. If there are any surrogate pairs included in the sequence, + * these are treated as single characters for the reverse operation. + * Thus, the order of the high-low surrogates is never reversed. + *

+ *

+ * Let n be the character length of this character sequence + * (not the length in Char values) just prior to + * execution of the reverse method. Then the + * character at index k in the new character sequence is + * equal to the character at index n-k-1 in the old + * character sequence. + *

+ * + * @return a reference to this object. + */ def reverse(): StringBuilder = { val n = count - 1 var j = (n-1) >> 1 @@ -343,6 +610,15 @@ final class StringBuilder(initCapacity: Int, private val initValue: String) exte this } + /** Returns a string representing the data in this sequence. + * A new String object is allocated and initialized to + * contain the character sequence currently represented by this + * object. This String is then returned. Subsequent + * changes to this sequence do not affect the contents of the + * String. + * + * @return a string representation of this sequence of characters. + */ override def toString(): String = new String(value, 0, count) } @@ -353,13 +629,7 @@ object StringBuilder { // method java.util.Arrays.copyOf exists since 1.6 private def copyOf(src: Array[Char], newLength: Int): Array[Char] = { val dest = new Array[Char](newLength) - val (start, end) = - if (src.length < newLength) (src.length, newLength) - else (newLength, src.length) - compat.Platform.arraycopy(src, 0, dest, 0, start) - // For any indices that are valid in the copy but not the original, - // the copy will contain '\\u000'. - for (i <- start until end) dest(i) = '\0' + compat.Platform.arraycopy(src, 0, dest, 0, Math.min(src.length, newLength)) dest } -- cgit v1.2.3