Class Duration

A time-based amount of time, such as '34.5 seconds'.

See java.time.Duration for full documentation

Hierarchy

  • Duration

Constructors

constructor

Methods

abs addTo compareTo dividedBy get getNano getSeconds getUnits isNegative isZero minus minusDays minusHours minusMillis minusMinutes minusNanos minusSeconds multipliedBy negated plus plusDays plusHours plusMillis plusMinutes plusNanos plusSeconds subtractFrom toDays toDaysPart toHours toHoursPart toMillis toMillisPart toMinutes toMinutesPart toNanos toNanosPart toSeconds toSecondsPart truncatedTo withNanos withSeconds between from of ofDays ofHours ofMillis ofMinutes ofNanos ofSeconds parse

Constructors

constructor

Methods

abs

  • Returns a copy of this duration with a positive length.

    Returns Duration

addTo

  • Adds this duration to the specified temporal object.

    Parameters

    Returns Temporal

compareTo

  • Compares this duration to the specified Duration.

    Parameters

    Returns number

dividedBy

  • Returns a copy of this duration divided by the specified value.

    Parameters

    • divisor: number

    Returns Duration

  • Returns number of whole times a specified Duration occurs within this Duration.

    Parameters

    Returns number

get

  • Gets the value of the requested unit.

    Parameters

    Returns number

getNano

  • Gets the number of nanoseconds within the second in this duration.

    Returns number

getSeconds

  • Gets the number of seconds in this duration.

    Returns number

getUnits

  • Gets the set of units supported by this duration.

    Returns TemporalUnit[]

isNegative

  • Checks if this duration is negative, excluding zero.

    Returns boolean

isZero

  • Checks if this duration is zero length.

    Returns boolean

minus

  • Returns a copy of this duration with the specified duration subtracted.

    Parameters

    Returns Duration

  • Returns a copy of this duration with the specified duration subtracted.

    Parameters

    Returns Duration

minusDays

  • Returns a copy of this duration with the specified duration in standard 24 hour days subtracted.

    Parameters

    • daysToSubtract: number

    Returns Duration

minusHours

  • Returns a copy of this duration with the specified duration in hours subtracted.

    Parameters

    • hoursToSubtract: number

    Returns Duration

minusMillis

  • Returns a copy of this duration with the specified duration in milliseconds subtracted.

    Parameters

    • millisToSubtract: number

    Returns Duration

minusMinutes

  • Returns a copy of this duration with the specified duration in minutes subtracted.

    Parameters

    • minutesToSubtract: number

    Returns Duration

minusNanos

  • Returns a copy of this duration with the specified duration in nanoseconds subtracted.

    Parameters

    • nanosToSubtract: number

    Returns Duration

minusSeconds

  • Returns a copy of this duration with the specified duration in seconds subtracted.

    Parameters

    • secondsToSubtract: number

    Returns Duration

multipliedBy

  • Returns a copy of this duration multiplied by the scalar.

    Parameters

    • multiplicand: number

    Returns Duration

negated

  • Returns a copy of this duration with the length negated.

    Returns Duration

plus

  • Returns a copy of this duration with the specified duration added.

    Parameters

    Returns Duration

  • Returns a copy of this duration with the specified duration added.

    Parameters

    Returns Duration

plusDays

  • Returns a copy of this duration with the specified duration in standard 24 hour days added.

    Parameters

    • daysToAdd: number

    Returns Duration

plusHours

  • Returns a copy of this duration with the specified duration in hours added.

    Parameters

    • hoursToAdd: number

    Returns Duration

plusMillis

  • Returns a copy of this duration with the specified duration in milliseconds added.

    Parameters

    • millisToAdd: number

    Returns Duration

plusMinutes

  • Returns a copy of this duration with the specified duration in minutes added.

    Parameters

    • minutesToAdd: number

    Returns Duration

plusNanos

  • Returns a copy of this duration with the specified duration in nanoseconds added.

    Parameters

    • nanosToAdd: number

    Returns Duration

plusSeconds

  • Returns a copy of this duration with the specified duration in seconds added.

    Parameters

    • secondsToAdd: number

    Returns Duration

subtractFrom

  • Subtracts this duration from the specified temporal object.

    Parameters

    Returns Temporal

toDays

  • Gets the number of days in this duration.

    Returns number

toDaysPart

  • Extracts the number of days in the duration.

    Returns number

toHours

  • Gets the number of hours in this duration.

    Returns number

toHoursPart

  • Extracts the number of hours part in the duration.

    Returns number

toMillis

  • Converts this duration to the total length in milliseconds.

    Returns number

toMillisPart

  • Extracts the number of milliseconds part of the duration.

    Returns number

toMinutes

  • Gets the number of minutes in this duration.

    Returns number

toMinutesPart

  • Extracts the number of minutes part in the duration.

    Returns number

toNanos

  • Converts this duration to the total length in nanoseconds expressed as a long.

    Returns number

toNanosPart

  • Get the nanoseconds part within seconds of the duration.

    Returns number

toSeconds

  • Gets the number of seconds in this duration.

    Returns number

toSecondsPart

  • Extracts the number of seconds part in the duration.

    Returns number

truncatedTo

  • Returns a copy of this Duration truncated to the specified unit.

    Parameters

    Returns Duration

withNanos

  • Returns a copy of this duration with the specified nano-of-second.

    Parameters

    • nanoOfSecond: number

    Returns Duration

withSeconds

  • Returns a copy of this duration with the specified amount of seconds.

    Parameters

    • seconds: number

    Returns Duration

Static between

  • Obtains a Duration representing the duration between two temporal objects.

    Parameters

    Returns Duration

Static from

  • Obtains an instance of Duration from a temporal amount.

    Parameters

    Returns Duration

Static of

  • Obtains a Duration representing an amount in the specified unit.

    Parameters

    Returns Duration

Static ofDays

  • Obtains a Duration representing a number of standard 24 hour days.

    Parameters

    • days: number

    Returns Duration

Static ofHours

  • Obtains a Duration representing a number of standard hours.

    Parameters

    • hours: number

    Returns Duration

Static ofMillis

  • Obtains a Duration representing a number of milliseconds.

    Parameters

    • millis: number

    Returns Duration

Static ofMinutes

  • Obtains a Duration representing a number of standard minutes.

    Parameters

    • minutes: number

    Returns Duration

Static ofNanos

  • Obtains a Duration representing a number of nanoseconds.

    Parameters

    • nanos: number

    Returns Duration

Static ofSeconds

  • Obtains a Duration representing a number of seconds.

    Parameters

    • seconds: number

    Returns Duration

  • Obtains a Duration representing a number of seconds and an adjustment in nanoseconds.

    Parameters

    • seconds: number
    • nanoAdjustment: number

    Returns Duration

Static parse

  • Obtains a Duration from a text string such as PnDTnHnMn.nS.

    Parameters

    • text: string

    Returns Duration

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc