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

ChronoField

ChronoUnit

IsoFields

JulianFields

Temporal

TemporalAccessor

TemporalAdjuster

TemporalAdjusters

TemporalAmount

TemporalField

TemporalQueries

TemporalQuery

TemporalUnit

UnsupportedTemporalTypeException

ValueRange

WeekFields

org.threeten.bp.temporal

ValueRange

Companion object ValueRange

final class ValueRange extends Serializable

The range of valid values for a date-time field.

All TemporalField instances have a valid range of values. For example, the ISO day-of-month runs from 1 to somewhere between 28 and 31. This class captures that valid range.

It is important to be aware of the limitations of this class. Only the minimum and maximum values are provided. It is possible for there to be invalid values within the outer range. For example, a weird field may have valid values of 1, 2, 4, 6, 7, thus have a range of '1 - 7', despite that fact that values 3 and 5 are invalid.

Instances of this class are not tied to a specific field.

Specification for implementors

This class is immutable and thread-safe.

Annotations: @SerialVersionUID()

Linear Supertypes

Serializable, AnyRef, Any

Ordering

Alphabetic
By Inheritance

Inherited

ValueRange
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
final def asInstanceOf[T0]: T0

Definition Classes
Any
def checkValidIntValue(value: Long, field: TemporalField): Int
Checks that the specified value is valid and fits in an int.
Checks that the specified value is valid and fits in an int.
This validates that the value is within the valid range of values and that all valid values are within the bounds of an int. The field is only used to improve the error message.
value
the value to check
field
the field being checked, may be null
returns
the value that was passed in

See also
#isValidIntValue(long)
def checkValidValue(value: Long, field: TemporalField): Long
Checks that the specified value is valid.
Checks that the specified value is valid.
This validates that the value is within the valid range of values. The field is only used to improve the error message.
value
the value to check
field
the field being checked, may be null
returns
the value that was passed in

See also
#isValidValue(long)
def clone(): AnyRef

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

Definition Classes
AnyRef
def equals(obj: Any): Boolean
Checks if this range is equal to another range.
Checks if this range is equal to another range.
The comparison is based on the four values, minimum, largest minimum, smallest maximum and maximum. Only objects of type ValueRange are compared, other types return false.
obj
the object to check, null returns false
returns
true if this is equal to the other range

Definition Classes
ValueRange → AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
Annotations
@native()
def getLargestMinimum: Long
Gets the largest possible minimum value that the field can take.
Gets the largest possible minimum value that the field can take.
For example, the ISO day-of-month always starts at 1. The largest minimum is therefore 1.
returns
the largest possible minimum value for this field
def getMaximum: Long
Gets the maximum value that the field can take.
Gets the maximum value that the field can take.
For example, the ISO day-of-month runs to between 28 and 31 days. The maximum is therefore 31.
returns
the maximum value for this field
def getMinimum: Long
Gets the minimum value that the field can take.
Gets the minimum value that the field can take.
For example, the ISO day-of-month always starts at 1. The minimum is therefore 1.
returns
the minimum value for this field
def getSmallestMaximum: Long
Gets the smallest possible maximum value that the field can take.
Gets the smallest possible maximum value that the field can take.
For example, the ISO day-of-month runs to between 28 and 31 days. The smallest maximum is therefore 28.
returns
the smallest possible maximum value for this field
def hashCode(): Int
A hash code for this range.
A hash code for this range.
returns
a suitable hash code

Definition Classes
ValueRange → AnyRef → Any
def isFixed: Boolean
Is the value range fixed and fully known.
Is the value range fixed and fully known.
For example, the ISO day-of-month runs from 1 to between 28 and 31. Since there is uncertainty about the maximum value, the range is not fixed. However, for the month of January, the range is always 1 to 31, thus it is fixed.
returns
true if the set of values is fixed
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isIntValue: Boolean
Checks if all values in the range fit in an int.
Checks if all values in the range fit in an int.
This checks that all valid values are within the bounds of an int.
For example, the ISO month-of-year has values from 1 to 12, which fits in an int. By comparison, ISO nano-of-day runs from 1 to 86,400,000,000,000 which does not fit in an int.
This implementation uses #getMinimum() and #getMaximum().
returns
true if a valid value always fits in an { @code int}
def isValidIntValue(value: Long): Boolean
Checks if the value is within the valid range and that all values in the range fit in an int.
Checks if the value is within the valid range and that all values in the range fit in an int.
This method combines #isIntValue() and #isValidValue(long).
value
the value to check
returns
true if the value is valid and fits in an { @code int}
def isValidValue(value: Long): Boolean
Checks if the value is within the valid range.
Checks if the value is within the valid range.
This checks that the value is within the stored range of values.
value
the value to check
returns
true if the value is valid
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()
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String
Outputs this range as a String.
Outputs this range as a String.
The format will be '{min}/{largestMin} - {smallestMax}/{max}', where the largestMin or smallestMax sections may be omitted, together with associated slash, if they are the same as the min or max.
returns
a string representation of this range, not null

Definition Classes
ValueRange → 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

Fields and Units

Adjustment

Weeks

ValueRange

Companion object ValueRange

final class ValueRange extends Serializable

Specification for implementors

Value Members

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

Packages

Dates and Times

Duration and Period

Additional value types

Fields and Units

Adjustment

Weeks

ValueRange 

Companion object ValueRange

final class ValueRange extends Serializable

Specification for implementors

Value Members

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped

ValueRange