YearMonth plusMonths() method in Java with Examples

The plusMonths() method of YearMonth class in Java is used to get a copy of this YearMonth with the specified number of months added.

Syntax:

public YearMonth plusMonths(long monthsToAdd)

Parameter: This method accepts monthsToAdd as parameters which represents the months to add to current YearMonth object. It may be negative.

Return Value: It returns a YearMonth based on this year-month with the months added.

Exceptions: This method throws DateTimeException if the result exceeds the supported range.

Below programs illustrate the plusMonths() method of YearMonth in Java:

Program 1:

// Java program to demonstrate
// YearMonth.plusMonths() method

import java.time.*;
import java.time.temporal.*;

public class GFG {
    public static void main(String[] args)
    {
        // create YearMonth object
        YearMonth yearmonth
            = YearMonth.parse("2020-05");

        // apply plusMonths() method
        // of YearMonth class
        // Adding 5 months into May 2020
        // will turn it into October 2020
        YearMonth result = yearmonth.plusMonths(5);

        // print results
        System.out.println("Modified YearMonth: "
                           + result);
    }
}

Output:

Modified YearMonth: 2020-10

Program 2:

// Java program to demonstrate
// YearMonth.plusMonths() method

import java.time.*;
import java.time.temporal.*;

public class GFG {
    public static void main(String[] args)
    {
        // create YearMonth object
        YearMonth yearmonth
            = YearMonth.parse("2019-05");

        // apply plusMonths() method
        // of YearMonth class
        // Adding 10 months into it will turn
        // it to 3rd month of next year
        YearMonth result
            = yearmonth.plusMonths(10);

        // print results
        System.out.println("Modified YearMonth: "
                           + result);
    }
}

Output:

Modified YearMonth: 2020-03

References: https://docs.oracle.com/javase/10/docs/api/java/time/YearMonth.html#plusMonths(long)