Java LocalDate plusDays()

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

1. LocalDate plusDays() Method Overview

Definition:

The plusDays() method of the LocalDate class in Java is used to return a copy of this LocalDate with the specified number of days added. This method ensures that it returns a LocalDate object, and it is useful for performing date arithmetic.

Syntax:

public LocalDate plusDays(long daysToAdd)

Parameters:

- daysToAdd: the days to add, may be negative

Key Points:

- The plusDays() method is used for adding days to the current LocalDate instance and returns a new LocalDate object.

- The method can also be used with negative parameters to go back in the past.

- The returned LocalDate is immutable, ensuring thread safety.

- The LocalDate class is part of the java.time package, introduced in Java 8.

- If the new date exceeds the maximum or minimum supported value of LocalDate, a DateTimeException will be thrown.

2. LocalDate plusDays() Method Example

import java.time.LocalDate;
import java.time.Month;

public class LocalDatePlusDaysExample {
    public static void main(String[] args) {
        // Create a LocalDate object representing a specific date
        LocalDate date = LocalDate.of(2023, Month.SEPTEMBER, 20);

        // Print the original LocalDate object
        System.out.println("Original Date: " + date);

        // Add 5 days to the LocalDate object using the plusDays() method
        LocalDate newDate = date.plusDays(5);

        // Print the new LocalDate object
        System.out.println("New Date after adding 5 days: " + newDate);

        // Subtract 10 days from the original LocalDate object
        LocalDate pastDate = date.plusDays(-10);

        // Print the new LocalDate object after subtracting 10 days
        System.out.println("New Date after subtracting 10 days: " + pastDate);
    }
}

Output:

Original Date: 2023-09-20
New Date after adding 5 days: 2023-09-25
New Date after subtracting 10 days: 2023-09-10

Explanation:

In this example, we first create a LocalDate object representing the date 20th September 2023. We then add 5 days to this date using the plusDays() method and print the result, which is 25th September 2023. Additionally, we subtract 10 days from the original date and print the result, which is 10th September 2023.