Duration

Methods
50
Fields
1

Getting one

Duration.ofDays(…)
Duration.ofHours(…)
Duration.ofMinutes(…)

Methods

MethodReturnsDescription
getSeconds()numberWhole seconds (floored: PT-0.5S is -1).
getNano()numberThe nanos within the second, 0 to 999,999,999.
isZero()booleanWhether it is zero long.
isNegative()booleanWhether it is negative.
plus(Duration)Duration(Duration, Duration) -> Duration: This plus duration.
plus(number, ChronoUnit | RSTimeUnit)Duration
minus(Duration)Duration(Duration, Duration) -> Duration: This less duration.
minus(number, ChronoUnit | RSTimeUnit)Duration
plusDays(number)DurationPlus daysToAdd days.
plusHours(number)DurationPlus hoursToAdd hours.
plusMinutes(number)DurationPlus minutesToAdd minutes.
plusSeconds(number)DurationPlus secondsToAdd seconds.
plusMillis(number)DurationPlus millisToAdd ms.
plusNanos(number)DurationPlus nanosToAdd ns.
minusDays(number)DurationLess daysToSubtract days.
minusHours(number)DurationLess hoursToSubtract hours.
minusMinutes(number)DurationLess minutesToSubtract minutes.
minusSeconds(number)DurationLess secondsToSubtract seconds.
minusMillis(number)DurationLess millisToSubtract ms.
minusNanos(number)DurationLess nanosToSubtract ns.
multipliedBy(number)DurationThis × multiplicand.
dividedBy(number)Duration(Duration, number) -> Duration: This ÷ divisor, truncated toward zero.
dividedBy(Duration)number
negated()DurationThis negated.
abs()DurationThis without its sign.
toDays()numberWhole days (getSeconds() / 86400).
toHours()numberWhole hours.
toMinutes()numberWhole minutes.
toSeconds()numberWhole seconds (getSeconds()).
toMillis()numberTotal milliseconds; a negative fraction counts toward zero (PT-0.0005S is 0).
toNanos()numberTotal nanoseconds.
toDaysPart()numberThe days part.
toHoursPart()numberThe hours part, 0 to 23 (negative for a negative duration).
toMinutesPart()numberThe minutes part, 0 to 59.
toSecondsPart()numberThe seconds part, 0 to 59.
toMillisPart()numberThe milliseconds part, 0 to 999.
toNanosPart()numberThe nanoseconds part.
withSeconds(number)DurationThe same nanos with seconds seconds.
withNanos(number)DurationThe same seconds with nanoOfSecond nanos.
truncatedTo(ChronoUnit | RSTimeUnit)DurationTruncated to unit (the unit must divide a day).
compareTo(Duration)numberThe seconds compared, then the nanos subtracted.
equals(any)booleanWhether other is an equal Duration.
hashCode()numberThe value's hash.
toString()stringISO-8601, PT8H6M12.345S.
ofDays(number)Durationdays × 86,400 s.
ofHours(number)Durationhours × 3,600 s.
ofMinutes(number)Durationminutes × 60 s.
ofSeconds(number)Duration(number) -> Duration: seconds s.
ofSeconds(number, number)Duration
ofMillis(number)Durationmillis ms.
ofNanos(number)Durationnanos ns.
of(number, ChronoUnit | RSTimeUnit)Durationamount of unit: a ChronoUnit with an exact duration (or DAYS), or an RSTimeUnit (Duration.of(5, RSTimeUnit.GAME_TICKS) is 3 s).
between(Instant | LocalTime | LocalDate | LocalDateTime | ZonedDateTime, Instant | LocalTime | LocalDate | LocalDateTime | ZonedDateTime)DurationThe duration from startInclusive to endExclusive, negative when the end is earlier: two Instants, two LocalTimes, two `LocalDateTim…
parse(string)DurationISO-8601 PnDTnHnMn.nS, as toString writes it.

Fields

FieldTypeDescription
ZERODurationThe zero duration, PT0S.

Returned by

MethodReturnsDescription
ChronoUnit.getDurationDurationThe unit's duration (estimated from DAYS on: a month is 31,556,952 s / 12).
DurationClass.betweenDurationThe duration from startInclusive to endExclusive, negative when the end is earlier: two Instants, two LocalTimes, two `LocalDateTim…
DurationClass.ofDurationamount of unit: a ChronoUnit with an exact duration (or DAYS), or an RSTimeUnit (Duration.of(5, RSTimeUnit.GAME_TICKS) is 3 s).
DurationClass.ofDaysDurationdays × 86,400 s.
DurationClass.ofHoursDurationhours × 3,600 s.
DurationClass.ofMillisDurationmillis ms.
DurationClass.ofMinutesDurationminutes × 60 s.
DurationClass.ofNanosDurationnanos ns.
DurationClass.ofSecondsDuration(number) -> Duration: seconds s.
DurationClass.parseDurationISO-8601 PnDTnHnMn.nS, as toString writes it.
LoopTimer.getDurationDurationThe period.
Timer.getDurationDurationFrom start to end.

Method details

getNano

getNano: (Duration) -> number

The nanos within the second, 0 to 999,999,999.

dividedBy

dividedBy: ((Duration, number) -> Duration) & ((Duration, Duration) -> number)

(Duration, number) -> Duration: This ÷ divisor, truncated toward zero.

(Duration, Duration) -> number: How many whole divisors fit in this.

toMillis

toMillis: (Duration) -> number

Total milliseconds; a negative fraction counts toward zero (PT-0.0005S is 0).

toHoursPart

toHoursPart: (Duration) -> number

The hours part, 0 to 23 (negative for a negative duration).

equals

equals: (Duration, any) -> boolean

Whether other is an equal Duration.

ofSeconds

ofSeconds: ((number) -> Duration) & ((number, number) -> Duration)

(number) -> Duration: seconds s.

(number, number) -> Duration: seconds s plus nanoAdjustment ns.

of

of: (number, ChronoUnit | RSTimeUnit) -> Duration

amount of unit: a ChronoUnit with an exact duration (or DAYS), or an RSTimeUnit (Duration.of(5, RSTimeUnit.GAME_TICKS) is 3 s).

parse

parse: (string) -> Duration

ISO-8601 PnDTnHnMn.nS, as toString writes it.