APIdia Launch Partner
Top Description Constructors Methods
java.time.temporal

public final Class TemporalAdjusters

extends Object
Class Inheritance
Static Imports
java.time.temporal.ChronoField.DAY_OF_MONTH, .ChronoField.DAY_OF_WEEK, .ChronoField.DAY_OF_YEAR, .ChronoUnit.DAYS, .ChronoUnit.MONTHS, .ChronoUnit.YEARS
Common and useful TemporalAdjusters.

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 the 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.

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

Implementation Specification

All the implementations supplied by the static methods are immutable.

Since
1.8
See Also
TemporalAdjuster

Constructor Summary

AccessConstructor and Description
private
TemporalAdjusters()

Private constructor since this is a utility class.

Method Summary

Modifier and TypeMethod and Description
public static TemporalAdjuster

Returns:

the day-of-week in month adjuster, not null
dayOfWeekInMonth(int
the week within the month, unbounded but typically from -5 to 5
ordinal, DayOfWeek
the day-of-week, not null
dayOfWeek)

Returns the day-of-week in month adjuster, which returns a new date with the ordinal day-of-week based on the month.

public static TemporalAdjuster

Returns:

the first day-of-month adjuster, not null
firstDayOfMonth()

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

public static TemporalAdjuster

Returns:

the first day of next month adjuster, not null
firstDayOfNextMonth()

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

public static TemporalAdjuster

Returns:

the first day of next month adjuster, not null
firstDayOfNextYear()

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

public static TemporalAdjuster

Returns:

the first day-of-year adjuster, not null
firstDayOfYear()

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

public static TemporalAdjuster

Returns:

the first in month adjuster, not null
firstInMonth(DayOfWeek
the day-of-week, not null
dayOfWeek)

Returns the first in month adjuster, which returns a new date in the same month with the first matching day-of-week.

public static TemporalAdjuster

Returns:

the last day-of-month adjuster, not null
lastDayOfMonth()

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

public static TemporalAdjuster

Returns:

the last day-of-year adjuster, not null
lastDayOfYear()

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

public static TemporalAdjuster

Returns:

the first in month adjuster, not null
lastInMonth(DayOfWeek
the day-of-week, not null
dayOfWeek)

Returns the last in month adjuster, which returns a new date in the same month with the last matching day-of-week.

public static TemporalAdjuster

Returns:

the next day-of-week adjuster, not null
next(DayOfWeek
the day-of-week to move the date to, not null
dayOfWeek)

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 TemporalAdjuster

Returns:

the next-or-same day-of-week adjuster, not null
nextOrSame(DayOfWeek
the day-of-week to check for or move the date to, not null
dayOfWeek)

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 TemporalAdjuster

Returns:

the temporal adjuster wrapping on the date adjuster, not null
ofDateAdjuster(UnaryOperator<LocalDate>
the date-based adjuster, not null
dateBasedAdjuster)

Obtains a TemporalAdjuster that wraps a date adjuster.

public static TemporalAdjuster

Returns:

the previous day-of-week adjuster, not null
previous(DayOfWeek
the day-of-week to move the date to, not null
dayOfWeek)

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 TemporalAdjuster

Returns:

the previous-or-same day-of-week adjuster, not null
previousOrSame(DayOfWeek
the day-of-week to check for or move the date to, not null
dayOfWeek)

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.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Constructor Detail

TemporalAdjustersback to summary
private TemporalAdjusters()

Private constructor since this is a utility class.

Method Detail

dayOfWeekInMonthback to summary
public static TemporalAdjuster dayOfWeekInMonth(int ordinal, DayOfWeek dayOfWeek)

Returns the day-of-week in month adjuster, which returns a new date with the ordinal day-of-week based on the month. 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.

Parameters
ordinal:int

the week within the month, unbounded but typically from -5 to 5

dayOfWeek:DayOfWeek

the day-of-week, not null

Returns:TemporalAdjuster

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

firstDayOfMonthback to summary
public static TemporalAdjuster firstDayOfMonth()

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);
Returns:TemporalAdjuster

the first day-of-month adjuster, not null

firstDayOfNextMonthback to summary
public static TemporalAdjuster firstDayOfNextMonth()

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);
Returns:TemporalAdjuster

the first day of next month adjuster, not null

firstDayOfNextYearback to summary
public static TemporalAdjuster firstDayOfNextYear()

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);
Returns:TemporalAdjuster

the first day of next month adjuster, not null

firstDayOfYearback to summary
public static TemporalAdjuster firstDayOfYear()

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);
Returns:TemporalAdjuster

the first day-of-year adjuster, not null

firstInMonthback to summary
public static TemporalAdjuster firstInMonth(DayOfWeek dayOfWeek)

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.

Parameters
dayOfWeek:DayOfWeek

the day-of-week, not null

Returns:TemporalAdjuster

the first in month adjuster, not null

lastDayOfMonthback to summary
public static TemporalAdjuster lastDayOfMonth()

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);
Returns:TemporalAdjuster

the last day-of-month adjuster, not null

lastDayOfYearback to summary
public static TemporalAdjuster lastDayOfYear()

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);
Returns:TemporalAdjuster

the last day-of-year adjuster, not null

lastInMonthback to summary
public static TemporalAdjuster lastInMonth(DayOfWeek dayOfWeek)

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.

Parameters
dayOfWeek:DayOfWeek

the day-of-week, not null

Returns:TemporalAdjuster

the first in month adjuster, not null

nextback to summary
public static TemporalAdjuster next(DayOfWeek dayOfWeek)

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.

Parameters
dayOfWeek:DayOfWeek

the day-of-week to move the date to, not null

Returns:TemporalAdjuster

the next day-of-week adjuster, not null

nextOrSameback to summary
public static TemporalAdjuster nextOrSame(DayOfWeek dayOfWeek)

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.

Parameters
dayOfWeek:DayOfWeek

the day-of-week to check for or move the date to, not null

Returns:TemporalAdjuster

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

ofDateAdjusterback to summary
public static TemporalAdjuster ofDateAdjuster(UnaryOperator<LocalDate> dateBasedAdjuster)

Obtains a TemporalAdjuster that wraps a date adjuster.

The TemporalAdjuster is based on the low level Temporal interface. This method allows an adjustment from LocalDate to LocalDate to be wrapped to match the temporal-based interface. This is provided for convenience to make user-written adjusters simpler.

In general, user-written adjusters should be static constants: 

static TemporalAdjuster TWO_DAYS_LATER =
      TemporalAdjusters.ofDateAdjuster(date -> date.plusDays(2));
Parameters
dateBasedAdjuster:UnaryOperator<LocalDate>

the date-based adjuster, not null

Returns:TemporalAdjuster

the temporal adjuster wrapping on the date adjuster, not null

previousback to summary
public static TemporalAdjuster previous(DayOfWeek dayOfWeek)

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.

Parameters
dayOfWeek:DayOfWeek

the day-of-week to move the date to, not null

Returns:TemporalAdjuster

the previous day-of-week adjuster, not null

previousOrSameback to summary
public static TemporalAdjuster previousOrSame(DayOfWeek dayOfWeek)

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.

Parameters
dayOfWeek:DayOfWeek

the day-of-week to check for or move the date to, not null

Returns:TemporalAdjuster

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