public interface TemporalAdder
Adders are a key tool for modifying temporal objects. They exist to externalize the process of addition, permitting different approaches, as per the strategy design pattern.
There are two equivalent ways of using a TemporalAdder
.
The first is to invoke the method on this interface directly.
The second is to use Temporal.plus(TemporalAdder)
:
// these two lines are equivalent, but the second approach is recommended dateTime = adder.addTo(dateTime); dateTime = dateTime.plus(adder);It is recommended to use the second approach,
plus(TemporalAdder)
,
as it is a lot clearer to read in code.
The Period
and Duration
classes implement this interface.
Adders may also be defined by applications.
Modifier and Type | Method and Description |
---|---|
Temporal |
addTo(Temporal temporal)
Adds to the specified temporal object.
|
Temporal addTo(Temporal temporal)
This adds to the specified temporal object using the logic encapsulated in the implementing class.
There are two equivalent ways of using this method.
The first is to invoke this method directly.
The second is to use Temporal.plus(TemporalAdder)
:
// these two lines are equivalent, but the second approach is recommended dateTime = adder.addTo(dateTime); dateTime = dateTime.plus(adder);It is recommended to use the second approach,
plus(TemporalAdder)
,
as it is a lot clearer to read in code.
Temporal
to
query the temporal object and perform the addition.
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 addjava.lang.ArithmeticException
- if numeric overflow occurs