java.time.Period Class in Java

The Period Class in Java class obtains a quantity or amount of time in terms of years, months and days. The time obtained is a date-based amount of time in the ISO-8601 calendar system, such as '4 years, 5 months, and 6 days. The units which are supported for a period are YEARS, MONTHS, and days. All these three fields are always present but may be set to zero.

Syntax: Class declaration

public final class Period 
extends Object 
implements ChronoPeriod, Serializable

Below all the methods with the action performed by them are as follows in the tabular format are as follows:

Let us implement a few of the methods of this class.

Implementation:

Example 1

// Java program to illustrate Period class
// demonstrate the methods of this class
// Methods - minus() and ofMonths()

// Importing Period class from
// java.time package
import java.time.Period;

// Main class
public class GFG {
    // Main driver method
    public static void main(String[] args)
    {
        // Obtaining period representing number of months
        // using of months() method by
        // creating object of period class
        Period p1 = Period.ofMonths(6);

        // minus() will return a copy of this period
        // with the specified period subtracted.
        Period p2 = p1.minus(Period.ofMonths(2));

        // Print and display on the console
        System.out.println(p2);
    }
}

P4M

Let us take another example in order to discuss more methods namely as follows:

Method 1: ofDays() method of this class is used to obtain a period from the given number of Days as a parameter. 

Syntax:

public static Period ofDays(int numberOfDays)

Parameters: This method accepts a single parameter number of days which is the number of Days to be parsed into a Period object.

Returns: This function returns the period which is the Period object parsed with the given number of Days.

Method 2: addTo() method of this class adds this Period to the specific temporal object.

Syntax:

public Temporal addTo(Temporal temporal)

Parameters: The temporal object to adjust should not be null.

Return Type: An object of the same type with the adjustment made.

Exceptions: DateTime and Arithmetic exceptions are thrown by this method.

Example 2

// Java program to illustrate Period class
// demonstrate the methods of this class
// Methods like ofDays() and addTo()

// Importing all classes from java.time package
import java.time.*;
import java.time.temporal.Temporal;

// Main class
public class GFG {

    // Main driver method
    public static void main(String[] args)
    {
        // Getting a period representing number of days
        // using ofDays() method
        Period p = Period.ofDays(24);

        // Adding this period to the
        // temporal object i.e. temp
        Temporal temp = p.addTo(LocalDate.now());

        // Print and display on the console
        System.out.println(temp);
    }
}

2021-03-29