Period

The Period class is designed to represent a time-based duration, typically measured in seconds and nanoseconds. It offers a range of static methods for creating durations based on days, hours, minutes, seconds, milliseconds, and nanoseconds. Additionally, it provides conversion methods to express the duration in various units, as well as the ability to calculate the duration between two temporal objects. This class is ideal for measuring time spans, tracking elapsed time, and performing time-based calculations in applications.

Static Methods

ofDays(days: Integer)

• Obtains a Period representing a number of standard 24-hour days.

• Example Usage:

  var daysPeriod = Period.ofDays(5);

ofMonths(months: Integer)

• Obtains a Periodrepresenting a number of standard months.

• Example Usage:

  var monthsPeriod = Period.ofMonths(12);

ofYears(years: Integer)

• Obtains a Periodrepresenting a number of standard years.

• Example Usage:

  var yearsPeriod = Period.ofYears(30);

ofWeeks(weeks: Long)

• Obtains a Periodrepresenting a number of weeks.

• Example Usage:

  var weeksPeriod = Period.ofWeeks(4);

parse(text: String)

• Obtains a Periodfrom a text string such as P2Y3M4D.

• Parses a textual representation of a period.

• Example Usage:

  var parsedPeriod = Period.parse("P2Y3M4D");

between(startInclusive: LocalDate, endExclusive: LocalDate)

• Obtains a Periodrepresenting the duration between two temporal objects.

• Example Usage:

  var end = LocalDate.now(); // current date-time
  var start = end.minusDays(1); // current date-time minus 1 day
  var duration = Period.between(start, end); // period is 1 day