java.time.temporal

Interface TemporalAdjuster

All Known Subinterfaces:

Era

All Known Implementing Classes:

ChronoLocalDate, ChronoLocalDateTime, DayOfWeek, DefaultInterfaceEra, HijrahDate, HijrahEra, Instant, IsoEra, JapaneseDate, JapaneseEra, LocalDate, LocalDateTime, LocalTime, MinguoDate, MinguoEra, Month, MonthDay, OffsetDateTime, OffsetTime, ThaiBuddhistDate, ThaiBuddhistEra, Year, YearMonth, ZoneOffset

public interface TemporalAdjuster

Strategy for adjusting a temporal object.

Adjusters are a key tool for modifying temporal objects. They exist to externalize the process of adjustment, permitting different approaches, as per the strategy design pattern. Examples might be an adjuster that sets the date avoiding weekends, or one that sets the date to the last day of the month.

There are two equivalent ways of using a TemporalAdjuster. The first is to invoke the method on this interface directly. The second is to use Temporal.with(TemporalAdjuster):

   // these two lines are equivalent, but the second approach is recommended
   temporal = thisAdjuster.adjustInto(temporal);
   temporal = temporal.with(thisAdjuster);
 

It is recommended to use the second approach, with(TemporalAdjuster), as it is a lot clearer to read in code.

See TemporalAdjusters for a standard set of adjusters, including finding the last day of the month. Adjusters may also be defined by applications.

Specification for implementors

This interface places no restrictions on the mutability of implementations, however immutability is strongly recommended.

Method Summary

Methods

Modifier and Type	Method and Description
Temporal	adjustInto(Temporal temporal) Adjusts the specified temporal object.

Method Detail

adjustInto

Temporal adjustInto(Temporal temporal)

Adjusts the specified temporal object.

This adjusts the specified temporal object using the logic encapsulated in the implementing class. Examples might be an adjuster that sets the date avoiding weekends, or one that sets the date to the last day of the month.

There are two equivalent ways of using this method. The first is to invoke this method directly. The second is to use Temporal.with(TemporalAdjuster):

   // these two lines are equivalent, but the second approach is recommended
   temporal = thisAdjuster.adjustInto(temporal);
   temporal = temporal.with(thisAdjuster);
 

It is recommended to use the second approach, with(TemporalAdjuster), as it is a lot clearer to read in code.

Specification for implementors

The implementation must take the input object and adjust it. The implementation defines the logic of the adjustment and is responsible for documenting that logic. It may use any method on Temporal to query the temporal object and perform the adjustment. The returned object must have the same observable type as the input object

The input object must not be altered. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable temporal objects.

The input temporal object may be in a calendar system other than ISO. Implementations may choose to document compatibility with other calendar systems, or reject non-ISO temporal objects by querying the chronology.

This method may be called from multiple threads in parallel. It must be thread-safe when invoked.

Parameters:

temporal - the temporal object to adjust, not null

Returns:

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

Throws:

DateTimeException - if unable to make the adjustment

java.lang.ArithmeticException - if numeric overflow occurs