Packages

package root

Definition Classes: root

package org

Definition Classes: root

package threeten

Definition Classes: org

package bp

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: threeten

package chrono

Support for calendar systems other than the default ISO.

The main API is based around the calendar system defined in ISO-8601. This package provides support for alternate systems.

The supported calendar systems includes:

-Hijrah calendar -Japanese calendar -Minguo calendar -Thai Buddhist calendar

It is intended that applications use the main API whenever possible, including code to read and write from a persistent data store, such as a database, and to send dates and times across a network. This package is then used at the user interface level to deal with localized input/output. See ChronoLocalDate for a full discussion of the issues.

Example

This example creates and uses a date in a non-ISO calendar system.

        // Print the Thai Buddhist date
        ChronoLocalDate now1 = ThaiBuddhistChronology.INSTANCE.now();
        int day = now1.get(ChronoField.DAY_OF_MONTH);
        int dow = now1.get(ChronoField.DAY_OF_WEEK);
        int month = now1.get(ChronoField.MONTH_OF_YEAR);
        int year = now1.get(ChronoField.YEAR);
        System.out.printf("  Today is %s %s %d-%s-%d%n", now1.getChronology().getId(),
                dow, day, month, year);

        // Enumerate the list of available calendars and print today for each
        Set<String> names = Chronology.getAvailableIds();
        for (String name : names) {
            Chronology<?> chrono = Chronology.of(name);
            ChronoLocalDate<?> date = chrono.now();
            System.out.printf("   %20s: %s%n", chrono.getId(), date.toString());
        }

        // Print today's date and the last day of the year for the Thai Buddhist Calendar.
        ChronoLocalDate first = now1
                .with(ChronoField.DAY_OF_MONTH, 1)
                .with(ChronoField.MONTH_OF_YEAR, 1);
        ChronoLocalDate last = first
                .plus(1, ChronoUnit.YEARS)
                .minus(1, ChronoUnit.DAYS);
        System.out.printf("  %s: 1st of year: %s; end of year: %s%n", last.getChronology().getId(),
                first, last);

Definition Classes: bp

package format

Provides classes to print and parse dates and times.

Printing and parsing is based around the DateTimeFormatter class. That class contains common formatters and factory methods. The DateTimeFormatterBuilder class is available for advanced and complex use cases.

Localization occurs by calling withLocale(Locale) on the formatter. Further customization is possible using DecimalStyle.

Definition Classes: bp

package temporal

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: bp

package zone

Support for time-zones and their rules.

Daylight Saving Time and Time-Zones are concepts used by Governments to alter local time. This package provides support for time-zones, their rules and the resulting gaps and overlaps in the local time-line typically caused by Daylight Saving Time.

Definition Classes: bp

Clock

DateTimeException

DayOfWeek

Duration

Instant

LocalDate

LocalDateTime

LocalTime

Month

MonthDay

OffsetDateTime

OffsetTime

Period

Ser

Year

YearMonth

ZoneId

ZoneOffset

ZoneRegion

ZonedDateTime

org.threeten.bp

OffsetDateTime

Companion class OffsetDateTime

object OffsetDateTime extends Serializable

Annotations: @SerialVersionUID()

Linear Supertypes

Serializable, Serializable, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

OffsetDateTime
Serializable
Serializable
AnyRef
Any

Hide All
Show All

Visibility

Public
All

Value Members

final def !=(arg0: Any): Boolean

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

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

Definition Classes
AnyRef → Any
val MAX: OffsetDateTime
The maximum supported OffsetDateTime, '+999999999-12-31T23:59:59.999999999-18:00'.
The maximum supported OffsetDateTime, '+999999999-12-31T23:59:59.999999999-18:00'. This is the local date-time just before midnight at the end of the maximum date in the minimum offset (larger negative offsets are later on the time-line). This combines LocalDateTime#MAX and ZoneOffset#MIN. This could be used by an application as a "far future" date-time.
val MIN: OffsetDateTime
The minimum supported OffsetDateTime, '-999999999-01-01T00:00:00+18:00'.
The minimum supported OffsetDateTime, '-999999999-01-01T00:00:00+18:00'. This is the local date-time of midnight at the start of the minimum date in the maximum offset (larger offsets are earlier on the time-line). This combines LocalDateTime#MIN and ZoneOffset#MAX. This could be used by an application as a "far past" date-time.
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@native() @throws( ... )
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
def from(temporal: TemporalAccessor): OffsetDateTime
Obtains an instance of OffsetDateTime from a temporal object.
Obtains an instance of OffsetDateTime from a temporal object.
A TemporalAccessor represents some form of date and time information. This factory converts the arbitrary temporal object to an instance of OffsetDateTime.
The conversion extracts and combines LocalDateTime and ZoneOffset. If that fails it will try to extract and combine Instant and ZoneOffset.
This method matches the signature of the functional interface TemporalQuery allowing it to be used in queries via method reference, OffsetDateTime::from.
temporal
the temporal object to convert, not null
returns
the offset date-time, not null

Exceptions thrown
DateTimeException if unable to convert to an { @code OffsetDateTime}
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
def hashCode(): Int

Definition Classes
AnyRef → Any
Annotations
@native()
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
Annotations
@native()
final def notifyAll(): Unit

Definition Classes
AnyRef
Annotations
@native()
def now(clock: Clock): OffsetDateTime
Obtains the current date-time from the specified clock.
Obtains the current date-time from the specified clock.
This will query the specified clock to obtain the current date-time. The offset will be calculated from the time-zone in the clock.
Using this method allows the use of an alternate clock for testing. The alternate clock may be introduced using dependency injection.
clock
the clock to use, not null
returns
the current date-time, not null
def now(zone: ZoneId): OffsetDateTime
Obtains the current date-time from the system clock in the specified time-zone.
Obtains the current date-time from the system clock in the specified time-zone.
This will query the system clock to obtain the current date-time. Specifying the time-zone avoids dependence on the default time-zone. The offset will be calculated from the specified time-zone.
Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.
zone
the zone ID to use, not null
returns
the current date-time using the system clock, not null
def now: OffsetDateTime
Obtains the current date-time from the system clock in the default time-zone.
Obtains the current date-time from the system clock in the default time-zone.
This will query the system clock in the default time-zone to obtain the current date-time. The offset will be calculated from the time-zone in the clock.
Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.
returns
the current date-time using the system clock, not null
def of(year: Int, month: Int, dayOfMonth: Int, hour: Int, minute: Int, second: Int, nanoOfSecond: Int, offset: ZoneOffset): OffsetDateTime
Obtains an instance of OffsetDateTime from a year, month, day, hour, minute, second, nanosecond and offset.
Obtains an instance of OffsetDateTime from a year, month, day, hour, minute, second, nanosecond and offset.
This creates an offset date-time with the seven specified fields.
This method exists primarily for writing test cases. Non test-code will typically use other methods to create an offset time. LocalDateTime has five additional convenience variants of the equivalent factory method taking fewer arguments. They are not provided here to reduce the footprint of the API.
year
the year to represent, from MIN_YEAR to MAX_YEAR
month
the month-of-year to represent, from 1 (January) to 12 (December)
dayOfMonth
the day-of-month to represent, from 1 to 31
hour
the hour-of-day to represent, from 0 to 23
minute
the minute-of-hour to represent, from 0 to 59
second
the second-of-minute to represent, from 0 to 59
nanoOfSecond
the nano-of-second to represent, from 0 to 999,999,999
offset
the zone offset, not null
returns
the offset date-time, not null

Exceptions thrown
DateTimeException if the value of any field is out of range, or if the day-of-month is invalid for the month-year
def of(dateTime: LocalDateTime, offset: ZoneOffset): OffsetDateTime
Obtains an instance of OffsetDateTime from a date-time and offset.
Obtains an instance of OffsetDateTime from a date-time and offset.
This creates an offset date-time with the specified local date-time and offset.
dateTime
the local date-time, not null
offset
the zone offset, not null
returns
the offset date-time, not null
def of(date: LocalDate, time: LocalTime, offset: ZoneOffset): OffsetDateTime
Obtains an instance of OffsetDateTime from a date, time and offset.
Obtains an instance of OffsetDateTime from a date, time and offset.
This creates an offset date-time with the specified local date, time and offset.
date
the local date, not null
time
the local time, not null
offset
the zone offset, not null
returns
the offset date-time, not null
def ofInstant(instant: Instant, zone: ZoneId): OffsetDateTime
Obtains an instance of OffsetDateTime from an Instant and zone ID.
Obtains an instance of OffsetDateTime from an Instant and zone ID.
This creates an offset date-time with the same instant as that specified. Finding the offset from UTC/Greenwich is simple as there is only one valid offset for each instant.
instant
the instant to create the date-time from, not null
zone
the time-zone, which may be an offset, not null
returns
the offset date-time, not null

Exceptions thrown
DateTimeException if the result exceeds the supported range
def parse(text: CharSequence, formatter: DateTimeFormatter): OffsetDateTime
Obtains an instance of OffsetDateTime from a text string using a specific formatter.
Obtains an instance of OffsetDateTime from a text string using a specific formatter.
The text is parsed using the formatter, returning a date-time.
text
the text to parse, not null
formatter
the formatter to use, not null
returns
the parsed offset date-time, not null

Exceptions thrown
DateTimeParseException if the text cannot be parsed
def parse(text: CharSequence): OffsetDateTime
Obtains an instance of OffsetDateTime from a text string such as 2007-12-03T10:15:30+01:00.
Obtains an instance of OffsetDateTime from a text string such as 2007-12-03T10:15:30+01:00.
The string must represent a valid date-time and is parsed using org.threeten.bp.format.DateTimeFormatter#ISO_OFFSET_DATE_TIME.
text
the text to parse such as "2007-12-03T10:15:30+01:00", not null
returns
the parsed offset date-time, not null

Exceptions thrown
DateTimeParseException if the text cannot be parsed
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def timeLineOrder: Comparator[OffsetDateTime]
Gets a comparator that compares two OffsetDateTime instances based solely on the instant.
Gets a comparator that compares two OffsetDateTime instances based solely on the instant.
This method differs from the comparison in #compareTo in that it only compares the underlying instant.
returns
a comparator that compares in time-line order

See also
#isAfter
#isBefore
#isEqual
def toString(): String

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

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

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

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

Packages

Dates and Times

Duration and Period

Additional value types

Example

Fields and Units

Adjustment

Weeks

OffsetDateTime

Companion class OffsetDateTime

object OffsetDateTime extends Serializable

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Dates and Times

Duration and Period

Additional value types

Example

Fields and Units

Adjustment

Weeks

OffsetDateTime 

Companion class OffsetDateTime

object OffsetDateTime extends Serializable

Value Members

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

OffsetDateTime