import {TemporalAdjusters} from '@js-joda/root/packages/core/src/temporal/TemporalAdjusters.js'

public class | source

TemporalAdjusters

Common implementations of TemporalAdjuster.

This class provides common implementations of TemporalAdjuster. They are especially useful to document the intent of business logic and often link well to requirements. For example, these two pieces of code do the same thing, but the second one is clearer (assuming that there is a static import of this class):

 // direct manipulation
 date.withDayOfMonth(1).plusMonths(1).minusDays(1);
 // use of an adjuster from this class
 date.with(lastDayOfMonth());

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

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

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

Specification for implementors

This is a thread-safe utility class. All returned adjusters are immutable and thread-safe.

The JDK 8 ofDateAdjuster(UnaryOperator) method is not backported.

Static Method Summary

Static Public Methods
public static	dayOfWeekInMonth(ordinal: Number, dayOfWeek: DayOfWeek): TemporalAdjuster Returns the day-of-week in month adjuster, which returns a new date in the same month with the ordinal day-of-week.
public static	firstDayOfMonth(): TemporalAdjuster Returns the 'first day of month' adjuster, which returns a new date set to the first day of the current month.
public static	firstDayOfNextMonth(): TemporalAdjuster Returns the 'first day of next month' adjuster, which returns a new date set to the first day of the next month.
public static	firstDayOfNextYear(): TemporalAdjuster Returns the 'first day of next year' adjuster, which returns a new date set to the first day of the next year.
public static	firstDayOfYear(): TemporalAdjuster Returns the 'first day of year' adjuster, which returns a new date set to the first day of the current year.
public static	firstInMonth(dayOfWeek: DayOfWeek): TemporalAdjuster Returns the first in month adjuster, which returns a new date in the same month with the first matching day-of-week.
public static	lastDayOfMonth(): TemporalAdjuster Returns the 'last day of month' adjuster, which returns a new date set to the last day of the current month.
public static	lastDayOfYear(): TemporalAdjuster Returns the 'last day of year' adjuster, which returns a new date set to the last day of the current year.
public static	lastInMonth(dayOfWeek: DayOfWeek): TemporalAdjuster Returns the last in month adjuster, which returns a new date in the same month with the last matching day-of-week.
public static	next(dayOfWeek: DayOfWeek): TemporalAdjuster Returns the next day-of-week adjuster, which adjusts the date to the first occurrence of the specified day-of-week after the date being adjusted.
public static	nextOrSame(dayOfWeek: DayOfWeek): TemporalAdjuster Returns the next-or-same day-of-week adjuster, which adjusts the date to the first occurrence of the specified day-of-week after the date being adjusted unless it is already on that day in which case the same object is returned.
public static	previous(dayOfWeek: DayOfWeek): TemporalAdjuster Returns the previous day-of-week adjuster, which adjusts the date to the first occurrence of the specified day-of-week before the date being adjusted.
public static	previousOrSame(dayOfWeek: DayOfWeek): TemporalAdjuster Returns the previous-or-same day-of-week adjuster, which adjusts the date to the first occurrence of the specified day-of-week before the date being adjusted unless it is already on that day in which case the same object is returned.

Static Public Methods

public static dayOfWeekInMonth(ordinal: Number, dayOfWeek: DayOfWeek): TemporalAdjuster source

Returns the day-of-week in month adjuster, which returns a new date in the same month with the ordinal day-of-week. This is used for expressions like the 'second Tuesday in March'.

The ISO calendar system behaves as follows:

The input 2011-12-15 for (1,TUESDAY) will return 2011-12-06.
The input 2011-12-15 for (2,TUESDAY) will return 2011-12-13.
The input 2011-12-15 for (3,TUESDAY) will return 2011-12-20.
The input 2011-12-15 for (4,TUESDAY) will return 2011-12-27.
The input 2011-12-15 for (5,TUESDAY) will return 2012-01-03.
The input 2011-12-15 for (-1,TUESDAY) will return 2011-12-27 (last in month).
The input 2011-12-15 for (-4,TUESDAY) will return 2011-12-06 (3 weeks before last in month).
The input 2011-12-15 for (-5,TUESDAY) will return 2011-11-29 (4 weeks before last in month).
The input 2011-12-15 for (0,TUESDAY) will return 2011-11-29 (last in previous month).

For a positive or zero ordinal, the algorithm is equivalent to finding the first day-of-week that matches within the month and then adding a number of weeks to it. For a negative ordinal, the algorithm is equivalent to finding the last day-of-week that matches within the month and then subtracting a number of weeks to it. The ordinal number of weeks is not validated and is interpreted leniently according to this algorithm. This definition means that an ordinal of zero finds the last matching day-of-week in the previous month.

The behavior is suitable for use with most calendar systems. It uses the DAY_OF_WEEK and DAY_OF_MONTH fields and the DAYS unit, and assumes a seven day week.

Params:

Name	Type	Attribute	Description
ordinal	Number		the week within the month, unbounded but typically from -5 to 5
dayOfWeek	DayOfWeek		the day-of-week, not null

Return:

TemporalAdjuster

the day-of-week in month adjuster, not null

public static firstDayOfMonth(): TemporalAdjuster source

Returns the 'first day of month' adjuster, which returns a new date set to the first day of the current month.

The ISO calendar system behaves as follows:

The input 2011-01-15 will return 2011-01-01.
The input 2011-02-15 will return 2011-02-01.

The behavior is suitable for use with most calendar systems. It is equivalent to:

 temporal.with(DAY_OF_MONTH, 1);

Return:

TemporalAdjuster

the first day-of-month adjuster, not null

public static firstDayOfNextMonth(): TemporalAdjuster source

Returns the 'first day of next month' adjuster, which returns a new date set to the first day of the next month.

The ISO calendar system behaves as follows:

The input 2011-01-15 will return 2011-02-01.
The input 2011-02-15 will return 2011-03-01.

The behavior is suitable for use with most calendar systems. It is equivalent to:

 temporal.with(DAY_OF_MONTH, 1).plus(1, MONTHS);

Return:

TemporalAdjuster

the first day of next month adjuster, not null

public static firstDayOfNextYear(): TemporalAdjuster source

Returns the 'first day of next year' adjuster, which returns a new date set to the first day of the next year.

The ISO calendar system behaves as follows:

The input 2011-01-15 will return 2012-01-01.

The behavior is suitable for use with most calendar systems. It is equivalent to:

 temporal.with(DAY_OF_YEAR, 1).plus(1, YEARS);

Return:

TemporalAdjuster

the first day of next month adjuster, not null

public static firstDayOfYear(): TemporalAdjuster source

Returns the 'first day of year' adjuster, which returns a new date set to the first day of the current year.

The ISO calendar system behaves as follows:

The input 2011-01-15 will return 2011-01-01.
The input 2011-02-15 will return 2011-01-01.

The behavior is suitable for use with most calendar systems. It is equivalent to:

 temporal.with(DAY_OF_YEAR, 1);

Return:

TemporalAdjuster

the first day-of-year adjuster, not null

public static firstInMonth(dayOfWeek: DayOfWeek): TemporalAdjuster source

Returns the first in month adjuster, which returns a new date in the same month with the first matching day-of-week. This is used for expressions like 'first Tuesday in March'.

The ISO calendar system behaves as follows:

The input 2011-12-15 for (MONDAY) will return 2011-12-05.
The input 2011-12-15 for (FRIDAY) will return 2011-12-02.

The behavior is suitable for use with most calendar systems. It uses the DAY_OF_WEEK and DAY_OF_MONTH fields and the DAYS unit, and assumes a seven day week.

Params:

Name	Type	Attribute	Description
dayOfWeek	DayOfWeek		the day-of-week, not null

Return:

TemporalAdjuster

the first in month adjuster, not null

public static lastDayOfMonth(): TemporalAdjuster source

Returns the 'last day of month' adjuster, which returns a new date set to the last day of the current month.

The ISO calendar system behaves as follows:

The input 2011-01-15 will return 2011-01-31.
The input 2011-02-15 will return 2011-02-28.
The input 2012-02-15 will return 2012-02-29 (leap year).
The input 2011-04-15 will return 2011-04-30.

The behavior is suitable for use with most calendar systems. It is equivalent to:

 long lastDay = temporal.range(DAY_OF_MONTH).getMaximum();
 temporal.with(DAY_OF_MONTH, lastDay);

Return:

TemporalAdjuster

the last day-of-month adjuster, not null

public static lastDayOfYear(): TemporalAdjuster source

Returns the 'last day of year' adjuster, which returns a new date set to the last day of the current year.

The ISO calendar system behaves as follows:

The input 2011-01-15 will return 2011-12-31.
The input 2011-02-15 will return 2011-12-31.

The behavior is suitable for use with most calendar systems. It is equivalent to:

 long lastDay = temporal.range(DAY_OF_YEAR).getMaximum();
 temporal.with(DAY_OF_YEAR, lastDay);

Return:

TemporalAdjuster

the last day-of-year adjuster, not null

public static lastInMonth(dayOfWeek: DayOfWeek): TemporalAdjuster source

Returns the last in month adjuster, which returns a new date in the same month with the last matching day-of-week. This is used for expressions like 'last Tuesday in March'.

The ISO calendar system behaves as follows:

The input 2011-12-15 for (MONDAY) will return 2011-12-26.
The input 2011-12-15 for (FRIDAY) will return 2011-12-30.

The behavior is suitable for use with most calendar systems. It uses the DAY_OF_WEEK and DAY_OF_MONTH fields and the DAYS unit, and assumes a seven day week.

Params:

Name	Type	Attribute	Description
dayOfWeek	DayOfWeek		the day-of-week, not null

Return:

TemporalAdjuster

the first in month adjuster, not null

public static next(dayOfWeek: DayOfWeek): TemporalAdjuster source

Returns the next day-of-week adjuster, which adjusts the date to the first occurrence of the specified day-of-week after the date being adjusted.

The ISO calendar system behaves as follows:

The input 2011-01-15 (a Saturday) for parameter (MONDAY) will return 2011-01-17 (two days later).
The input 2011-01-15 (a Saturday) for parameter (WEDNESDAY) will return 2011-01-19 (four days later).
The input 2011-01-15 (a Saturday) for parameter (SATURDAY) will return 2011-01-22 (seven days later).

The behavior is suitable for use with most calendar systems. It uses the DAY_OF_WEEK field and the DAYS unit, and assumes a seven day week.

Params:

Name	Type	Attribute	Description
dayOfWeek	DayOfWeek		the day-of-week to move the date to, not null

Return:

TemporalAdjuster

the next day-of-week adjuster, not null

public static nextOrSame(dayOfWeek: DayOfWeek): TemporalAdjuster source

Returns the next-or-same day-of-week adjuster, which adjusts the date to the first occurrence of the specified day-of-week after the date being adjusted unless it is already on that day in which case the same object is returned.

The ISO calendar system behaves as follows:

The input 2011-01-15 (a Saturday) for parameter (MONDAY) will return 2011-01-17 (two days later).
The input 2011-01-15 (a Saturday) for parameter (WEDNESDAY) will return 2011-01-19 (four days later).
The input 2011-01-15 (a Saturday) for parameter (SATURDAY) will return 2011-01-15 (same as input).

The behavior is suitable for use with most calendar systems. It uses the DAY_OF_WEEK field and the DAYS unit, and assumes a seven day week.

Params:

Name	Type	Attribute	Description
dayOfWeek	DayOfWeek		the day-of-week to check for or move the date to, not null

Return:

TemporalAdjuster

the next-or-same day-of-week adjuster, not null

public static previous(dayOfWeek: DayOfWeek): TemporalAdjuster source

Returns the previous day-of-week adjuster, which adjusts the date to the first occurrence of the specified day-of-week before the date being adjusted.

The ISO calendar system behaves as follows:

The input 2011-01-15 (a Saturday) for parameter (MONDAY) will return 2011-01-10 (five days earlier).
The input 2011-01-15 (a Saturday) for parameter (WEDNESDAY) will return 2011-01-12 (three days earlier).
The input 2011-01-15 (a Saturday) for parameter (SATURDAY) will return 2011-01-08 (seven days earlier).

The behavior is suitable for use with most calendar systems. It uses the DAY_OF_WEEK field and the DAYS unit, and assumes a seven day week.

Params:

Name	Type	Attribute	Description
dayOfWeek	DayOfWeek		the day-of-week to move the date to, not null

Return:

TemporalAdjuster

the previous day-of-week adjuster, not null

public static previousOrSame(dayOfWeek: DayOfWeek): TemporalAdjuster source

Returns the previous-or-same day-of-week adjuster, which adjusts the date to the first occurrence of the specified day-of-week before the date being adjusted unless it is already on that day in which case the same object is returned.

The ISO calendar system behaves as follows:

The input 2011-01-15 (a Saturday) for parameter (MONDAY) will return 2011-01-10 (five days earlier).
The input 2011-01-15 (a Saturday) for parameter (WEDNESDAY) will return 2011-01-12 (three days earlier).
The input 2011-01-15 (a Saturday) for parameter (SATURDAY) will return 2011-01-15 (same as input).

The behavior is suitable for use with most calendar systems. It uses the DAY_OF_WEEK field and the DAYS unit, and assumes a seven day week.

Params:

Name	Type	Attribute	Description
dayOfWeek	DayOfWeek		the day-of-week to check for or move the date to, not null

Return:

TemporalAdjuster

the previous-or-same day-of-week adjuster, not null