Packages

  • package root
    Definition Classes
    root
  • package java
    Definition Classes
    root
  • package time

    The main API for dates, times, instants, and durations.

    The main API for dates, times, instants, and durations.

    The classes defined here represent the principal date-time concepts, including instants, durations, dates, times, time-zones and periods. They are based on the ISO calendar system, which is the de facto world calendar following the proleptic Gregorian rules. All the classes are immutable and thread-safe.

    Each date time instance is composed of fields that are conveniently made available by the APIs. For lower level access to the fields refer to the org.threeten.bp.temporal package. Each class includes support for printing and parsing all manner of dates and times. Refer to the org.threeten.bp.format package for customization options.

    The org.threeten.bp.chrono package contains the calendar neutral API. This is intended for use by applications that need to use localized calendars. It is recommended that applications use the ISO-8601 dates and time classes from this package across system boundaries, such as to the database or across the network. The calendar neutral API should be reserved for interactions with users.

    Dates and Times

    org.threeten.bp.Instant is essentially a numeric timestamp. The current Instant can be retrieved from a org.threeten.bp.Clock. This is useful for logging and persistence of a point in time and has in the past been associated with storing the result from java.lang.System#currentTimeMillis().

    org.threeten.bp.LocalDate stores a date without a time. This stores a date like '2010-12-03' and could be used to store a birthday.

    org.threeten.bp.LocalTime stores a time without a date. This stores a time like '11:30' and could be used to store an opening or closing time.

    org.threeten.bp.LocalDateTime stores a date and time. This stores a date-time like '2010-12-03T11:30'.

    org.threeten.bp.OffsetTime stores a time and offset from UTC without a date. This stores a date like '11:30+01:00'. The ZoneOffset is of the form '+01:00'.

    org.threeten.bp.OffsetDateTime stores a date and time and offset from UTC. This stores a date-time like '2010-12-03T11:30+01:00'. This is sometimes found in XML messages and other forms of persistence, but contains less information than a full time-zone.

    org.threeten.bp.ZonedDateTime stores a date and time with a time-zone. This is useful if you want to perform accurate calculations of dates and times taking into account the org.threeten.bp.ZoneId, such as 'Europe/Paris'. Where possible, it is recommended to use a simpler class. The widespread use of time-zones tends to add considerable complexity to an application.

    Duration and Period

    Beyond dates and times, the API also allows the storage of period and durations of time. A org.threeten.bp.Duration is a simple measure of time along the time-line in nanoseconds. A org.threeten.bp.Period expresses an amount of time in units meaningful to humans, such as years or hours.

    Additional value types

    org.threeten.bp.Year stores a year on its own. This stores a single year in isolation, such as '2010'.

    org.threeten.bp.YearMonth stores a year and month without a day or time. This stores a year and month, such as '2010-12' and could be used for a credit card expiry.

    org.threeten.bp.MonthDay stores a month and day without a year or time. This stores a month and day-of-month, such as '--12-03' and could be used to store an annual event like a birthday without storing the year.

    org.threeten.bp.Month stores a month on its own. This stores a single month-of-year in isolation, such as 'DECEMBER'.

    org.threeten.bp.DayOfWeek stores a day-of-week on its own. This stores a single day-of-week in isolation, such as 'TUESDAY'.

    Definition Classes
    java
  • package temporal

    Access to date and time using fields and units.

    Access to date and time using fields and units.

    This package expands on the base package to provide additional functionality for more powerful use cases. Support is included for:

    • Units of date-time, such as years, months, days and hours
    • Fields of date-time, such as month-of-year, day-of-week or hour-of-day
    • Date-time adjustment functions
    • Different definitions of weeks

    Fields and Units

    Dates and times are expressed in terms of fields and units. A unit is used to measure an amount of time, such as years, days or minutes. All units implement org.threeten.bp.temporal.TemporalUnit. The set of well known units is defined in org.threeten.bp.temporal.ChronoUnit, for example, org.threeten.bp.temporal.ChronoUnit#DAYS. The unit interface is designed to allow applications to add their own units.

    A field is used to express part of a larger date-time, such as year, month-of-year or second-of-minute. All fields implement org.threeten.bp.temporal.TemporalField. The set of well known fields are defined in org.threeten.bp.temporal.ChronoField, for example, org.threeten.bp.temporal.ChronoField#HOUR_OF_DAY. An additional fields are defined by org.threeten.bp.temporal.JulianFields. The field interface is designed to allow applications to add their own fields.

    This package provides tools that allow the units and fields of date and time to be accessed in a general way most suited for frameworks. org.threeten.bp.temporal.Temporal provides the abstraction for date time types that support fields. Its methods support getting the value of a field, creating a new date time with the value of a field modified, and extracting another date time type, typically used to extract the offset or time-zone.

    One use of fields in application code is to retrieve fields for which there is no convenience method. For example, getting the day-of-month is common enough that there is a method on LocalDate called getDayOfMonth(). However for more unusual fields it is necessary to use the field. For example, date.get(ChronoField.ALIGNED_WEEK_OF_MONTH). The fields also provide access to the range of valid values.

    Adjustment

    A key part of the date-time problem space is adjusting a date to a new, related value, such as the "last day of the month", or "next Wednesday". These are modeled as functions that adjust a base date-time. The functions implement org.threeten.bp.temporal.TemporalAdjuster and operate on org.threeten.bp.temporal.Temporal. A set of common functions are provided in org.threeten.bp.temporal.TemporalAdjusters. For example, to find the first occurrence of a day-of-week after a given date, use org.threeten.bp.temporal.TemporalAdjusters#next(DayOfWeek), such as date.with(next(MONDAY)).

    Weeks

    Different locales have different definitions of the week. For example, in Europe the week typically starts on a Monday, while in the US it starts on a Sunday. The org.threeten.bp.temporal.WeekFields class models this distinction.

    The ISO calendar system defines an additional week-based division of years. This defines a year based on whole Monday to Monday weeks. This is modeled in org.threeten.bp.temporal.IsoFields.

    Definition Classes
    time
  • ChronoField
  • ChronoUnit
  • IsoFields
  • JulianFields
  • Temporal
  • TemporalAccessor
  • TemporalAdjuster
  • TemporalAdjusters
  • TemporalAmount
  • TemporalField
  • TemporalQueries
  • TemporalQuery
  • TemporalUnit
  • UnsupportedTemporalTypeException
  • ValueRange
  • WeekFields
o

java.time.temporal

TemporalAdjusters

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
AnyRef, Any
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
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  6. def dayOfWeekInMonth(ordinal: Int, dayOfWeek: DayOfWeek): TemporalAdjuster

    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
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  10. def firstDayOfMonth: TemporalAdjuster

    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

    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

    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

    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

    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[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def lastDayOfMonth: TemporalAdjuster

    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

    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

    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
    Definition Classes
    AnyRef
  22. def next(dayOfWeek: DayOfWeek): TemporalAdjuster

    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

    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
    Definition Classes
    AnyRef
    Annotations
    @native()
  25. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  26. def ofDateAdjuster(localDateAdjuster: (LocalDate) ⇒ LocalDate): TemporalAdjuster
  27. def previous(dayOfWeek: DayOfWeek): TemporalAdjuster

    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

    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
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()

Inherited from AnyRef

Inherited from Any

Ungrouped