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 MonthDay extends TemporalAccessor with TemporalAdjuster with Ordered[MonthDay] with Serializable

A month-day in the ISO-8601 calendar system, such as --12-03.

MonthDay is an immutable date-time object that represents the combination of a year and month. Any field that can be derived from a month and day, such as quarter-of-year, can be obtained.

This class does not store or represent a year, time or time-zone. For example, the value "December 3rd" can be stored in a MonthDay.

Since a MonthDay does not possess a year, the leap day of February 29th is considered valid.

This class implements TemporalAccessor rather than Temporal. This is because it is not possible to define whether February 29th is valid or not without external information, preventing the implementation of plus/minus. Related to this, MonthDay only provides access to query and set the fields MONTH_OF_YEAR and DAY_OF_MONTH.

The ISO-8601 calendar system is the modern civil calendar system used today in most of the world. It is equivalent to the proleptic Gregorian calendar system, in which today's rules for leap years are applied for all time. For most applications written today, the ISO-8601 rules are entirely suitable. However, any application that makes use of historical dates, and requires them to be accurate will find the ISO-8601 approach unsuitable.

Specification for implementors

This class is immutable and thread-safe.

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

    Adjusts the specified temporal object to have this month-day.

    Adjusts the specified temporal object to have this month-day.

    This returns a temporal object of the same observable type as the input with the month and day-of-month changed to be the same as this.

    The adjustment is equivalent to using long) twice, passing ChronoField#MONTH_OF_YEAR and ChronoField#DAY_OF_MONTH as the fields. If the specified temporal object does not use the ISO calendar system then a DateTimeException is thrown.

    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 = thisMonthDay.adjustInto(temporal);
temporal = temporal.with(thisMonthDay);

    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
    MonthDay → 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 atYear(year: Int): LocalDate

    Combines this month-day with a year to create a LocalDate.

    Combines this month-day with a year to create a LocalDate.

    This returns a LocalDate formed from this month-day and the specified year.

    A month-day of February 29th will be adjusted to February 28th in the resulting date if the year is not a leap year.

    This instance is immutable and unaffected by this method call.

    year

    the year to use, from MIN_YEAR to MAX_YEAR

    returns

    the local date formed from this month-day and the specified year, not null

    Exceptions thrown

    DateTimeException if the year is outside the valid range of years

  11. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def compare(other: MonthDay): Int

    Compares this month-day to another month-day.

    Compares this month-day to another month-day.

    The comparison is based first on value of the month, then on the value of the day. It is "consistent with equals", as defined by Comparable.

    other

    the other month-day to compare to, not null

    returns

    the comparator value, negative if less, positive if greater

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

    Checks if this month-day is equal to another month-day.

    Checks if this month-day is equal to another month-day.

    The comparison is based on the time-line position of the month-day within a year.

    obj

    the object to check, null returns false

    returns

    true if this is equal to the other month-day

    Definition Classes
    MonthDay → AnyRef → Any
  16. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. def format(formatter: DateTimeFormatter): String

    Outputs this month-day as a String using the formatter.

    Outputs this month-day as a String using the formatter.

    This month-day will be passed to the formatter print method.

    formatter

    the formatter to use, not null

    returns

    the formatted month-day string, not null

    Exceptions thrown

    DateTimeException if an error occurs during printing

  18. def get(field: TemporalField): Int

    Gets the value of the specified field from this month-day as an int.

    Gets the value of the specified field from this month-day as an int.

    This queries this month-day 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 supported fields will return valid values based on this month-day. 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
    MonthDay → TemporalAccessor
    Exceptions thrown

    ArithmeticException if numeric overflow occurs

    DateTimeException if a value for the field cannot be obtained

  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  20. def getDayOfMonth: Int

    Gets the day-of-month field.

    Gets the day-of-month field.

    This method returns the primitive int value for the day-of-month.

    returns

    the day-of-month, from 1 to 31

  21. def getLong(field: TemporalField): Long

    Gets the value of the specified field from this month-day as a long.

    Gets the value of the specified field from this month-day as a long.

    This queries this month-day 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 supported fields will return valid values based on this month-day. 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
    MonthDay → TemporalAccessor
    Exceptions thrown

    ArithmeticException if numeric overflow occurs

    DateTimeException if a value for the field cannot be obtained

  22. def getMonth: Month

    Gets the month-of-year field using the Month enum.

    Gets the month-of-year field using the Month enum.

    This method returns the enum Month for the month. This avoids confusion as to what int values mean. If you need access to the primitive int value then the enum provides the int value.

    returns

    the month-of-year, not null

    See also

    #getMonthValue()

  23. def getMonthValue: Int

    Gets the month-of-year field from 1 to 12.

    Gets the month-of-year field from 1 to 12.

    This method returns the month as an int from 1 to 12. Application code is frequently clearer if the enum Month is used by calling #getMonth().

    returns

    the month-of-year, from 1 to 12

    See also

    #getMonth()

  24. def hashCode(): Int

    A hash code for this month-day.

    A hash code for this month-day.

    returns

    a suitable hash code

    Definition Classes
    MonthDay → AnyRef → Any
  25. def isAfter(other: MonthDay): Boolean

    Is this month-day after the specified month-day.

    Is this month-day after the specified month-day.

    other

    the other month-day to compare to, not null

    returns

    true if this is after the specified month-day

  26. def isBefore(other: MonthDay): Boolean

    Is this month-day before the specified month-day.

    Is this month-day before the specified month-day.

    other

    the other month-day to compare to, not null

    returns

    true if this point is before the specified month-day

  27. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  28. def isSupported(field: TemporalField): Boolean

    Checks if the specified field is supported.

    Checks if the specified field is supported.

    This checks if this month-day 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 supported fields will return valid values based on this date-time. The supported fields are:

    • MONTH_OF_YEAR
    • YEAR

    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 month-day, false if not

    Definition Classes
    MonthDay → TemporalAccessor
  29. def isValidYear(year: Int): Boolean

    Checks if the year is valid for this month-day.

    Checks if the year is valid for this month-day.

    This method checks whether this month and day and the input year form a valid date. This can only return false for February 29th.

    year

    the year to validate, an out of range value returns false

    returns

    true if the year is valid for this month-day

    See also

    Year#isValidMonthDay(MonthDay)

  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  33. def query[R >: Null](query: TemporalQuery[R]): R

    Queries this month-day using the specified query.

    Queries this month-day using the specified query.

    This queries this month-day 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
    MonthDay → TemporalAccessor
    Exceptions thrown

    ArithmeticException if numeric overflow occurs (defined by the query)

    DateTimeException if unable to query (defined by the query)

  34. 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 month-day 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
    MonthDay → TemporalAccessor
    Exceptions thrown

    DateTimeException if the range for the field cannot be obtained

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

    Outputs this month-day as a String, such as --12-03.

    Outputs this month-day as a String, such as --12-03.

    The output will be in the format --MM-dd:

    returns

    a string representation of this month-day, not null

    Definition Classes
    MonthDay → AnyRef → Any
  37. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  38. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  39. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  40. def with(month: Month): MonthDay

    Returns a copy of this MonthDay with the month-of-year altered.

    Returns a copy of this MonthDay with the month-of-year altered.

    This returns a month-day with the specified month. If the day-of-month is invalid for the specified month, the day will be adjusted to the last valid day-of-month.

    This instance is immutable and unaffected by this method call.

    month

    the month-of-year to set in the returned month-day, not null

    returns

    a { @code MonthDay} based on this month-day with the requested month, not null

  41. def withDayOfMonth(dayOfMonth: Int): MonthDay

    Returns a copy of this MonthDay with the day-of-month altered.

    Returns a copy of this MonthDay with the day-of-month altered.

    This returns a month-day with the specified day-of-month. If the day-of-month is invalid for the month, an exception is thrown.

    This instance is immutable and unaffected by this method call.

    dayOfMonth

    the day-of-month to set in the return month-day, from 1 to 31

    returns

    a { @code MonthDay} based on this month-day with the requested day, not null

    Exceptions thrown

    DateTimeException if the day-of-month is invalid for the month

  42. def withMonth(month: Int): MonthDay

    Returns a copy of this MonthDay with the month-of-year altered.

    Returns a copy of this MonthDay with the month-of-year altered.

    This returns a month-day with the specified month. If the day-of-month is invalid for the specified month, the day will be adjusted to the last valid day-of-month.

    This instance is immutable and unaffected by this method call.

    month

    the month-of-year to set in the returned month-day, from 1 (January) to 12 (December)

    returns

    a { @code MonthDay} based on this month-day with the requested month, not null

    Exceptions thrown

    DateTimeException if the month-of-year value is invalid

Inherited from Serializable

Inherited from Ordered[MonthDay]

Inherited from Comparable[MonthDay]

Inherited from TemporalAdjuster

Inherited from TemporalAccessor

Inherited from AnyRef

Inherited from Any

Ungrouped