File renameTo() method in Java with examples

The renameTo() method is a part of File class. The renameTo() function is used to rename the abstract path name of a File to a given path name. The function returns true if the file is renamed else returns false

Function Signature:

public boolean renameTo(File destination)

Syntax:



file.renameTo(File destination)

Parameters: The function requires File object destination as parameter, the new abstract path name of the present file.

Return Value: The function returns boolean data type. The function returns true the file is renamed else returns false

Exception: This method throws following exceptions:

  • Security Exception if the method does not allow write operation of the abstract pathnames.
  • NullPointerException if the destination filename is null.

Below programs will illustrate the use of renameTo() function:

Example 1: Try to rename the file program.txt to program1.txt

filter_none

edit
close

play_arrow

link
brightness_4
code

// Java program to demonstrate
// the use of File.renameTo() method
  
import java.io.*;
  
public class GFG {
  
    public static void main(String args[])
    {
        // create an abstract pathname (File object)
        File f = new File("F:\\program.txt");
  
        // create the destination file object
        File dest = new File("F:\\program1.txt");
  
        // check if the file can be renamed
        // to the abstract path name
        if (f.renameTo(dest)) {
  
            // display that the file is renamed
            // to the abstract path name
            System.out.println("File is renamed");
        }
        else {
            // display that the file cannot be renamed
            // to the abstract path name
            System.out.println("File cannot be renamed");
        }
    }
}

chevron_right


Output:

File is renamed

Example 2: Try to rename “program1.txt” to “prog.txt”, “prog.txt” is a existing file in the f: drive .

filter_none

edit
close

play_arrow

link
brightness_4
code

// Java program to demonstrate
// the use of File.renameTo() method
  
import java.io.*;
  
public class GFG {
    public static void main(String args[])
    {
        // create an abstract pathname (File object)
        File f = new File("F:\\program1.txt");
  
        // create the destination file object
        File dest = new File("F:\\prog.txt");
  
        // check if the file can be renamed
        // to the abstract path name
        if (f.renameTo(dest)) {
  
            // display that the file is renamed
            // to the abstract path name
            System.out.println("File is renamed");
        }
        else {
            // display that the file cannot be renamed
            // to the abstract path name
            System.out.println("File cannot be renamed");
        }
    }
}

chevron_right


Output:

File cannot be renamed

The programs might not run in an online IDE. please use an offline IDE and set the path of the file



My Personal Notes arrow_drop_up

Second year Department of Information Technology Jadavpur University

If you like GeeksforGeeks and would like to contribute, you can also write an article using contribute.geeksforgeeks.org or mail your article to contribute@geeksforgeeks.org. See your article appearing on the GeeksforGeeks main page and help other Geeks.

Please Improve this article if you find anything incorrect by clicking on the "Improve Article" button below.