Class Period

A date-based amount of time in the ISO-8601 calendar system, such as '2 years, 3 months and 4 days'.

See java.time.Period for full documentation

Constructors

constructor

new Period(): Period
Returns Period

Methods

addTo

addTo(temporal: Temporal): Temporal
Adds this period to the specified temporal object.
Parameters
- temporal: Temporal
Returns Temporal
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3242

get

get(unit: TemporalUnit): number
Gets the value of the requested unit.
Parameters
- unit: TemporalUnit
Returns number
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3246

getDays

getDays(): number
Gets the amount of days of this period.

Returns number
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3255

getMonths

getMonths(): number
Gets the amount of months of this period.

Returns number
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3259

getUnits

getUnits(): TemporalUnit[]
Gets the set of units supported by this period.

Returns TemporalUnit[]
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3263

getYears

getYears(): number
Gets the amount of years of this period.

Returns number
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3267

isNegative

isNegative(): boolean
Checks if any of the three units of this period are negative.

Returns boolean
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3271

isZero

isZero(): boolean
Checks if all three units of this period are zero.

Returns boolean
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3275

minus

minus(amountToSubtract: TemporalAmount): Period
Returns a copy of this period with the specified period subtracted.
Parameters
- amountToSubtract: TemporalAmount
Returns Period
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3279

minusDays

minusDays(daysToSubtract: number): Period
Returns a copy of this period with the specified days subtracted.
Parameters
- daysToSubtract: number
Returns Period
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3283

minusMonths

minusMonths(monthsToSubtract: number): Period
Returns a copy of this period with the specified months subtracted.
Parameters
- monthsToSubtract: number
Returns Period
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3287

minusYears

minusYears(yearsToSubtract: number): Period
Returns a copy of this period with the specified years subtracted.
Parameters
- yearsToSubtract: number
Returns Period
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3291

multipliedBy

multipliedBy(scalar: number): Period
Returns a new instance with each element in this period multiplied by the specified scalar.
Parameters
- scalar: number
Returns Period
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3295

negated

negated(): Period
Returns a new instance with each amount in this period negated.

Returns Period
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3299

normalized

normalized(): Period
Returns a copy of this period with the years and months normalized.

Returns Period
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3303

plus

plus(amountToAdd: TemporalAmount): Period
Returns a copy of this period with the specified period added.
Parameters
- amountToAdd: TemporalAmount
Returns Period
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3307

plusDays

plusDays(daysToAdd: number): Period
Returns a copy of this period with the specified days added.
Parameters
- daysToAdd: number
Returns Period
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3311

plusMonths

plusMonths(monthsToAdd: number): Period
Returns a copy of this period with the specified months added.
Parameters
- monthsToAdd: number
Returns Period
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3315

plusYears

plusYears(yearsToAdd: number): Period
Returns a copy of this period with the specified years added.
Parameters
- yearsToAdd: number
Returns Period
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3319

subtractFrom

subtractFrom(temporal: Temporal): Temporal
Subtracts this period from the specified temporal object.
Parameters
- temporal: Temporal
Returns Temporal
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3323

toTotalMonths

toTotalMonths(): number
Gets the total number of months in this period.

Returns number
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3327

withDays

withDays(days: number): Period
Returns a copy of this period with the specified amount of days.
Parameters
- days: number
Returns Period
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3331

withMonths

withMonths(months: number): Period
Returns a copy of this period with the specified amount of months.
Parameters
- months: number
Returns Period
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3335

withYears

withYears(years: number): Period
Returns a copy of this period with the specified amount of years.
Parameters
- years: number
Returns Period
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3339

`Static`between

between(startDateInclusive: LocalDate, endDateExclusive: LocalDate): Period
Obtains a Period consisting of the number of years, months, and days between two dates.
Parameters
- startDateInclusive: LocalDate
- endDateExclusive: LocalDate
Returns Period
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3210

`Static`from

from(amount: TemporalAmount): Period
Obtains an instance of Period from a temporal amount.
Parameters
- amount: TemporalAmount
Returns Period
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3214

`Static`of

of(years: number, months: number, days: number): Period
Obtains a Period representing a number of years, months and days.
Parameters
- years: number
- months: number
- days: number
Returns Period
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3218

`Static`ofDays

ofDays(days: number): Period
Obtains a Period representing a number of days.
Parameters
- days: number
Returns Period
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3222

`Static`ofMonths

ofMonths(months: number): Period
Obtains a Period representing a number of months.
Parameters
- months: number
Returns Period
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3226

`Static`ofWeeks

ofWeeks(weeks: number): Period
Obtains a Period representing a number of weeks.
Parameters
- weeks: number
Returns Period
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3230

`Static`ofYears

ofYears(years: number): Period
Obtains a Period representing a number of years.
Parameters
- years: number
Returns Period
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3234

`Static`parse

parse(text: string): Period
Obtains a Period from a text string such as PnYnMnD.
Parameters
- text: string
Returns Period
- Defined in work/web/web/build/tsdoc/combined/jslib/types/B/Java.d.ts:3238