ITemporal.With Method

Definition

Namespace:

Java.Time.Temporal

Assembly:

Mono.Android.dll

Overloads

With(ITemporalAdjuster)	Returns an adjusted object of the same type as this object with the adjustment made.
With(ITemporalField, Int64)	Returns an object of the same type as this object with the specified field altered.

With(ITemporalAdjuster)

Returns an adjusted object of the same type as this object with the adjustment made.

[Android.Runtime.Register("with", "(Ljava/time/temporal/TemporalAdjuster;)Ljava/time/temporal/Temporal;", "GetWith_Ljava_time_temporal_TemporalAdjuster_Handler:Java.Time.Temporal.ITemporal, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=26)]
public virtual Java.Time.Temporal.ITemporal? With (Java.Time.Temporal.ITemporalAdjuster? adjuster);

[<Android.Runtime.Register("with", "(Ljava/time/temporal/TemporalAdjuster;)Ljava/time/temporal/Temporal;", "GetWith_Ljava_time_temporal_TemporalAdjuster_Handler:Java.Time.Temporal.ITemporal, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=26)>]
abstract member With : Java.Time.Temporal.ITemporalAdjuster -> Java.Time.Temporal.ITemporal
override this.With : Java.Time.Temporal.ITemporalAdjuster -> Java.Time.Temporal.ITemporal

Parameters

adjuster

ITemporalAdjuster

the adjuster to use, not null

Returns

ITemporal

an object of the same type with the specified adjustment made, not null

Attributes

RegisterAttribute

Remarks

Returns an adjusted object of the same type as this object with the adjustment made.

This adjusts this date-time according to the rules of the specified adjuster. A simple adjuster might simply set the one of the fields, such as the year field. A more complex adjuster might set the date to the last day of the month. A selection of common adjustments is provided in java.time.temporal.TemporalAdjusters TemporalAdjusters. These include finding the "last day of the month" and "next Wednesday". The adjuster is responsible for handling special cases, such as the varying lengths of month and leap years.

Some example code indicating how and why this method is used:

date = date.with(Month.JULY);        // most key classes implement TemporalAdjuster
             date = date.with(lastDayOfMonth());  // static import from Adjusters
             date = date.with(next(WEDNESDAY));   // static import from Adjusters and DayOfWeek

Java documentation for java.time.temporal.Temporal.with(java.time.temporal.TemporalAdjuster).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.

With(ITemporalField, Int64)

Returns an object of the same type as this object with the specified field altered.

[Android.Runtime.Register("with", "(Ljava/time/temporal/TemporalField;J)Ljava/time/temporal/Temporal;", "GetWith_Ljava_time_temporal_TemporalField_JHandler:Java.Time.Temporal.ITemporalInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=26)]
public Java.Time.Temporal.ITemporal? With (Java.Time.Temporal.ITemporalField? field, long newValue);

[<Android.Runtime.Register("with", "(Ljava/time/temporal/TemporalField;J)Ljava/time/temporal/Temporal;", "GetWith_Ljava_time_temporal_TemporalField_JHandler:Java.Time.Temporal.ITemporalInvoker, Mono.Android, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null", ApiSince=26)>]
abstract member With : Java.Time.Temporal.ITemporalField * int64 -> Java.Time.Temporal.ITemporal

Parameters

field

ITemporalField

the field to set in the result, not null

newValue

Int64

the new value of the field in the result

Returns

ITemporal

an object of the same type with the specified field set, not null

Attributes

RegisterAttribute

Remarks

Returns an object of the same type as this object with the specified field altered.

This returns a new object based on this one with the value for the specified field changed. For example, on a LocalDate, this could be used to set the year, month or day-of-month. The returned object will have the same observable type as this object.

In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st January, then changing the month to February would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.

Java documentation for java.time.temporal.Temporal.with(java.time.temporal.TemporalField, long).

Portions of this page are modifications based on work created and shared by the Android Open Source Project and used according to terms described in the Creative Commons 2.5 Attribution License.