7093322: (fs spec) Files.newBufferedWriter should be clear when coding errors are detected

Reviewed-by: alanb
2022-12-15 17:27:39 +00:00 · 2022-12-15 17:27:39 +00:00 · 831b35fad3
commit 831b35fad3
parent 0288210f25
1 changed files with 6 additions and 1 deletions
--- a/src/java.base/share/classes/java/nio/file/Files.java
+++ b/src/java.base/share/classes/java/nio/file/Files.java
@ -2938,7 +2938,12 @@ public final class Files {
     * a size of {@code 0} if it exists.
     *
     * <p> The {@code Writer} methods to write text throw {@code IOException}
-     * if the text cannot be encoded using the specified charset.
+     * if the text cannot be encoded using the specified charset. Due to
+     * buffering, an {@code IOException} caused by an encoding error
+     * (unmappable-character or malformed-input) may be thrown when {@linkplain
+     * BufferedWriter#write(char[],int,int) writing}, {@linkplain
+     * BufferedWriter#flush flushing}, or {@linkplain BufferedWriter#close
+     * closing} the buffered writer.
     *
     * @param   path
     *          the path to the file