Java - File renameTo(File dest) method



Description

The Java File renameTo(File dest) method is used to rename or move a file to a new location. It returns true if the renaming/moving operation is successful and false if it fails.

Declaration

Following is the declaration for java.io.File.renameTo(File dest) method −

public boolean renameTo(File dest)

Parameters

dest− The new abstract pathname for this abstract pathname.

Return Value

This method returns true if the renaming succeeded, else false.

Exception

  • SecurityException − If a security manager exists and its method denies write access to either the old or new pathnames.

  • NullPointerException − If parameter destination is null.

Example - Usage of File renameTo(File dest) method

The following example shows the usage of Java File renameTo(File dest) method. We've created two File references. Then we're creating a File Object using a file path which is present in the given location and a new File which is not present. Using renameTo() method, we're trying to rename the first time and getting the result in boolean variable. Then we're printing the status of directory being created or not.

FileDemo.java

package com.tutorialspoint;

import java.io.File;

public class FileDemo {
   public static void main(String[] args) {      
      File f = null;
      File f1 = null;
      boolean bool = false;
      
      try {  
      
         // create new File objects
         f = new File("F:/Test2/test.txt");
         f1 = new File("F:/Test2/testABC.txt");
         
         // rename file
         bool = f.renameTo(f1);
         
         // print
         System.out.print("File renamed? "+bool);
         
      } catch(Exception e) {
         // if any error occurs
         e.printStackTrace();
      }
   }
}

Output

Let us compile and run the above program, this will produce the following result−

File renamed? true

Now, you can check that file is renamed.

Example - Usage of File renameTo(File dest) method

The following example shows the usage of Java File renameTo(File dest) method. We've created two File references. Then we're creating a File Object using a file path which is present in the given location and a new file which is also present. Using renameTo() method, we're trying to rename the first time and getting the result in boolean variable. Then we're printing the status of directory being created or not.

FileDemo.java

package com.tutorialspoint;

import java.io.File;

public class FileDemo {
   public static void main(String[] args) {      
      File f = null;
      File f1 = null;
      boolean bool = false;
      
      try {  
      
         // create new File objects
         f = new File("F:/Test2/test.txt");
         f1 = new File("F:/Test2/testABC.txt");
         
         // rename file
         bool = f.renameTo(f1);
         
         // print
         System.out.print("File renamed? "+bool);
         
      } catch(Exception e) {
         // if any error occurs
         e.printStackTrace();
      }
   }
}

Output

Let us compile and run the above program, this will produce the following result−

File renamed? false

Example - Renaming a File

The following example shows the usage of Java File renameTo(File dest) method.

FileDemo.java

package com.tutorialspoint;

import java.io.File;

public class FileDemo {
   public static void main(String[] args) {      
      // Creating a File object representing the existing file
      File oldFile = new File("oldfile.txt");

      // Creating a File object representing the new file name
      File newFile = new File("newfile.txt");

      // Attempt to rename the file
      if (oldFile.renameTo(newFile)) {
         System.out.println("File renamed successfully to: " + newFile.getAbsolutePath());
      } else {
         System.out.println("Failed to rename file. Ensure the file exists and is not open.");
      }
   }
}

Output

Let us compile and run the above program, this will produce the following result−

File renamed successfully to: C:\Users\YourName\newfile.txt

Explanation

  • The File object oldFile represents an existing file named oldfile.txt.

  • The File object newFile represents the new name (newfile.txt).

  • The renameTo() method attempts to rename oldfile.txt to newfile.txt.

  • If successful, it prints the new file path.

  • If the operation fails (e.g., the file doesn't exist or is open in another program), it prints an error message.

  • It can also move the file if the new file path is in a different directory.

java_io_file_methods.htm
Advertisements