Period.AddTo(ITemporal) Method
Definition
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.
Adds this period to the specified temporal object.
[Android.Runtime.Register("addTo", "(Ljava/time/temporal/Temporal;)Ljava/time/temporal/Temporal;", "", ApiSince=26)]
public Java.Time.Temporal.ITemporal? AddTo(Java.Time.Temporal.ITemporal? temporal);[<Android.Runtime.Register("addTo", "(Ljava/time/temporal/Temporal;)Ljava/time/temporal/Temporal;", "", ApiSince=26)>]
abstract member AddTo : Java.Time.Temporal.ITemporal -> Java.Time.Temporal.ITemporal
override this.AddTo : Java.Time.Temporal.ITemporal -> Java.Time.Temporal.ITemporalParameters
- temporal
- ITemporal
the temporal object to adjust, not null
Returns
an object of the same type with the adjustment made, not null
Implements
- Attributes
Remarks
Adds this period to the specified temporal object. This returns a temporal object of the same observable type as the input with this period added. If the temporal has a chronology, it must be the ISO chronology. In most cases, it is clearer to reverse the calling pattern by using Temporal.plus(TemporalAmount).
// these two lines are equivalent, but the second approach is recommended
dateTime = thisPeriod.addTo(dateTime);
dateTime = dateTime.plus(thisPeriod);
The calculation operates as follows. First, the chronology of the temporal is checked to ensure it is ISO chronology or null. Second, if the months are zero, the years are added if non-zero, otherwise the combination of years and months is added if non-zero. Finally, any days are added. This approach ensures that a partial period can be added to a partial date. For example, a period of years and/or months can be added to a YearMonth, but a period including days cannot. The approach also adds years and months together when necessary, which ensures correct behaviour at the end of the month. This instance is immutable and unaffected by this method call.
Java reference for java.time.Period.addTo.