How to get list of months between two dates in Java

Question

I am trying to get a list of months (actually the first days of those months) between two dates in Java but I am not getting the expected results.

The start date is "3/17/2020", the end date "3/17/2021" and the expected result is as follows:

"01-Mar-2020"
"01-Apr-2020"
"01-May-2020"
"01-Jun-2020"
"01-Jul-2020"
"01-Aug-2020"
"01-Sep-2020"
"01-Oct-2020"
"01-Nov-2020"
"01-Dec-2020"
"01-Jan-2021"
"01-Feb-2021"
"01-Mar-2021"

Here below is the code I am using:

import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.Calendar;

public class Main {
   public static void main(String[] args) {
       String date1 = "3/17/2020";
       String date2 = "3/17/2021";

    DateFormat formater = new SimpleDateFormat("MM/dd/yyyy");

    Calendar beginCalendar = Calendar.getInstance();
    Calendar finishCalendar = Calendar.getInstance();

    try {
        beginCalendar.setTime(formater.parse(date1));
        finishCalendar.setTime(formater.parse(date2));
    } catch (ParseException e) {
        e.printStackTrace();
    }
  DateFormat formaterYd = new SimpleDateFormat("01-MMM-YYYY");


    while (beginCalendar.before(finishCalendar)) {
        // add one month to date per loop
        String date =    formaterYd.format(beginCalendar.getTime()).toUpperCase();
        System.out.println(date);
        beginCalendar.add(Calendar.MONTH, 1);
       }
   }
}

With the above code I am getting the following result:

"01-Jan-2020"
"01-Feb-2020"
"01-Mar-2020"
"01-Apr-2020"
"01-May-2020"
"01-Jun-2020"
"01-Jul-2020"
"01-Aug-2020"
"01-Sep-2020"
"01-Oct-2020"
"01-Nov-2020"
"01-Dec-2020"

Please help me understand the issue and suggest any solution for the same with java 7.

Answer 1

I recommend you do it using the modern java.time date-time API and the corresponding formatting API (package, java.time.format). Learn more about the modern date-time API from Trail: Date Time. The java.util date-time API and SimpleDateFormat are outdated and error-prone. In case you are not using Java-8, you can still use Java-8 date-time API through ThreeTenABP library.

If you are doing it in Android and your Android API level is still not compliant with Java8, check Java 8+ APIs available through desugaring.

import java.time.LocalDate;
import java.time.format.DateTimeFormatter;
import java.time.temporal.ChronoUnit;
import java.util.List;
import java.util.stream.Collectors;
import java.util.stream.Stream;

public class Main {
    public static void main(String[] args) {
        // Test
        System.out.println(getDateList("3/17/2020",  "3/17/2021"));
    }

    static List<String> getDateList(String strStartDate, String strEndDate) {
        // Formatter for the input
        DateTimeFormatter inputFormatter = DateTimeFormatter.ofPattern("M/d/u");
        
        // Formatter for the output
        DateTimeFormatter outputFormatter = DateTimeFormatter.ofPattern("dd-MMM-uuuu");

        // Parse strings to LocalDate instances
        LocalDate startDate = LocalDate.parse(strStartDate, inputFormatter);
        LocalDate endDate = LocalDate.parse(strEndDate, inputFormatter);

        return Stream.iterate(startDate.withDayOfMonth(1), date -> date.plusMonths(1))
                .limit(ChronoUnit.MONTHS.between(startDate, endDate.plusMonths(1)))
                .map(date -> date.format(outputFormatter))
                .collect(Collectors.toList());
    }
}

Output:

[01-Mar-2020, 01-Apr-2020, 01-May-2020, 01-Jun-2020, 01-Jul-2020, 01-Aug-2020, 01-Sep-2020, 01-Oct-2020, 01-Nov-2020, 01-Dec-2020, 01-Jan-2021, 01-Feb-2021, 01-Mar-2021]

Using legacy API:

import java.text.DateFormat;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Calendar;
import java.util.Date;
import java.util.List;

public class Main {
    public static void main(String[] args) throws ParseException {
        // Test
        System.out.println(getDateList("3/17/2020", "3/17/2021"));
    }

    static List<String> getDateList(String strStartDate, String strEndDate) throws ParseException {
        // List to be populated and returned
        List<String> dateList = new ArrayList<>();

        // Formatter for the input
        DateFormat inputFormatter = new SimpleDateFormat("M/d/yyyy");

        // Formatter for the output
        DateFormat outputFormatter = new SimpleDateFormat("dd-MMM-yyyy");

        // Parse strings to LocalDate instances
        Date startDate = inputFormatter.parse(strStartDate);
        Date endDate = inputFormatter.parse(strEndDate);

        // Calendar to start with
        Calendar startWith = Calendar.getInstance();
        startWith.setTime(startDate);
        startWith.set(Calendar.DAY_OF_MONTH, 1);

        for (Calendar calendar = startWith; calendar.getTime().getTime() <= endDate.getTime(); calendar
                .add(Calendar.MONTH, 1)) {
            dateList.add(outputFormatter.format(calendar.getTime()));
        }

        return dateList;
    }
}

Output:

[01-Mar-2020, 01-Apr-2020, 01-May-2020, 01-Jun-2020, 01-Jul-2020, 01-Aug-2020, 01-Sep-2020, 01-Oct-2020, 01-Nov-2020, 01-Dec-2020, 01-Jan-2021, 01-Feb-2021, 01-Mar-2021]

Answer 2

Using java.time.LocalDate:

public static List<LocalDate> diff(LocalDate start, LocalDate end) {
    return start
            .datesUntil(end)
            .filter(e -> e.getDayOfMonth() == 1)
            .collect(Collectors.toList());
}

diff(LocalDate.now(), LocalDate.of(2020, 12, 20))

Output:

[2020-10-01, 2020-11-01, 2020-12-01]

You can use DateTimeFormatter string date to LocalDate and vice-versa.

EDIT
Using java 7 only (modified given code in question):

public static void main(String[] args) throws IOException {


    String date1 = "3/17/2020";
    String date2 = "3/17/2021";

    DateFormat formater = new SimpleDateFormat("MM/dd/yyyy");

    Calendar beginCalendar = Calendar.getInstance();
    Calendar finishCalendar = Calendar.getInstance();

    try {
        beginCalendar.setTime(formater.parse(date1));
        finishCalendar.setTime(formater.parse(date2));
    } catch (ParseException e) {
        e.printStackTrace();
    }
    DateFormat formaterYd = new SimpleDateFormat("dd-MMM-YYYY");
    

    // mind this condition in while
    while (beginCalendar.compareTo(finishCalendar) <= 0) {
        Calendar tmp = (Calendar)beginCalendar.clone();
        tmp.set(Calendar.DAY_OF_MONTH, 1);
        String date = formaterYd.format(tmp.getTime()).toUpperCase();
        System.out.println(date);
        beginCalendar.add(Calendar.MONTH, 1);
    }
}

Answer 3

Java7 soulution:

public static void main(String[] args) throws ParseException {
    DateFormat df1 = new SimpleDateFormat("MM/dd/yyyy", Locale.US);
    Date dateFrom = df1.parse("3/17/2020");
    Date dateTo = df1.parse("3/17/2021");
    final Locale locale = Locale.US;

    DateFormat df2 = new SimpleDateFormat("MMM-yyyy", Locale.US);
    List<String> months = getListMonths(dateFrom, dateTo, locale, df2);

    for (String month : months)
        System.out.println(month.toUpperCase(locale));
}

public static List<String> getListMonths(Date dateFrom, Date dateTo, Locale locale, DateFormat df) {
    Calendar calendar = Calendar.getInstance(locale);
    calendar.setTime(dateFrom);

    List<String> months = new ArrayList<>();

    while (calendar.getTime().getTime() <= dateTo.getTime()) {
        months.add(df.format(calendar.getTime()));
        calendar.add(Calendar.MONTH, 1);
    }

    return months;
}

Output:

MAR-2020
APR-2020
MAY-2020
JUN-2020
JUL-2020
AUG-2020
SEP-2020
OCT-2020
NOV-2020
DEC-2020
JAN-2021
FEB-2021
MAR-2021