What is DateUtils.addMonths() in Java?

Overview

addMonths() is a staticthe methods in Java that can be called without creating an object of the class. method of the DateUtils utility which is used to add a given number of months to the Date object, returning a new Date object.

The original date object remains unchanged.

How to import DateUtils

The definition of DateUtils can be found in the Apache Commons Lang package, which we can add to the Maven project by adding the following dependency to the pom.xml file:

<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-lang3</artifactId>
    <version>3.12.0</version>
</dependency>

For other versions of the commons-lang package, refer to the Maven Repository.

You can import the DateUtils class as follows:

import org.apache.commons.lang3.time.DateUtils;

Syntax

public static Date addMonths(final Date date, final int amount)

Parameters

  • final Date date: The date to add to.
  • final int amount: The number of months to add. Can be positive or negative.

Return value

This method returns a new Date with the number of months added.

Code

In the below code, we add the number of months in the monthsToAdd variable to the currDate object with the help of the addMonths() method and print the new object to the console.

import org.apache.commons.lang3.time.DateUtils;
import java.util.Date;
public class Main{
    public static void main(String[] args) {
        Date currDate = new Date();
        int monthsToAdd = 2;
        Date newDate = DateUtils.addMonths(currDate, monthsToAdd);
        System.out.printf("%s + %s months = %s", currDate, monthsToAdd, newDate);
    }
}

Output

The output of the code will be as follows:

Sun Nov 21 03:29:58 IST 2021 + 2 months = Fri Jan 21 03:29:58 IST 2022

Free Resources

Attributions:
  1. undefined by undefined
License: Creative Commons-Attribution-ShareAlike 4.0 (CC-BY-SA 4.0)