YearMonth until() Method in Java with Examples
Last Updated :
22 Jan, 2019
until() method of the YearMonth class used to calculate the amount of time between two YearMonth objects using TemporalUnit. The start and end points are this and the specified YearMonth passed as a parameter. The result will be negative if the end is before the start. The calculation returns a whole number, representing the number of complete units between the two YearMonth. This instance is immutable and unaffected by this method call.
Syntax:
public long until(Temporal endExclusive, TemporalUnit unit)
Parameters: This method accepts two parameters endExclusive which is the end date, exclusive, which is converted to a YearMonth and unit which is the unit to measure the amount.
Return value: This method returns the amount of time between this YearMonth and the end YearMonth.
Exception:This method throws following Exceptions:
- DateTimeException – if the amount cannot be calculated, or the ending temporal cannot be converted to a YearMonth.
- UnsupportedTemporalTypeException – if the unit is not supported.
- ArithmeticException – if numeric overflow occurs.
Below programs illustrate the until() method:
Program 1:
import java.time.*;
import java.time.temporal.*;
public class GFG {
public static void main(String[] args)
{
YearMonth y1 = YearMonth.of( 2018 , 12 );
YearMonth y2 = YearMonth.of( 2015 , 10 );
long result
= y2.until(y1,
ChronoUnit.YEARS);
System.out.println( "Result in YEARS: "
+ result);
}
}
|
Output:
Result in YEARS: 3
Program 2:
import java.time.*;
import java.time.temporal.*;
public class GFG {
public static void main(String[] args)
{
YearMonth y1 = YearMonth.of( 2018 , 12 );
YearMonth y2 = YearMonth.of( 2015 , 10 );
long result
= y1.until(y2,
ChronoUnit.MONTHS);
System.out.println( "Result in MONTHS: "
+ result);
}
}
|
Output:
Result in MONTHS: -38
References:
https://docs.oracle.com/javase/10/docs/api/java/time/YearMonth.html#until(java.time.temporal.Temporal, java.time.temporal.TemporalUnit)
Like Article
Suggest improvement
Share your thoughts in the comments
Please Login to comment...