Java Files writeString()

In this guide, you will learn about the Files writeString() method in Java programming and how to use it with an example.

1. Files writeString() Method Overview

Definition:

The writeString() method, introduced in Java 11, is a part of the Files class. It's used to write a CharSequence to a file. This method provides a succinct way to write content to a file, reducing the need for boilerplate code.

Syntax:

1. Files.writeString(Path path, CharSequence cs, OpenOption... options) throws IOException
2. Files.writeString(Path path, CharSequence cs, Charset cs, OpenOption... options) throws IOException

Parameters:

- path: The path to the file to write. It's a Path object indicating the file location.

- cs: The character sequence to write to the file.

- options: Optional. Specifies how the file is created or opened (e.g., CREATE, TRUNCATE_EXISTING, WRITE).

- cs: The charset to use for encoding.

Key Points:

- If the file already exists, the method overwrites it by default.

- The method opens or creates the file, writes the CharSequence in it, and then closes the file.

- Throws IOException if an I/O error occurs.

- Various OpenOption values can be specified, like StandardOpenOption.WRITE, StandardOpenOption.CREATE, etc.

- If no options are specified, this method works as if the CREATE, TRUNCATE_EXISTING, and WRITE options are present.

2. Files writeString() Method Example

import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.nio.file.StandardOpenOption;
import java.io.IOException;

public class WriteStringExample {
    public static void main(String[] args) {
        Path filePath = Paths.get("example.txt");
        String content = "Java Files.writeString() Example";

        try {
            Files.writeString(filePath, content, StandardOpenOption.CREATE);
            System.out.println("Content written to the file successfully!");
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}

Output:

Content written to the file successfully!

Explanation:

In the given example, we specify a file path and the content to write to the file. We then use the Files.writeString() method with StandardOpenOption.CREATE to either create a new file or overwrite an existing one. After successfully writing the content to the file, a confirmation message is printed to the console.