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

A time without time-zone in the ISO-8601 calendar system, such as 10:15:30.

LocalTime is an immutable date-time object that represents a time, often viewed as hour-minute-second. Time is represented to nanosecond precision. For example, the value "13:45.30.123456789" can be stored in a LocalTime.

It does not store or represent a date or time-zone. Instead, it is a description of the local time as seen on a wall clock. It cannot represent an instant on the time-line without additional information such as an offset or time-zone.

The ISO-8601 calendar system is the modern civil calendar system used today in most of the world. This API assumes that all calendar systems use the same representation, this class, for time-of-day.

Specification for implementors

This class is immutable and thread-safe.

Annotations
@SerialVersionUID()
Linear Supertypes
Serializable, Ordered[LocalTime], Comparable[LocalTime], TemporalAdjuster, Temporal, TemporalAccessor, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. LocalTime
  2. Serializable
  3. Ordered
  4. Comparable
  5. TemporalAdjuster
  6. Temporal
  7. TemporalAccessor
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new LocalTime(_hour: Int, _minute: Int, _second: Int, nano: Int)

    Constructor, previously validated.

    Constructor, previously validated.

    _hour

    the hour-of-day to represent, validated from 0 to 23

    _minute

    the minute-of-hour to represent, validated from 0 to 59

    _second

    the second-of-minute to represent, validated from 0 to 59

    nano

    the nano-of-second to represent, validated from 0 to 999,999,999

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. def <(that: LocalTime): Boolean
    Definition Classes
    Ordered
  4. def <=(that: LocalTime): Boolean
    Definition Classes
    Ordered
  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. def >(that: LocalTime): Boolean
    Definition Classes
    Ordered
  7. def >=(that: LocalTime): Boolean
    Definition Classes
    Ordered
  8. def adjustInto(temporal: Temporal): Temporal

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

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

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

    The adjustment is equivalent to using long) passing ChronoField#NANO_OF_DAY 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 = thisLocalTime.adjustInto(temporal);
temporal = temporal.with(thisLocalTime);

    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
    LocalTime → 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 atDate(date: LocalDate): LocalDateTime

    Combines this time with a date to create a LocalDateTime.

    Combines this time with a date to create a LocalDateTime.

    This returns a LocalDateTime formed from this time at the specified date. All possible combinations of date and time are valid.

    date

    the date to combine with, not null

    returns

    the local date-time formed from this time and the specified date, not null

  11. def atOffset(offset: ZoneOffset): OffsetTime

    Combines this time with an offset to create an OffsetTime.

    Combines this time with an offset to create an OffsetTime.

    This returns an OffsetTime formed from this time at the specified offset. All possible combinations of time and offset are valid.

    offset

    the offset to combine with, not null

    returns

    the offset time formed from this time and the specified offset, not null

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

    Compares this LocalTime to another time.

    Compares this LocalTime to another time.

    The comparison is based on the time-line position of the local times within a day. It is "consistent with equals", as defined by Comparable.

    other

    the other time to compare to, not null

    returns

    the comparator value, negative if less, positive if greater

    Definition Classes
    LocalTime → Ordered
    Exceptions thrown

    NullPointerException if { @code other} is null

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

    Checks if this time is equal to another time.

    Checks if this time is equal to another time.

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

    Only objects of type LocalTime are compared, other types return false. To compare the date of two TemporalAccessor instances, use ChronoField#NANO_OF_DAY as a comparator.

    obj

    the object to check, null returns false

    returns

    true if this is equal to the other time

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

    Outputs this time as a String using the formatter.

    Outputs this time as a String using the formatter.

    This time will be passed to the formatter print method.

    formatter

    the formatter to use, not null

    returns

    the formatted time string, not null

    Exceptions thrown

    DateTimeException if an error occurs during printing

  19. def get(field: TemporalField): Int

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

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

    This queries this time 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 time, except NANO_OF_DAY and MICRO_OF_DAY which are too large to fit in an int and throw a DateTimeException. 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
    LocalTime → TemporalAccessor
    Exceptions thrown

    ArithmeticException if numeric overflow occurs

    DateTimeException if a value for the field cannot be obtained

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

    Gets the hour-of-day field.

    Gets the hour-of-day field.

    returns

    the hour-of-day, from 0 to 23

  22. def getLong(field: TemporalField): Long

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

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

    This queries this time 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 time. 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
    LocalTime → TemporalAccessor
    Exceptions thrown

    ArithmeticException if numeric overflow occurs

    DateTimeException if a value for the field cannot be obtained

  23. def getMinute: Int

    Gets the minute-of-hour field.

    Gets the minute-of-hour field.

    returns

    the minute-of-hour, from 0 to 59

  24. def getNano: Int

    Gets the nano-of-second field.

    Gets the nano-of-second field.

    returns

    the nano-of-second, from 0 to 999,999,999

  25. def getSecond: Int

    Gets the second-of-minute field.

    Gets the second-of-minute field.

    returns

    the second-of-minute, from 0 to 59

  26. def hashCode(): Int

    A hash code for this time.

    A hash code for this time.

    returns

    a suitable hash code

    Definition Classes
    LocalTime → AnyRef → Any
  27. def isAfter(other: LocalTime): Boolean

    Checks if this LocalTime is after the specified time.

    Checks if this LocalTime is after the specified time.

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

    other

    the other time to compare to, not null

    returns

    true if this is after the specified time

    Exceptions thrown

    NullPointerException if { @code other} is null

  28. def isBefore(other: LocalTime): Boolean

    Checks if this LocalTime is before the specified time.

    Checks if this LocalTime is before the specified time.

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

    other

    the other time to compare to, not null

    returns

    true if this point is before the specified time

    Exceptions thrown

    NullPointerException if { @code other} is null

  29. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  30. def isSupported(unit: TemporalUnit): Boolean

    Checks if the specified unit is supported.

    Checks if the specified unit is supported.

    This checks if the date-time can be queried for the specified unit. If false, then calling the plus and minus methods will throw an exception.

    Specification for implementors

    Implementations must check and handle all fields defined in ChronoUnit. If the field is supported, then true is returned, otherwise false

    If the field is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.isSupportedBy(Temporal) passing this as the argument.

    Implementations must not alter this object.

    unit

    the unit to check, null returns false

    returns

    true if this date-time can be queried for the unit, false if not

    Definition Classes
    LocalTime → Temporal
  31. def isSupported(field: TemporalField): Boolean

    Checks if the specified field is supported.

    Checks if the specified field is supported.

    This checks if this time 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 are:

    • NANO_OF_SECOND
    • NANO_OF_DAY
    • MICRO_OF_SECOND
    • MICRO_OF_DAY
    • MILLI_OF_SECOND
    • MILLI_OF_DAY
    • SECOND_OF_MINUTE
    • SECOND_OF_DAY
    • MINUTE_OF_HOUR
    • MINUTE_OF_DAY
    • HOUR_OF_AMPM
    • CLOCK_HOUR_OF_AMPM
    • HOUR_OF_DAY
    • CLOCK_HOUR_OF_DAY
    • AMPM_OF_DAY

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

    Definition Classes
    LocalTime → TemporalAccessor
  32. def minus(amountToSubtract: Long, unit: TemporalUnit): LocalTime

    Returns a copy of this time with the specified period subtracted.

    Returns a copy of this time with the specified period subtracted.

    This method returns a new time based on this time with the specified period subtracted. This can be used to subtract any period that is defined by a unit, for example to subtract hours, minutes or seconds. The unit is responsible for the details of the calculation, including the resolution of any edge cases in the calculation.

    This instance is immutable and unaffected by this method call.

    amountToSubtract

    the amount of the unit to subtract from the result, may be negative

    unit

    the unit of the period to subtract, not null

    returns

    a { @code LocalTime} based on this time with the specified period subtracted, not null

    Definition Classes
    LocalTime → Temporal
    Exceptions thrown

    DateTimeException if the unit cannot be added to this type

  33. def minus(amount: TemporalAmount): LocalTime

    Returns a copy of this time with the specified period subtracted.

    Returns a copy of this time with the specified period subtracted.

    This method returns a new time based on this time with the specified period subtracted. The amount is typically Period but may be any other type implementing the TemporalAmount interface. The calculation is delegated to the specified adjuster, which typically calls back to TemporalUnit).

    This instance is immutable and unaffected by this method call.

    amount

    the amount to subtract, not null

    returns

    a { @code LocalTime} based on this time with the subtraction made, not null

    Definition Classes
    LocalTime → Temporal
    Exceptions thrown

    ArithmeticException if numeric overflow occurs

    DateTimeException if the subtraction cannot be made

  34. def minusHours(hoursToSubtract: Long): LocalTime

    Returns a copy of this LocalTime with the specified period in hours subtracted.

    Returns a copy of this LocalTime with the specified period in hours subtracted.

    This subtracts the specified number of hours from this time, returning a new time. The calculation wraps around midnight.

    This instance is immutable and unaffected by this method call.

    hoursToSubtract

    the hours to subtract, may be negative

    returns

    a { @code LocalTime} based on this time with the hours subtracted, not null

  35. def minusMinutes(minutesToSubtract: Long): LocalTime

    Returns a copy of this LocalTime with the specified period in minutes subtracted.

    Returns a copy of this LocalTime with the specified period in minutes subtracted.

    This subtracts the specified number of minutes from this time, returning a new time. The calculation wraps around midnight.

    This instance is immutable and unaffected by this method call.

    minutesToSubtract

    the minutes to subtract, may be negative

    returns

    a { @code LocalTime} based on this time with the minutes subtracted, not null

  36. def minusNanos(nanosToSubtract: Long): LocalTime

    Returns a copy of this LocalTime with the specified period in nanoseconds subtracted.

    Returns a copy of this LocalTime with the specified period in nanoseconds subtracted.

    This subtracts the specified number of nanoseconds from this time, returning a new time. The calculation wraps around midnight.

    This instance is immutable and unaffected by this method call.

    nanosToSubtract

    the nanos to subtract, may be negative

    returns

    a { @code LocalTime} based on this time with the nanoseconds subtracted, not null

  37. def minusSeconds(secondsToSubtract: Long): LocalTime

    Returns a copy of this LocalTime with the specified period in seconds subtracted.

    Returns a copy of this LocalTime with the specified period in seconds subtracted.

    This subtracts the specified number of seconds from this time, returning a new time. The calculation wraps around midnight.

    This instance is immutable and unaffected by this method call.

    secondsToSubtract

    the seconds to subtract, may be negative

    returns

    a { @code LocalTime} based on this time with the seconds subtracted, not null

  38. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. final def notify(): Unit
    Definition Classes
    AnyRef
  40. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  41. def plus(amountToAdd: Long, unit: TemporalUnit): LocalTime

    Returns a copy of this time with the specified period added.

    Returns a copy of this time with the specified period added.

    This method returns a new time based on this time with the specified period added. This can be used to add any period that is defined by a unit, for example to add hours, minutes or seconds. The unit is responsible for the details of the calculation, including the resolution of any edge cases in the calculation.

    This instance is immutable and unaffected by this method call.

    amountToAdd

    the amount of the unit to add to the result, may be negative

    unit

    the unit of the period to add, not null

    returns

    a { @code LocalTime} based on this time with the specified period added, not null

    Definition Classes
    LocalTime → Temporal
    Exceptions thrown

    DateTimeException if the unit cannot be added to this type

  42. def plus(amount: TemporalAmount): LocalTime

    Returns a copy of this date with the specified period added.

    Returns a copy of this date with the specified period added.

    This method returns a new time based on this time with the specified period added. The amount is typically Period but may be any other type implementing the TemporalAmount interface. The calculation is delegated to the specified adjuster, which typically calls back to TemporalUnit).

    This instance is immutable and unaffected by this method call.

    amount

    the amount to add, not null

    returns

    a { @code LocalTime} based on this time with the addition made, not null

    Definition Classes
    LocalTime → Temporal
    Exceptions thrown

    ArithmeticException if numeric overflow occurs

    DateTimeException if the addition cannot be made

  43. def plusHours(hoursToAdd: Long): LocalTime

    Returns a copy of this LocalTime with the specified period in hours added.

    Returns a copy of this LocalTime with the specified period in hours added.

    This adds the specified number of hours to this time, returning a new time. The calculation wraps around midnight.

    This instance is immutable and unaffected by this method call.

    hoursToAdd

    the hours to add, may be negative

    returns

    a { @code LocalTime} based on this time with the hours added, not null

  44. def plusMinutes(minutesToAdd: Long): LocalTime

    Returns a copy of this LocalTime with the specified period in minutes added.

    Returns a copy of this LocalTime with the specified period in minutes added.

    This adds the specified number of minutes to this time, returning a new time. The calculation wraps around midnight.

    This instance is immutable and unaffected by this method call.

    minutesToAdd

    the minutes to add, may be negative

    returns

    a { @code LocalTime} based on this time with the minutes added, not null

  45. def plusNanos(nanosToAdd: Long): LocalTime

    Returns a copy of this LocalTime with the specified period in nanoseconds added.

    Returns a copy of this LocalTime with the specified period in nanoseconds added.

    This adds the specified number of nanoseconds to this time, returning a new time. The calculation wraps around midnight.

    This instance is immutable and unaffected by this method call.

    nanosToAdd

    the nanos to add, may be negative

    returns

    a { @code LocalTime} based on this time with the nanoseconds added, not null

  46. def plusSeconds(secondstoAdd: Long): LocalTime

    Returns a copy of this LocalTime with the specified period in seconds added.

    Returns a copy of this LocalTime with the specified period in seconds added.

    This adds the specified number of seconds to this time, returning a new time. The calculation wraps around midnight.

    This instance is immutable and unaffected by this method call.

    secondstoAdd

    the seconds to add, may be negative

    returns

    a { @code LocalTime} based on this time with the seconds added, not null

  47. def query[R >: Null](query: TemporalQuery[R]): R

    Queries this time using the specified query.

    Queries this time using the specified query.

    This queries this time 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
    LocalTime → TemporalAccessor
    Exceptions thrown

    ArithmeticException if numeric overflow occurs (defined by the query)

    DateTimeException if unable to query (defined by the query)

  48. 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 time 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
    LocalTime → TemporalAccessor
    Exceptions thrown

    DateTimeException if the range for the field cannot be obtained

  49. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  50. def toNanoOfDay: Long

    Extracts the time as nanos of day, from 0 to 24 * 60 * 60 * 1,000,000,000 - 1.

    Extracts the time as nanos of day, from 0 to 24 * 60 * 60 * 1,000,000,000 - 1.

    returns

    the nano of day equivalent to this time

  51. def toSecondOfDay: Int

    Extracts the time as seconds of day, from 0 to 24 * 60 * 60 - 1.

    Extracts the time as seconds of day, from 0 to 24 * 60 * 60 - 1.

    returns

    the second-of-day equivalent to this time

  52. def toString(): String

    Outputs this time as a String, such as 10:15.

    Outputs this time as a String, such as 10:15.

    The output will be one of the following ISO-8601 formats:

    • HH:mm
    • HH:mm:ss
    • HH:mm:ss.SSS
    • HH:mm:ss.SSSSSS
    • HH:mm:ss.SSSSSSSSS

    The format used will be the shortest that outputs the full value of the time where the omitted parts are implied to be zero.

    returns

    a string representation of this time, not null

    Definition Classes
    LocalTime → AnyRef → Any
  53. def truncatedTo(unit: TemporalUnit): LocalTime

    Returns a copy of this LocalTime with the time truncated.

    Returns a copy of this LocalTime with the time truncated.

    Truncating the time returns a copy of the original time with fields smaller than the specified unit set to zero. For example, truncating with the minutes unit will set the second-of-minute and nano-of-second field to zero.

    The unit must have a duration that divides into the length of a standard day without remainder. This includes all supplied time units on ChronoUnit and DAYS. Other units throw an exception.

    This instance is immutable and unaffected by this method call.

    unit

    the unit to truncate to, not null

    returns

    a { @code LocalTime} based on this time with the time truncated, not null

    Exceptions thrown

    DateTimeException if unable to truncate

  54. def until(endExclusive: Temporal, unit: TemporalUnit): Long

    Calculates the period between this time and another time in terms of the specified unit.

    Calculates the period between this time and another time in terms of the specified unit.

    This calculates the period between two times in terms of a single unit. The start and end points are this and the specified time. The result will be negative if the end is before the start. The Temporal passed to this method must be a LocalTime. For example, the period in hours between two times can be calculated using startTime.until(endTime, HOURS).

    The calculation returns a whole number, representing the number of complete units between the two times. For example, the period in hours between 11:30 and 13:29 will only be one hour as it is one minute short of two hours.

    This method operates in association with TemporalUnit#between. The result of this method is a long representing the amount of the specified unit. By contrast, the result of between is an object that can be used directly in addition/subtraction: 

    long period = start.until(end, HOURS);   // this method
dateTime.plus(HOURS.between(start, end));      // use in plus/minus

    The calculation is implemented in this method for ChronoUnit. The units NANOS, MICROS, MILLIS, SECONDS, MINUTES, HOURS and HALF_DAYS are supported. Other ChronoUnit values will throw an exception.

    If the unit is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.between(Temporal, Temporal) passing this as the first argument and the input temporal as the second argument.

    This instance is immutable and unaffected by this method call.

    endExclusive

    the end time, which is converted to a { @code LocalTime}, not null

    unit

    the unit to measure the period in, not null

    returns

    the amount of the period between this time and the end time

    Definition Classes
    LocalTime → Temporal
    Exceptions thrown

    ArithmeticException if numeric overflow occurs

    DateTimeException if the period cannot be calculated

  55. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  56. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  57. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  58. def with(field: TemporalField, newValue: Long): LocalTime

    Returns a copy of this time with the specified field set to a new value.

    Returns a copy of this time with the specified field set to a new value.

    This returns a new LocalTime, based on this one, with the value for the specified field changed. This can be used to change any supported field, such as the hour, minute or second. If it is not possible to set 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 adjustment is implemented here. The supported fields behave as follows:

    • NANO_OF_SECOND - Returns a LocalTime with the specified nano-of-second. The hour, minute and second will be unchanged.
    • NANO_OF_DAY - Returns a LocalTime with the specified nano-of-day. This completely replaces the time and is equivalent to #ofNanoOfDay(long).
    • MICRO_OF_SECOND - Returns a LocalTime with the nano-of-second replaced by the specified micro-of-second multiplied by 1,000. The hour, minute and second will be unchanged.
    • MICRO_OF_DAY - Returns a LocalTime with the specified micro-of-day. This completely replaces the time and is equivalent to using #ofNanoOfDay(long) with the micro-of-day multiplied by 1,000.
    • MILLI_OF_SECOND - Returns a LocalTime with the nano-of-second replaced by the specified milli-of-second multiplied by 1,000,000. The hour, minute and second will be unchanged.
    • MILLI_OF_DAY - Returns a LocalTime with the specified milli-of-day. This completely replaces the time and is equivalent to using #ofNanoOfDay(long) with the milli-of-day multiplied by 1,000,000.
    • SECOND_OF_MINUTE - Returns a LocalTime with the specified second-of-minute. The hour, minute and nano-of-second will be unchanged.
    • SECOND_OF_DAY - Returns a LocalTime with the specified second-of-day. The nano-of-second will be unchanged.
    • MINUTE_OF_HOUR - Returns a LocalTime with the specified minute-of-hour. The hour, second-of-minute and nano-of-second will be unchanged.
    • MINUTE_OF_DAY - Returns a LocalTime with the specified minute-of-day. The second-of-minute and nano-of-second will be unchanged.
    • HOUR_OF_AMPM - Returns a LocalTime with the specified hour-of-am-pm. The AM/PM, minute-of-hour, second-of-minute and nano-of-second will be unchanged.
    • CLOCK_HOUR_OF_AMPM - Returns a LocalTime with the specified clock-hour-of-am-pm. The AM/PM, minute-of-hour, second-of-minute and nano-of-second will be unchanged.
    • HOUR_OF_DAY - Returns a LocalTime with the specified hour-of-day. The minute-of-hour, second-of-minute and nano-of-second will be unchanged.
    • CLOCK_HOUR_OF_DAY - Returns a LocalTime with the specified clock-hour-of-day. The minute-of-hour, second-of-minute and nano-of-second will be unchanged.
    • AMPM_OF_DAY - Returns a LocalTime with the specified AM/PM. The hour-of-am-pm, minute-of-hour, second-of-minute and nano-of-second will be unchanged.

    In all cases, if the new value is outside the valid range of values for the field then a DateTimeException will be thrown.

    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.adjustInto(Temporal, long) passing this as the argument. In this case, the field determines whether and how to adjust the instant.

    This instance is immutable and unaffected by this method call.

    field

    the field to set in the result, not null

    newValue

    the new value of the field in the result

    returns

    a { @code LocalTime} based on { @code this} with the specified field set, not null

    Definition Classes
    LocalTime → Temporal
    Exceptions thrown

    ArithmeticException if numeric overflow occurs

    DateTimeException if the field cannot be set

  59. def with(adjuster: TemporalAdjuster): LocalTime

    Returns an adjusted copy of this time.

    Returns an adjusted copy of this time.

    This returns a new LocalTime, based on this one, with the time adjusted. The adjustment takes place using the specified adjuster strategy object. Read the documentation of the adjuster to understand what adjustment will be made.

    A simple adjuster might simply set the one of the fields, such as the hour field. A more complex adjuster might set the time to the last hour of the day.

    The result of this method is obtained by invoking the TemporalAdjuster#adjustInto(Temporal) method on the specified adjuster passing this as the argument.

    This instance is immutable and unaffected by this method call.

    adjuster

    the adjuster to use, not null

    returns

    a { @code LocalTime} based on { @code this} with the adjustment made, not null

    Definition Classes
    LocalTime → Temporal
    Exceptions thrown

    ArithmeticException if numeric overflow occurs

    DateTimeException if the adjustment cannot be made

  60. def withHour(hour: Int): LocalTime

    Returns a copy of this LocalTime with the hour-of-day value altered.

    Returns a copy of this LocalTime with the hour-of-day value altered.

    This instance is immutable and unaffected by this method call.

    hour

    the hour-of-day to set in the result, from 0 to 23

    returns

    a { @code LocalTime} based on this time with the requested hour, not null

    Exceptions thrown

    DateTimeException if the hour value is invalid

  61. def withMinute(minute: Int): LocalTime

    Returns a copy of this LocalTime with the minute-of-hour value altered.

    Returns a copy of this LocalTime with the minute-of-hour value altered.

    This instance is immutable and unaffected by this method call.

    minute

    the minute-of-hour to set in the result, from 0 to 59

    returns

    a { @code LocalTime} based on this time with the requested minute, not null

    Exceptions thrown

    DateTimeException if the minute value is invalid

  62. def withNano(nanoOfSecond: Int): LocalTime

    Returns a copy of this LocalTime with the nano-of-second value altered.

    Returns a copy of this LocalTime with the nano-of-second value altered.

    This instance is immutable and unaffected by this method call.

    nanoOfSecond

    the nano-of-second to set in the result, from 0 to 999,999,999

    returns

    a { @code LocalTime} based on this time with the requested nanosecond, not null

    Exceptions thrown

    DateTimeException if the nanos value is invalid

  63. def withSecond(second: Int): LocalTime

    Returns a copy of this LocalTime with the second-of-minute value altered.

    Returns a copy of this LocalTime with the second-of-minute value altered.

    This instance is immutable and unaffected by this method call.

    second

    the second-of-minute to set in the result, from 0 to 59

    returns

    a { @code LocalTime} based on this time with the requested second, not null

    Exceptions thrown

    DateTimeException if the second value is invalid

Inherited from Serializable

Inherited from Ordered[LocalTime]

Inherited from Comparable[LocalTime]

Inherited from TemporalAdjuster

Inherited from Temporal

Inherited from TemporalAccessor

Inherited from AnyRef

Inherited from Any

Ungrouped