TemporalAdjuster

public interface TemporalAdjuster

java.time.temporal.TemporalAdjuster

Known indirect subclasses

ChronoLocalDate, ChronoLocalDateTime<D extends ChronoLocalDate>, DayOfWeek, Era, HijrahDate, HijrahEra, Instant, IsoEra, JapaneseDate, JapaneseEra, LocalDate, LocalDateTime, LocalTime, MinguoDate, MinguoEra, and 9 others.

ChronoLocalDate	A date without time-of-day or time-zone in an arbitrary chronology, intended for advanced globalization use cases.
ChronoLocalDateTime<D extends ChronoLocalDate>	A date-time without a time-zone in an arbitrary chronology, intended for advanced globalization use cases.
DayOfWeek	A day-of-week, such as 'Tuesday'.
Era	An era of the time-line.
HijrahDate	A date in the Hijrah calendar system.
HijrahEra	An era in the Hijrah calendar system.
Instant	An instantaneous point on the time-line.
IsoEra	An era in the ISO calendar system.
JapaneseDate	A date in the Japanese Imperial calendar system.
JapaneseEra	An era in the Japanese Imperial calendar system.
LocalDate	A date without a time-zone in the ISO-8601 calendar system, such as `2007-12-03`.
LocalDateTime	A date-time without a time-zone in the ISO-8601 calendar system, such as `2007-12-03T10:15:30`.
LocalTime	A time without a time-zone in the ISO-8601 calendar system, such as `10:15:30`.
MinguoDate	A date in the Minguo calendar system.
MinguoEra	An era in the Minguo calendar system.
Month	A month-of-year, such as 'July'.
MonthDay	A month-day in the ISO-8601 calendar system, such as `--12-03`.
OffsetDateTime	A date-time with an offset from UTC/Greenwich in the ISO-8601 calendar system, such as `2007-12-03T10:15:30+01:00`.
OffsetTime	A time with an offset from UTC/Greenwich in the ISO-8601 calendar system, such as `10:15:30+01:00`.
ThaiBuddhistDate	A date in the Thai Buddhist calendar system.
ThaiBuddhistEra	An era in the Thai Buddhist calendar system.
Year	A year in the ISO-8601 calendar system, such as `2007`.
YearMonth	A year-month in the ISO-8601 calendar system, such as `2007-12`.
ZoneOffset	A time-zone offset from Greenwich/UTC, such as `+02:00`.

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.

The TemporalAdjusters class contains a standard set of adjusters, available as static methods. These include:

finding the first or last day of the month
finding the first day of next month
finding the first or last day of the year
finding the first day of next year
finding the first or last day-of-week within a month, such as "first Wednesday in June"
finding the next or previous day-of-week, such as "next Thursday"

See also:

TemporalAdjusters

Summary

Public methods
`abstract Temporal`	`adjustInto(Temporal temporal)` Adjusts the specified temporal object.

Public methods

adjustInto

Added in API level 26

public abstract 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.

Implementation Requirements:

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`	`Temporal`: the temporal object to adjust, not null

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

Throws
`DateTimeException`	if unable to make the adjustment
`ArithmeticException`	if numeric overflow occurs