ChronoPeriod
interface ChronoPeriod : TemporalAmount
| java.time.chrono.ChronoPeriod |
A date-based amount of time, such as '3 years, 4 months and 5 days' in an arbitrary chronology, intended for advanced globalization use cases.
This interface models a date-based amount of time in a calendar system. While most calendar systems use years, months and days, some do not. Therefore, this interface operates solely in terms of a set of supported units that are defined by the Chronology. The set of supported units is fixed for a given chronology. The amount of a supported unit may be set to zero.
The period is modeled as a directed amount of time, meaning that individual parts of the period may be negative.
Summary
| Public methods | |
|---|---|
| abstract Temporal! |
Adds this period to the specified temporal object. |
| open static ChronoPeriod! |
between(startDateInclusive: ChronoLocalDate!, endDateExclusive: ChronoLocalDate!)Obtains a |
| abstract Long |
get(unit: TemporalUnit!)Gets the value of the requested unit. |
| abstract Chronology! |
Gets the chronology that defines the meaning of the supported units. |
| abstract MutableList<TemporalUnit!>! |
getUnits()Gets the set of units supported by this period. |
| open Boolean |
Checks if any of the supported units of this period are negative. |
| open Boolean |
isZero()Checks if all the supported units of this period are zero. |
| abstract ChronoPeriod! |
minus(amountToSubtract: TemporalAmount!)Returns a copy of this period with the specified period subtracted. |
| abstract ChronoPeriod! |
multipliedBy(scalar: Int)Returns a new instance with each amount in this period in this period multiplied by the specified scalar. |
| open ChronoPeriod! |
negated()Returns a new instance with each amount in this period negated. |
| abstract ChronoPeriod! |
Returns a copy of this period with the amounts of each unit normalized. |
| abstract ChronoPeriod! |
plus(amountToAdd: TemporalAmount!)Returns a copy of this period with the specified period added. |
| abstract Temporal! |
subtractFrom(temporal: Temporal!)Subtracts this period from the specified temporal object. |
Public methods
addTo
abstract fun addTo(temporal: Temporal!): Temporal!
Adds this period to the specified temporal object.
This returns a temporal object of the same observable type as the input with this period added.
In most cases, it is clearer to reverse the calling pattern by using Temporal.plus(TemporalAmount).
// these two lines are equivalent, but the second approach is recommended dateTime = thisPeriod.addTo(dateTime); dateTime = dateTime.plus(thisPeriod);
The specified temporal must have the same chronology as this period. This returns a temporal with the non-zero supported units added.
This instance is immutable and unaffected by this method call.
| Parameters | |
|---|---|
temporal |
Temporal!: the temporal object to adjust, not null |
| Return | |
|---|---|
Temporal! |
an object of the same type with the adjustment made, not null |
| Exceptions | |
|---|---|
java.time.DateTimeException |
if unable to add |
java.lang.ArithmeticException |
if numeric overflow occurs |
between
open static fun between(
startDateInclusive: ChronoLocalDate!,
endDateExclusive: ChronoLocalDate!
): ChronoPeriod!
Obtains a ChronoPeriod consisting of amount of time between two dates.
The start date is included, but the end date is not. The period is calculated using ChronoLocalDate.until(ChronoLocalDate). As such, the calculation is chronology specific.
The chronology of the first date is used. The chronology of the second date is ignored, with the date being converted to the target chronology system before the calculation starts.
The result of this method can be a negative period if the end is before the start. In most cases, the positive/negative sign will be the same in each of the supported fields.
| Parameters | |
|---|---|
startDateInclusive |
ChronoLocalDate!: the start date, inclusive, specifying the chronology of the calculation, not null |
endDateExclusive |
ChronoLocalDate!: the end date, exclusive, in any chronology, not null |
| Return | |
|---|---|
ChronoPeriod! |
the period between this date and the end date, not null |
get
abstract fun get(unit: TemporalUnit!): Long
Gets the value of the requested unit.
The supported units are chronology specific. They will typically be YEARS, MONTHS and DAYS. Requesting an unsupported unit will throw an exception.
| Parameters | |
|---|---|
unit |
TemporalUnit!: the TemporalUnit for which to return the value |
| Return | |
|---|---|
Long |
the long value of the unit |
| Exceptions | |
|---|---|
java.time.DateTimeException |
if the unit is not supported |
java.time.temporal.UnsupportedTemporalTypeException |
if the unit is not supported |
getChronology
abstract fun getChronology(): Chronology!
Gets the chronology that defines the meaning of the supported units.
The period is defined by the chronology. It controls the supported units and restricts addition/subtraction to ChronoLocalDate instances of the same chronology.
| Return | |
|---|---|
Chronology! |
the chronology defining the period, not null |
getUnits
abstract fun getUnits(): MutableList<TemporalUnit!>!
Gets the set of units supported by this period.
The supported units are chronology specific. They will typically be YEARS, MONTHS and DAYS. They are returned in order from largest to smallest.
This set can be used in conjunction with get(java.time.temporal.TemporalUnit) to access the entire state of the period.
| Return | |
|---|---|
MutableList<TemporalUnit!>! |
a list containing the supported units, not null |
isNegative
open fun isNegative(): Boolean
Checks if any of the supported units of this period are negative.
| Return | |
|---|---|
Boolean |
true if any unit of this period is negative |
isZero
open fun isZero(): Boolean
Checks if all the supported units of this period are zero.
| Return | |
|---|---|
Boolean |
true if this period is zero-length |
minus
abstract fun minus(amountToSubtract: TemporalAmount!): ChronoPeriod!
Returns a copy of this period with the specified period subtracted.
If the specified amount is a ChronoPeriod then it must have the same chronology as this period. Implementations may choose to accept or reject other TemporalAmount implementations.
This instance is immutable and unaffected by this method call.
| Parameters | |
|---|---|
amountToSubtract |
TemporalAmount!: the period to subtract, not null |
| Return | |
|---|---|
ChronoPeriod! |
a ChronoPeriod based on this period with the requested period subtracted, not null |
| Exceptions | |
|---|---|
java.lang.ArithmeticException |
if numeric overflow occurs |
multipliedBy
abstract fun multipliedBy(scalar: Int): ChronoPeriod!
Returns a new instance with each amount in this period in this period multiplied by the specified scalar.
This returns a period with each supported unit individually multiplied. For example, a period of "2 years, -3 months and 4 days" multiplied by 3 will return "6 years, -9 months and 12 days". No normalization is performed.
| Parameters | |
|---|---|
scalar |
Int: the scalar to multiply by, not null |
| Return | |
|---|---|
ChronoPeriod! |
a ChronoPeriod based on this period with the amounts multiplied by the scalar, not null |
| Exceptions | |
|---|---|
java.lang.ArithmeticException |
if numeric overflow occurs |
negated
open fun negated(): ChronoPeriod!
Returns a new instance with each amount in this period negated.
This returns a period with each supported unit individually negated. For example, a period of "2 years, -3 months and 4 days" will be negated to "-2 years, 3 months and -4 days". No normalization is performed.
| Return | |
|---|---|
ChronoPeriod! |
a ChronoPeriod based on this period with the amounts negated, not null |
| Exceptions | |
|---|---|
java.lang.ArithmeticException |
if numeric overflow occurs, which only happens if one of the units has the value Long.MIN_VALUE |
normalized
abstract fun normalized(): ChronoPeriod!
Returns a copy of this period with the amounts of each unit normalized.
The process of normalization is specific to each calendar system. For example, in the ISO calendar system, the years and months are normalized but the days are not, such that "15 months" would be normalized to "1 year and 3 months".
This instance is immutable and unaffected by this method call.
| Return | |
|---|---|
ChronoPeriod! |
a ChronoPeriod based on this period with the amounts of each unit normalized, not null |
| Exceptions | |
|---|---|
java.lang.ArithmeticException |
if numeric overflow occurs |
plus
abstract fun plus(amountToAdd: TemporalAmount!): ChronoPeriod!
Returns a copy of this period with the specified period added.
If the specified amount is a ChronoPeriod then it must have the same chronology as this period. Implementations may choose to accept or reject other TemporalAmount implementations.
This instance is immutable and unaffected by this method call.
| Parameters | |
|---|---|
amountToAdd |
TemporalAmount!: the period to add, not null |
| Return | |
|---|---|
ChronoPeriod! |
a ChronoPeriod based on this period with the requested period added, not null |
| Exceptions | |
|---|---|
java.lang.ArithmeticException |
if numeric overflow occurs |
subtractFrom
abstract fun subtractFrom(temporal: Temporal!): Temporal!
Subtracts this period from the specified temporal object.
This returns a temporal object of the same observable type as the input with this period subtracted.
In most cases, it is clearer to reverse the calling pattern by using Temporal.minus(TemporalAmount).
// these two lines are equivalent, but the second approach is recommended dateTime = thisPeriod.subtractFrom(dateTime); dateTime = dateTime.minus(thisPeriod);
The specified temporal must have the same chronology as this period. This returns a temporal with the non-zero supported units subtracted.
This instance is immutable and unaffected by this method call.
| Parameters | |
|---|---|
temporal |
Temporal!: the temporal object to adjust, not null |
| Return | |
|---|---|
Temporal! |
an object of the same type with the adjustment made, not null |
| Exceptions | |
|---|---|
java.time.DateTimeException |
if unable to subtract |
java.lang.ArithmeticException |
if numeric overflow occurs |