Draft: CharSequence.getChars

mkarg · Oct 23, 2024 · 523606e · 523606e
1 parent e17d33e
commit 523606e
Show file tree

Hide file tree

Showing 3 changed files with 61 additions and 10 deletions.
diff --git a/src/java.base/share/classes/java/io/Reader.java b/src/java.base/share/classes/java/io/Reader.java
@@ -194,16 +194,7 @@ public int read(char[] cbuf, int off, int len) throws IOException {
                 if (next >= length)
                     return -1;
                 int n = Math.min(length - next, len);
-                switch (cs) {
-                    case String s -> s.getChars(next, next + n, cbuf, off);
-                    case StringBuilder sb -> sb.getChars(next, next + n, cbuf, off);
-                    case StringBuffer sb -> sb.getChars(next, next + n, cbuf, off);
-                    case CharBuffer cb -> cb.get(next, cbuf, off, n);
-                    default -> {
-                        for (int i = 0; i < n; i++)
-                            cbuf[off + i] = cs.charAt(next + i);
-                    }
-                }
+                cs.getChars(next, next + n, cbuf, off);
                 next += n;
                 return n;
             }

diff --git a/src/java.base/share/classes/java/lang/CharSequence.java b/src/java.base/share/classes/java/lang/CharSequence.java
@@ -302,4 +302,41 @@ public static int compare(CharSequence cs1, CharSequence cs2) {
         return cs1.length() - cs2.length();
     }
 
+    /**
+     * Characters are copied from this sequence into the destination character
+     * array {@code dst}.
+     *
+     * The first character to be copied is at index {@code srcBegin}; the last
+     * character to be copied is at index {@code srcEnd-1}. The total number of
+     * characters to be copied is {@code srcEnd-srcBegin}. The characters are
+     * copied into the subarray of {@code dst} starting at index {@code dstBegin}
+     * and ending at index {@code dstBegin + (srcEnd-srcBegin) - 1}.
+     *
+     * @implSpec
+     * The default implementation invokes {@link #charAt(int)} to sequentially
+     * copy one char after the other.
+     *
+     * @param      srcBegin   start copying at this offset.
+     * @param      srcEnd     stop copying at this offset.
+     * @param      dst        the array to copy the data into.
+     * @param      dstBegin   offset into {@code dst}.
+     * @throws     IndexOutOfBoundsException  if any of the following is true:
+     *             <ul>
+     *             <li>{@code srcBegin} is negative
+     *             <li>{@code dstBegin} is negative
+     *             <li>the {@code srcBegin} argument is greater than the
+     *                 {@code srcEnd} argument.
+     *             <li>{@code srcEnd} is greater than {@code this.length()}.
+     *             <li>{@code dstBegin+srcEnd-srcBegin} is greater than
+     *                 {@code dst.length}
+     *             </ul>
+     *
+     * @since 24
+     */
+    public default void getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin) {
+        Objects.checkFromToIndex(srcBegin, srcEnd, length());
+        Objects.checkFromIndexSize(dstBegin, srcEnd - srcBegin, dst.length);
+        while (srcBegin < srcEnd)
+            dst[dstBegin++] = charAt(srcBegin++);
+    }
 }
diff --git a/src/java.base/share/classes/java/nio/X-Buffer.java.template b/src/java.base/share/classes/java/nio/X-Buffer.java.template
@@ -2333,4 +2333,27 @@ public abstract sealed class $Type$Buffer
 
 #end[streamableType]
 
+#if[char]
+    /**
+     * {@inheritDoc}
+     *
+     * @apiNote This method exists solely to implement
+     * {@link CharSequence#getChars(int,int,char[],int)}.
+     * It has no additional benefit over {@link #get(int, char[], int, int)}.
+     *
+     * @implSpec This method is equivalent to
+     * {@code get(srcBegin, dst, dstBegin, srcEnd - srcBegin)}.
+     *
+     * @implNote This method allows for superior performance over the default
+     * implementation in {@code CharSequence.getChars()}. It performs a direct
+     * buffer-to-array copy of the complete specified region.
+     *
+     * @since 24
+     */
+    @Override
+    public void getChars(int srcBegin, int srcEnd, char[] dst, int dstBegin) {
+        get(srcBegin, dst, dstBegin, srcEnd - srcBegin);
+    }
+#end[char]
+
 }