Period toTotalMonths() method in Java with Examples

The toTotalMonths() method of Period Class is used to obtain the total number of Months in the given period. It returns a long value depicting the same.

Syntax:

public long toTotalMonths()

Parameters: This method does not accepts any parameter.

Returns: This function returns the long value which is the total number of Months in the this Period.

Below is the implementation of Period.toTotalMonths() method:

Example 1:

// Java code to demonstrate toTotalMonths() method

import java.time.Period;

class GFG {
    public static void main(String[] args)
    {

        // Get the String to be toTotalMonthsd
        String period = "P1Y2M21D";

        // Parse the String into Period
        Period p = Period.parse(period);

        System.out.println("Period: " + p);

        // Get the total number of months
        // using toTotalMonths() method
        System.out.println("Total number of Months"
                           + " in this Period: "
                           + p.toTotalMonths());
    }
}

Output:

Period: P1Y2M21D
Total number of Months in this Period: 14

Example 2:

// Java code to demonstrate toTotalMonths() method

import java.time.Period;

class GFG {
    public static void main(String[] args)
    {

        // Get the String to be toTotalMonthsd
        String period = "-P1Y2M21D";

        // Parse the String into Period
        Period p = Period.parse(period);

        System.out.println("Period: " + p);

        // Get the total number of months
        // using toTotalMonths() method
        System.out.println("Total number of Months"
                           + " in this Period: "
                           + p.toTotalMonths());
    }
}

Output:

Period: P-1Y-2M-21D
Total number of Months in this Period: -14

Reference: https://docs.oracle.com/javase/9/docs/api/java/time/Period.html#toTotalMonths–