javax.time.calendrical

Interface DateTime.WithAdjuster

All Known Implementing Classes:

ChronoDate, DayOfWeek, Instant, LocalDate, LocalDateTime, LocalTime, Month, MonthDay, OffsetDate, OffsetDateTime, OffsetTime, Year, YearMonth, ZonedDateTime, ZoneOffset

Enclosing interface:

DateTime

public static interface DateTime.WithAdjuster

Strategy for adjusting a date-time object.

This interface allows different kinds of adjustment to be modeled. Examples might be an adjuster that sets the date avoiding weekends, or one that sets the date to the last day of the month.

Implementations should not normally be used directly. Instead, the DateTime.with(WithAdjuster) method should be used:

   dateTime = dateTime.with(adjuster);
 

See DateTimeAdjusters for a standard set of adjusters, including finding the last day of the month.

Implementation notes

This interface must be implemented with care to ensure other classes operate correctly. All implementations that can be instantiated must be final, immutable and thread-safe.

Method Summary

Methods

Modifier and Type	Method and Description
DateTime	doAdjustment(DateTime dateTime) Implementation of the strategy to make an adjustment to the specified date-time object.

Method Detail

doAdjustment

DateTime doAdjustment(DateTime dateTime)

Implementation of the strategy to make an adjustment to the specified date-time object.

This method is not intended to be called by application code directly. Instead, the DateTime.with(WithAdjuster) method should be used:

Implementation notes

The implementation takes the input object and adjusts it according to an algorithm. For example, it could be used to adjust a date to "next Wednesday".

Implementations must use the methods on DateTime to make the adjustment. The returned object must have the same observable type as this object. The input object will be mutated if it is mutable, or a new object returned if immutable.

This interface can be used by calendar systems other than ISO. Implementations may choose to document compatibility with other calendar systems, or validate for it by querying the calendar system from the input object.

Parameters:

dateTime - the date-time object to adjust, not null

Returns:

an object of the same type with the adjustment made, not null

Throws:

DateTimeException - if unable to make the adjustment

ArithmeticException - if numeric overflow occurs