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 chrono

    Support for calendar systems other than the default ISO.

    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
    time
  • package format

    Provides classes to print and parse dates and times.

    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
    time
  • 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
  • package zone

    Support for time-zones and their rules.

    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
    time
  • Clock
  • DateTimeException
  • DateTimeUtils
  • DayOfWeek
  • Duration
  • Instant
  • LocalDate
  • LocalDateTime
  • LocalTime
  • Month
  • MonthDay
  • OffsetDateTime
  • OffsetTime
  • Period
  • Ser
  • Year
  • YearMonth
  • ZoneId
  • ZoneOffset
  • ZoneRegion
  • ZonedDateTime

final class ZoneOffset extends ZoneId with TemporalAccessor with TemporalAdjuster with Ordered[ZoneOffset] with Serializable

A time-zone offset from Greenwich/UTC, such as +02:00.

A time-zone offset is the period of time that a time-zone differs from Greenwich/UTC. This is usually a fixed number of hours and minutes.

Different parts of the world have different time-zone offsets. The rules for how offsets vary by place and time of year are captured in the ZoneId class.

For example, Paris is one hour ahead of Greenwich/UTC in winter and two hours ahead in summer. The ZoneId instance for Paris will reference two ZoneOffset instances - a +01:00 instance for winter, and a +02:00 instance for summer.

In 2008, time-zone offsets around the world extended from -12:00 to +14:00. To prevent any problems with that range being extended, yet still provide validation, the range of offsets is restricted to -18:00 to 18:00 inclusive.

This class is designed for use with the ISO calendar system. The fields of hours, minutes and seconds make assumptions that are valid for the standard ISO definitions of those fields. This class may be used with other calendar systems providing the definition of the time fields matches those of the ISO calendar system.

Instances of ZoneOffset must be compared using #equals. Implementations may choose to cache certain common offsets, however applications must not rely on such caching.

Specification for implementors

This class is immutable and thread-safe.

Annotations
@SerialVersionUID()
Linear Supertypes
Ordered[ZoneOffset], Comparable[ZoneOffset], TemporalAdjuster, TemporalAccessor, ZoneId, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZoneOffset
  2. Ordered
  3. Comparable
  4. TemporalAdjuster
  5. TemporalAccessor
  6. ZoneId
  7. Serializable
  8. AnyRef
  9. 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. def <(that: ZoneOffset): Boolean
    Definition Classes
    Ordered
  4. def <=(that: ZoneOffset): Boolean
    Definition Classes
    Ordered
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def >(that: ZoneOffset): Boolean
    Definition Classes
    Ordered
  7. def >=(that: ZoneOffset): Boolean
    Definition Classes
    Ordered
  8. def adjustInto(temporal: Temporal): Temporal

    Adjusts the specified temporal object to have the same offset as this object.

    Adjusts the specified temporal object to have the same offset as this object.

    This returns a temporal object of the same observable type as the input with the offset changed to be the same as this.

    The adjustment is equivalent to using long) passing ChronoField#OFFSET_SECONDS as the field.

    In most cases, it is clearer to reverse the calling pattern by using Temporal#with(TemporalAdjuster): 

    // these two lines are equivalent, but the second approach is recommended
temporal = thisOffset.adjustInto(temporal);
temporal = temporal.with(thisOffset);

    This instance is immutable and unaffected by this method call.

    temporal

    the target object to be adjusted, not null

    returns

    the adjusted object, not null

    Definition Classes
    ZoneOffset → TemporalAdjuster
    Exceptions thrown

    ArithmeticException if numeric overflow occurs

    DateTimeException if unable to make the adjustment

  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def compare(other: ZoneOffset): Int

    Compares this offset to another offset in descending order.

    Compares this offset to another offset in descending order.

    The offsets are compared in the order that they occur for the same time of day around the world. Thus, an offset of +10:00 comes before an offset of +09:00 and so on down to -18:00.

    The comparison is "consistent with equals", as defined by Comparable.

    other

    the other date to compare to, not null

    returns

    the comparator value, negative if less, postive if greater

    Definition Classes
    ZoneOffset → Ordered
    Exceptions thrown

    NullPointerException if { @code other} is null

  12. def compareTo(that: ZoneOffset): Int
    Definition Classes
    Ordered → Comparable
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(obj: Any): Boolean

    Checks if this offset is equal to another offset.

    Checks if this offset is equal to another offset.

    The comparison is based on the amount of the offset in seconds. This is equivalent to a comparison by ID.

    obj

    the object to check, null returns false

    returns

    true if this is equal to the other offset

    Definition Classes
    ZoneOffset → ZoneId → AnyRef → Any
  15. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  16. def get(field: TemporalField): Int

    Gets the value of the specified field from this offset as an int.

    Gets the value of the specified field from this offset as an int.

    This queries this offset for the value for the specified field. The returned value will always be within the valid range of values for the field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.

    If the field is a ChronoField then the query is implemented here. The OFFSET_SECONDS field returns the value of the offset. All other ChronoField instances will throw a DateTimeException.

    If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

    field

    the field to get, not null

    returns

    the value for the field

    Definition Classes
    ZoneOffset → TemporalAccessor
    Exceptions thrown

    ArithmeticException if numeric overflow occurs

    DateTimeException if a value for the field cannot be obtained

  17. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  18. def getDisplayName(style: TextStyle, locale: Locale): String

    Gets the textual representation of the zone, such as 'British Time' or '+02:00'.

    Gets the textual representation of the zone, such as 'British Time' or '+02:00'.

    This returns the textual name used to identify the time-zone ID, suitable for presentation to the user. The parameters control the style of the returned text and the locale.

    If no textual mapping is found then the full ID is returned.

    style

    the length of the text required, not null

    locale

    the locale to use, not null

    returns

    the text value of the zone, not null

    Definition Classes
    ZoneId
  19. def getId: String

    Gets the normalized zone offset ID.

    Gets the normalized zone offset ID.

    The ID is minor variation to the standard ISO-8601 formatted string for the offset. There are three formats:

    • Z - for UTC (ISO-8601)
    • +hh:mm or -hh:mm - if the seconds are zero (ISO-8601)
    • +hh:mm:ss or -hh:mm:ss - if the seconds are non-zero (not ISO-8601)
    returns

    the zone offset ID, not null

    Definition Classes
    ZoneOffset → ZoneId
  20. def getLong(field: TemporalField): Long

    Gets the value of the specified field from this offset as a long.

    Gets the value of the specified field from this offset as a long.

    This queries this offset for the value for the specified field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.

    If the field is a ChronoField then the query is implemented here. The OFFSET_SECONDS field returns the value of the offset. All other ChronoField instances will throw a DateTimeException.

    If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

    field

    the field to get, not null

    returns

    the value for the field

    Definition Classes
    ZoneOffset → TemporalAccessor
    Exceptions thrown

    ArithmeticException if numeric overflow occurs

    DateTimeException if a value for the field cannot be obtained

  21. def getRules: ZoneRules

    Gets the associated time-zone rules.

    Gets the associated time-zone rules.

    The rules will always return this offset when queried. The implementation class is immutable, thread-safe and serializable.

    returns

    the rules, not null

    Definition Classes
    ZoneOffset → ZoneId
  22. def getTotalSeconds: Int

    Gets the total zone offset in seconds.

    Gets the total zone offset in seconds.

    This is the primary way to access the offset amount. It returns the total of the hours, minutes and seconds fields as a single offset that can be added to a time.

    returns

    the total zone offset amount in seconds

  23. def hashCode(): Int

    A hash code for this offset.

    A hash code for this offset.

    returns

    a suitable hash code

    Definition Classes
    ZoneOffset → ZoneId → AnyRef → Any
  24. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  25. def isSupported(field: TemporalField): Boolean

    Checks if the specified field is supported.

    Checks if the specified field is supported.

    This checks if this offset can be queried for the specified field. If false, then calling the range and get methods will throw an exception.

    If the field is a ChronoField then the query is implemented here. The OFFSET_SECONDS field returns true. All other ChronoField instances will return false.

    If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.isSupportedBy(TemporalAccessor) passing this as the argument. Whether the field is supported is determined by the field.

    field

    the field to check, null returns false

    returns

    true if the field is supported on this offset, false if not

    Definition Classes
    ZoneOffset → TemporalAccessor
  26. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  27. def normalized: ZoneId

    Normalizes the time-zone ID, returning a ZoneOffset where possible.

    Normalizes the time-zone ID, returning a ZoneOffset where possible.

    The returns a normalized ZoneId that can be used in place of this ID. The result will have ZoneRules equivalent to those returned by this object, however the ID returned by getId() may be different.

    The normalization checks if the rules of this ZoneId have a fixed offset. If they do, then the ZoneOffset equal to that offset is returned. Otherwise this is returned.

    returns

    the time-zone unique ID, not null

    Definition Classes
    ZoneId
  28. final def notify(): Unit
    Definition Classes
    AnyRef
  29. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  30. def query[R >: Null](query: TemporalQuery[R]): R

    Queries this offset using the specified query.

    Queries this offset using the specified query.

    This queries this offset using the specified query strategy object. The TemporalQuery object defines the logic to be used to obtain the result. Read the documentation of the query to understand what the result of this method will be.

    The result of this method is obtained by invoking the TemporalQuery#queryFrom(TemporalAccessor) method on the specified query passing this as the argument.

    R

    the type of the result

    query

    the query to invoke, not null

    returns

    the query result, null may be returned (defined by the query)

    Definition Classes
    ZoneOffset → TemporalAccessor
    Exceptions thrown

    ArithmeticException if numeric overflow occurs (defined by the query)

    DateTimeException if unable to query (defined by the query)

  31. def range(field: TemporalField): ValueRange

    Gets the range of valid values for the specified field.

    Gets the range of valid values for the specified field.

    The range object expresses the minimum and maximum valid values for a field. This offset is used to enhance the accuracy of the returned range. If it is not possible to return the range, because the field is not supported or for some other reason, an exception is thrown.

    If the field is a ChronoField then the query is implemented here. The supported fields will return appropriate range instances. All other ChronoField instances will throw a DateTimeException.

    If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.rangeRefinedBy(TemporalAccessor) passing this as the argument. Whether the range can be obtained is determined by the field.

    field

    the field to query the range for, not null

    returns

    the range of valid values for the field, not null

    Definition Classes
    ZoneOffset → TemporalAccessor
    Exceptions thrown

    DateTimeException if the range for the field cannot be obtained

  32. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  33. def toString(): String

    Outputs this offset as a String, using the normalized ID.

    Outputs this offset as a String, using the normalized ID.

    returns

    a string representation of this offset, not null

    Definition Classes
    ZoneOffset → ZoneId → AnyRef → Any
  34. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Ordered[ZoneOffset]

Inherited from Comparable[ZoneOffset]

Inherited from TemporalAdjuster

Inherited from TemporalAccessor

Inherited from ZoneId

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped