Java Period getDays()

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

1. Period getDays() Method Overview

Definition:

The Period.getDays() method in Java is a part of the java.time.Period class and it returns the number of days of this period. Period is used to define an amount of time in terms of years, months, and days.

Syntax:

public int getDays()

Parameters:

- The method does not take any parameters.

Key Points:

- The getDays() method returns the day part of the Period, which may be negative.

- The Period class is part of the java.time package, which was introduced in Java 8 to handle date and time.

- A Period is immutable and thread-safe, providing various utility methods for manipulating time.

2. Period getDays() Method Example

import java.time.Period;

public class PeriodGetDaysExample {
    public static void main(String[] args) {
        // Create a Period of 2 years, 3 months, and 4 days
        Period period = Period.of(2, 3, 4);

        // Get the day part of the period
        int days = period.getDays();

        // Print the number of days
        System.out.println("Number of days in the period: " + days);

        // Create a Period with a negative number of days
        Period negativePeriod = Period.of(0, 0, -5);

        // Get the day part of the negative period
        int negativeDays = negativePeriod.getDays();

        // Print the number of days in the negative period
        System.out.println("Number of days in the negative period: " + negativeDays);
    }
}

Output:

Number of days in the period: 4
Number of days in the negative period: -5

Explanation:

In this example, we have created two Period objects, one with positive days and the other with negative days. 

The getDays() method is used to retrieve the day part of these periods. The first Period object, period, is constructed with 2 years, 3 months, and 4 days, so the getDays() method returns 4. The second Period object, negativePeriod, is constructed with -5 days, and hence getDays() returns -5.