RFR: 6245663: (spec) File.renameTo(File) changes the file-system object, not the File instance [v2]

[Brian Burkhalter]

On Thu, 18 Feb 2021 09:24:06 GMT, Alan Bateman <alanb at openjdk.org> wrote:

>> No, I intended `filesystem` but in the sense of "object in the filesystem" but it does seem awkward.
>
> It might be clearer if the end of the sentence were changed to something like "... this File object is not changed to name destination file or directory".

Like so?
--- a/src/java.base/share/classes/java/io/File.java
+++ b/src/java.base/share/classes/java/io/File.java
@@ -1376,7 +1376,9 @@ public class File
      * file from one filesystem to another, it might not be atomic, and it
      * might not succeed if a file with the destination abstract pathname
      * already exists.  The return value should always be checked to make sure
-     * that the rename operation was successful.
+     * that the rename operation was successful.  As instances of {@code File}
+     * are immutable, this File object is not changed to name the destination
+     * file or directory.
      *
      * <p> Note that the {@link java.nio.file.Files} class defines the {@link
      * java.nio.file.Files#move move} method to move or rename a file in a

-------------

PR: https://git.openjdk.java.net/jdk/pull/2618