Home » Java » Java Reference » Java Duration Class

Java Duration Class | compareTo() Method with Example

Duration Class compareTo() method: Here, we are going to learn about the compareTo() method of Duration Class with its syntax and example.
Submitted by Preeti Jain, on May 14, 2020

Duration Class compareTo() method

• compareTo() method is available in java.time package.
• compareTo() method is used to compare this Duration object to the given object.
• compareTo() method is a non-static method, it is accessible with class object only and if we try to access the method with class name then we will get an error.
• compareTo() method does not throw an exception at the time of comparing.

Syntax:

    public int compareTo(Duration d);

Parameter(s):

• Duration d – represents the object to be compared to this Duration object.

Return value:

The return type of this method is int, it may return anyone of the given values.

• When (this Duration) == (Duration d), it returns 0.
• When (this Duration) < (Duration d), it returns -1.
• When (this Duration) > (Duration d), it returns 1.

Example:

// Java program to demonstrate the example 
// of int compareTo() method of Duration

import java.time.*;
import java.time.temporal.*;

public class CompareToOfDuration {
    public static void main(String args[]) {
        // Instantiates three Duration objects
        Duration du1 = Duration.ofHours(2);
        Duration du2 = Duration.ofMinutes(2);
        Duration du3 = Duration.between(LocalTime.MIN, LocalTime.MAX);

        System.out.println("du1: " + du1);
        System.out.println("du2: " + du2);
        System.out.println("du3: " + du3);

        System.out.println();

        // compares this Duration object(du1)
        // to the given Duration object(du2) i.e here
        // it returns 1 because the value of du1>du2
        int compare = du1.compareTo(du2);
        System.out.println("du1.compareTo(du2): " + compare);

        // compares this Duration object(du2)
        // to the given Duration object(du1) i.e here
        // it returns -1 because the value of du2<du1
        compare = du2.compareTo(du1);
        System.out.println("du2.compareTo(du1): " + compare);

        // compares this Duration object(du3)
        // to the given Duration object(du3) i.e here
        // it returns 0 because the value of du2==du1
        compare = du3.compareTo(du3);
        System.out.println("du3.compareTo(du3): " + compare);
    }
}

Output

du1: PT2H
du2: PT2M
du3: PT23H59M59.999999999S

du1.compareTo(du2): 1
du2.compareTo(du1): -1
du3.compareTo(du3): 0