Spec-Zone .ru
спецификации, руководства, описания, API
|
@FunctionalInterface public interface TemporalAdjuster
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.
This class also contains a standard set of adjusters, available as static methods. These include:
All the implementations supplied by the static methods on this interface are immutable.
Modifier and Type | Method and Description |
---|---|
Temporal |
adjustInto(Temporal temporal)
Adjusts the specified temporal object.
|
static TemporalAdjuster |
dayOfWeekInMonth(int ordinal,
DayOfWeek dayOfWeek)
Returns the day-of-week in month adjuster, which returns a new date
in the same month with the ordinal day-of-week.
|
static TemporalAdjuster |
firstDayOfMonth()
Returns the "first day of month" adjuster, which returns a new date set to
the first day of the current month.
|
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.
|
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.
|
static TemporalAdjuster |
firstDayOfYear()
Returns the "first day of year" adjuster, which returns a new date set to
the first day of the current year.
|
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.
|
static TemporalAdjuster |
lastDayOfMonth()
Returns the "last day of month" adjuster, which returns a new date set to
the last day of the current month.
|
static TemporalAdjuster |
lastDayOfYear()
Returns the "last day of year" adjuster, which returns a new date set to
the last day of the current year.
|
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.
|
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.
|
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.
|
static TemporalAdjuster |
ofDateAdjuster(UnaryOperator<LocalDate> dateBasedAdjuster)
Obtains a
TemporalAdjuster that wraps a date adjuster. |
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.
|
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.
|
Temporal adjustInto(Temporal temporal)
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.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.
temporal
- the temporal object to adjust, not nullDateTimeException
- if unable to make the adjustmentArithmeticException
- if numeric overflow occursstatic TemporalAdjuster ofDateAdjuster(UnaryOperator<LocalDate> dateBasedAdjuster)
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 = TemporalAdjuster.ofDateAdjuster(
date -> date.plusDays(2));
dateBasedAdjuster
- the date-based adjuster, not nullstatic TemporalAdjuster firstDayOfMonth()
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);
static TemporalAdjuster lastDayOfMonth()
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);
static TemporalAdjuster firstDayOfNextMonth()
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);
static TemporalAdjuster firstDayOfYear()
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);
static TemporalAdjuster lastDayOfYear()
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);
static TemporalAdjuster firstDayOfNextYear()
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);
static TemporalAdjuster firstInMonth(DayOfWeek dayOfWeek)
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.
dayOfWeek
- the day-of-week, not nullstatic TemporalAdjuster lastInMonth(DayOfWeek dayOfWeek)
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.
dayOfWeek
- the day-of-week, not nullstatic TemporalAdjuster dayOfWeekInMonth(int ordinal, DayOfWeek dayOfWeek)
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.
ordinal
- the week within the month, unbounded but typically from -5 to 5dayOfWeek
- the day-of-week, not nullstatic TemporalAdjuster next(DayOfWeek dayOfWeek)
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.
dayOfWeek
- the day-of-week to move the date to, not nullstatic TemporalAdjuster nextOrSame(DayOfWeek dayOfWeek)
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.
dayOfWeek
- the day-of-week to check for or move the date to, not nullstatic TemporalAdjuster previous(DayOfWeek dayOfWeek)
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.
dayOfWeek
- the day-of-week to move the date to, not nullstatic TemporalAdjuster previousOrSame(DayOfWeek dayOfWeek)
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.
dayOfWeek
- the day-of-week to check for or move the date to, not null
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2013, Oracle and/or its affiliates. All rights reserved.
DRAFT ea-b92