Object

org.threeten.bp.temporal

TemporalAdjusters

Related Doc: package temporal

Permalink

object 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(TemporalAdjuster):
// 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(TemporalAdjuster), 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.

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. TemporalAdjusters
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def dayOfWeekInMonth(ordinal: Int, dayOfWeek: DayOfWeek): TemporalAdjuster

    Permalink

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

    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.

    ordinal

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

    dayOfWeek

    the day-of-week, not null

    returns

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

  7. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. def firstDayOfMonth: TemporalAdjuster

    Permalink

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

    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

    the first day-of-month adjuster, not null

  11. def firstDayOfNextMonth: TemporalAdjuster

    Permalink

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

    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

    the first day of next month adjuster, not null

  12. def firstDayOfNextYear: TemporalAdjuster

    Permalink

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

    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

    the first day of next month adjuster, not null

  13. def firstDayOfYear: TemporalAdjuster

    Permalink

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

    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

    the first day-of-year adjuster, not null

  14. def firstInMonth(dayOfWeek: DayOfWeek): TemporalAdjuster

    Permalink

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

    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.

    dayOfWeek

    the day-of-week, not null

    returns

    the first in month adjuster, not null

  15. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  16. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  17. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  18. def lastDayOfMonth: TemporalAdjuster

    Permalink

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

    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:

    val lastDay: Long = temporal.range(DAY_OF_MONTH).getMaximum();
    temporal.with(DAY_OF_MONTH, lastDay);
    

    returns

    the last day-of-month adjuster, not null

  19. def lastDayOfYear: TemporalAdjuster

    Permalink

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

    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

    the last day-of-year adjuster, not null

  20. def lastInMonth(dayOfWeek: DayOfWeek): TemporalAdjuster

    Permalink

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

    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.

    dayOfWeek

    the day-of-week, not null

    returns

    the first in month adjuster, not null

  21. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  22. def next(dayOfWeek: DayOfWeek): TemporalAdjuster

    Permalink

    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.

    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.

    dayOfWeek

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

    returns

    the next day-of-week adjuster, not null

  23. def nextOrSame(dayOfWeek: DayOfWeek): TemporalAdjuster

    Permalink

    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.

    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.

    dayOfWeek

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

    returns

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

  24. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  25. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  26. def ofDateAdjuster(localDateAdjuster: (LocalDate) ⇒ LocalDate): TemporalAdjuster

    Permalink
  27. def previous(dayOfWeek: DayOfWeek): TemporalAdjuster

    Permalink

    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.

    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.

    dayOfWeek

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

    returns

    the previous day-of-week adjuster, not null

  28. def previousOrSame(dayOfWeek: DayOfWeek): TemporalAdjuster

    Permalink

    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.

    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.

    dayOfWeek

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

    returns

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

  29. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  30. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped