Durations

Durations are a special type of string used to represent a period of wall clock time (i.e. days, hours, minutes, seconds, nanoseconds).

Syntax

[-]PnDTnHnMn.nS

  • [-] - An optional sign to indicate that the period is negative. Omitting this makes the period positive.
  • P - The prefix before any given number of days.
  • D - Days
  • T - The prefiex before hours, minutes, seconds, and nanoseconds.
  • n - A numeric value
  • H - Hours
  • M - Minutes
  • S - Seconds

Each #[H|M|S] value translates to a part of the duration. A valid duration string can contain nearly any combination of these values. For example, PT1M1S (1 minute and 1 second), PT2H3M (2 hours and 3 minutes), and -PT24H30M2.4S (negative 24 hours, 30 minutes, and 2.4 seconds) are all valid period strings.

Example

The following example uses parseDuration to convert duration strings to duration objects.

The following example uses plus to add Durations to an Instant.