YearMonth.Until(ITemporal, ITemporalUnit) Method

Definition

Namespace:: Java.Time

Assembly:: Mono.Android.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Calculates the amount of time until another year-month in terms of the specified unit.

[Android.Runtime.Register("until", "(Ljava/time/temporal/Temporal;Ljava/time/temporal/TemporalUnit;)J", "", ApiSince=26)]
public long Until(Java.Time.Temporal.ITemporal? endExclusive, Java.Time.Temporal.ITemporalUnit? unit);

[<Android.Runtime.Register("until", "(Ljava/time/temporal/Temporal;Ljava/time/temporal/TemporalUnit;)J", "", ApiSince=26)>]
abstract member Until : Java.Time.Temporal.ITemporal * Java.Time.Temporal.ITemporalUnit -> int64
override this.Until : Java.Time.Temporal.ITemporal * Java.Time.Temporal.ITemporalUnit -> int64

Parameters

endExclusive: ITemporal

the end date, exclusive, which is converted to a YearMonth, not null

unit: ITemporalUnit

the unit to measure the amount in, not null

Returns

Int64

the amount of time between this year-month and the end year-month

Implements

Until(ITemporal, ITemporalUnit)

Attributes: RegisterAttribute

Remarks

Calculates the amount of time until another year-month in terms of the specified unit. This calculates the amount of time between two YearMonth objects in terms of a single TemporalUnit. The start and end points are this and the specified year-month. The result will be negative if the end is before the start. The Temporal passed to this method is converted to a YearMonth using from(TemporalAccessor). For example, the amount in years between two year-months can be calculated using startYearMonth.until(endYearMonth, YEARS). The calculation returns a whole number, representing the number of complete units between the two year-months. For example, the amount in decades between 2012-06 and 2032-05 will only be one decade as it is one month short of two decades. There are two equivalent ways of using this method. The first is to invoke this method. The second is to use TemporalUnit.between(Temporal, Temporal): The choice should be made based on which makes the code more readable. The calculation is implemented in this method for ChronoUnit. The units MONTHS, YEARS, DECADES, CENTURIES, MILLENNIA and ERAS are supported. Other ChronoUnit values will throw an exception. If the unit is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.between(Temporal, Temporal) passing this as the first argument and the converted input temporal as the second argument. This instance is immutable and unaffected by this method call.

Java reference for java.time.YearMonth.until.

Applies to