Java – Rename or Move a File

1. Overview

In this quick tutorial, we’re going to look at renaming / moving a File in Java.

We’ll first look into using the Files and Path classes from NIO, then the Java File class, Google Guava, and finally the Apache Commons IO library.

This article is part of the “Java – Back to Basic” series here on VietMX’s Blog.

2. Setup

In the examples, we’ll use the following setup, which consists of 2 constants for the source and destination file name and a clean-up step to be able to run the tests multiple times:

private final String FILE_TO_MOVE = "src/test/resources/originalFileToMove.txt";
private final String TARGET_FILE = "src/test/resources/targetFileToMove.txt";

@BeforeEach
public void createFileToMove() throws IOException {
    File fileToMove = new File(FILE_TO_MOVE);
    fileToMove.createNewFile();
}

@AfterEach
public void cleanUpFiles() {
    File targetFile = new File(TARGET_FILE);
    targetFile.delete();
}

3. Using the NIO Paths and Files Classes

Let’s start by using the Files.move() method from the Java NIO package:

@Test
public void givenUsingNio_whenMovingFile_thenCorrect() throws IOException {
    Path fileToMovePath = Paths.get(FILE_TO_MOVE);
    Path targetPath = Paths.get(TARGET_FILE);
    Files.move(fileToMovePath, targetPath);
}

In JDK7 the NIO package was significantly updated, and the Path class added. This provides methods for convenient manipulation of File System artifacts.

Note that both the file and the target directory should exist.

4. Using the File Class

Let’s now look at how we can do the same using the File.renameTo() method:

@Test
public void givenUsingFileClass_whenMovingFile_thenCorrect() throws IOException {
    File fileToMove = new File(FILE_TO_MOVE);
    boolean isMoved = fileToMove.renameTo(new File(TARGET_FILE));
    if (!isMoved) {
        throw new FileSystemException(TARGET_FILE);
    }
}

In this example, the file to be moved does exist, as well as the target directory.

Note that renameTo() only throws two types of exceptions:

  • SecurityException – if a security manager denies writing access to either the source or to the destination
  • NullPointerException – in case the parameter target is null

If the target does not exist in a file system – no exception will be thrown – and you will have to check the returned success flag of the method.

5. Using Guava

Next – let’s take a look at the Guava solution, which provides a convenient Files.move() method:

@Test
public void givenUsingGuava_whenMovingFile_thenCorrect()
        throws IOException {
    File fileToMove = new File(FILE_TO_MOVE);
    File targetFile = new File(TARGET_FILE);

    com.google.common.io.Files.move(fileToMove, targetFile);
}

Again, in this example, the file to be moved and the target directory need to exist.

6. With Commons IO

Finally, let’s take a look at a solution with Apache Commons IO – probably the simplest one:

@Test
public void givenUsingApache_whenMovingFile_thenCorrect() throws IOException {
    FileUtils.moveFile(FileUtils.getFile(FILE_TO_MOVE), FileUtils.getFile(TARGET_FILE));
}

This one line will, of course, allow both moving or renaming, depending on if the target directory is the same or not.

Alternatively – here’s a solution for moving specifically, also enabling us to automatically create the destination directory if it doesn’t already exist:

@Test
public void givenUsingApache_whenMovingFileApproach2_thenCorrect() throws IOException {
    FileUtils.moveFileToDirectory(
      FileUtils.getFile("src/test/resources/fileToMove.txt"), 
      FileUtils.getFile("src/main/resources/"), true);
}

6. Conclusion

In this article, we looked at different solutions for moving a file in Java. We focused on renaming in these code snippets, but moving is, of course, the same, only the target directory needs to be different.

The code for the examples is available over on GitHub.

Related posts:

Returning Custom Status Codes from Spring Controllers
Spring Boot - Build Systems
Display Auto-Configuration Report in Spring Boot
Java Program to Implement Variable length array
New in Spring Security OAuth2 – Verify Claims
Recommended Package Structure of a Spring Boot Project
Quick Guide to the Java StringTokenizer
Hướng dẫn Java Design Pattern – Singleton
Java Streams vs Vavr Streams
Spring Web Annotations
Java Program to find the maximum subarray sum using Binary Search approach
Java Program to Test Using DFS Whether a Directed Graph is Weakly Connected or Not
So sánh HashSet, LinkedHashSet và TreeSet trong Java
Java Map With Case-Insensitive Keys
HTTP Authentification and CGI/Servlet
JUnit5 @RunWith
Database Migrations with Flyway
Java Program to Perform Cryptography Using Transposition Technique
Lập trình hướng đối tượng (OOPs) trong java
Java Program to Find the Mode in a Data Set
Most commonly used String methods in Java
Java Program to Check Whether an Undirected Graph Contains a Eulerian Path
Lớp LinkedHashMap trong Java
Sending Emails with Java
Intersection of Two Lists in Java
Java Program to Perform Partition of an Integer in All Possible Ways
Java Program to Find Transpose of a Graph Matrix
A Guide to Spring Cloud Netflix – Hystrix
Java Program to Implement Flood Fill Algorithm
Java Program to Implement Solovay Strassen Primality Test Algorithm
Java Program to Check Whether a Weak Link i.e. Articulation Vertex Exists in a Graph
Properties with Spring and Spring Boot