ChronoPeriod
public
interface
ChronoPeriod
implements
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
|
addTo(Temporal temporal)
Adds this period to the specified temporal object. |
static
ChronoPeriod
|
between(ChronoLocalDate startDateInclusive, ChronoLocalDate endDateExclusive)
Obtains a |
abstract
boolean
|
equals(Object obj)
Checks if this period is equal to another period, including the chronology. |
abstract
long
|
get(TemporalUnit unit)
Gets the value of the requested unit. |
abstract
Chronology
|
getChronology()
Gets the chronology that defines the meaning of the supported units. |
abstract
List<TemporalUnit>
|
getUnits()
Gets the set of units supported by this period. |
abstract
int
|
hashCode()
A hash code for this period. |
default
boolean
|
isNegative()
Checks if any of the supported units of this period are negative. |
default
boolean
|
isZero()
Checks if all the supported units of this period are zero. |
abstract
ChronoPeriod
|
minus(TemporalAmount amountToSubtract)
Returns a copy of this period with the specified period subtracted. |
abstract
ChronoPeriod
|
multipliedBy(int scalar)
Returns a new instance with each amount in this period in this period multiplied by the specified scalar. |
default
ChronoPeriod
|
negated()
Returns a new instance with each amount in this period negated. |
abstract
ChronoPeriod
|
normalized()
Returns a copy of this period with the amounts of each unit normalized. |
abstract
ChronoPeriod
|
plus(TemporalAmount amountToAdd)
Returns a copy of this period with the specified period added. |
abstract
Temporal
|
subtractFrom(Temporal temporal)
Subtracts this period from the specified temporal object. |
abstract
String
|
toString()
Outputs this period as a |
Inherited methods | |
---|---|
Public methods
addTo
public abstract Temporal addTo (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 |
Returns | |
---|---|
Temporal |
an object of the same type with the adjustment made, not null |
Throws | |
---|---|
DateTimeException |
if unable to add |
ArithmeticException |
if numeric overflow occurs |
between
public static ChronoPeriod between (ChronoLocalDate startDateInclusive, ChronoLocalDate endDateExclusive)
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 |
Returns | |
---|---|
ChronoPeriod |
the period between this date and the end date, not null |
See also:
equals
public abstract boolean equals (Object obj)
Checks if this period is equal to another period, including the chronology.
Compares this period with another ensuring that the type, each amount and the chronology are the same. Note that this means that a period of "15 Months" is not equal to a period of "1 Year and 3 Months".
Parameters | |
---|---|
obj |
Object : the object to check, null returns false |
Returns | |
---|---|
boolean |
true if this is equal to the other period |
get
public abstract long get (TemporalUnit unit)
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 |
Returns | |
---|---|
long |
the long value of the unit |
Throws | |
---|---|
DateTimeException |
if the unit is not supported |
UnsupportedTemporalTypeException |
if the unit is not supported |
getChronology
public abstract Chronology getChronology ()
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.
Returns | |
---|---|
Chronology |
the chronology defining the period, not null |
getUnits
public abstract List<TemporalUnit> getUnits ()
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.
Returns | |
---|---|
List<TemporalUnit> |
a list containing the supported units, not null |
hashCode
public abstract int hashCode ()
A hash code for this period.
Returns | |
---|---|
int |
a suitable hash code |
isNegative
public boolean isNegative ()
Checks if any of the supported units of this period are negative.
Returns | |
---|---|
boolean |
true if any unit of this period is negative |
isZero
public boolean isZero ()
Checks if all the supported units of this period are zero.
Returns | |
---|---|
boolean |
true if this period is zero-length |
minus
public abstract ChronoPeriod minus (TemporalAmount amountToSubtract)
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 |
Returns | |
---|---|
ChronoPeriod |
a ChronoPeriod based on this period with the requested period subtracted, not null |
Throws | |
---|---|
ArithmeticException |
if numeric overflow occurs |
multipliedBy
public abstract ChronoPeriod multipliedBy (int scalar)
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 |
Returns | |
---|---|
ChronoPeriod |
a ChronoPeriod based on this period with the amounts multiplied
by the scalar, not null |
Throws | |
---|---|
ArithmeticException |
if numeric overflow occurs |
negated
public ChronoPeriod negated ()
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.
Returns | |
---|---|
ChronoPeriod |
a ChronoPeriod based on this period with the amounts negated, not null |
Throws | |
---|---|
ArithmeticException |
if numeric overflow occurs, which only happens if
one of the units has the value Long.MIN_VALUE |
normalized
public abstract ChronoPeriod normalized ()
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.
Returns | |
---|---|
ChronoPeriod |
a ChronoPeriod based on this period with the amounts of each
unit normalized, not null |
Throws | |
---|---|
ArithmeticException |
if numeric overflow occurs |
plus
public abstract ChronoPeriod plus (TemporalAmount amountToAdd)
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 |
Returns | |
---|---|
ChronoPeriod |
a ChronoPeriod based on this period with the requested period added, not null |
Throws | |
---|---|
ArithmeticException |
if numeric overflow occurs |
subtractFrom
public abstract Temporal subtractFrom (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 |
Returns | |
---|---|
Temporal |
an object of the same type with the adjustment made, not null |
Throws | |
---|---|
DateTimeException |
if unable to subtract |
ArithmeticException |
if numeric overflow occurs |
toString
public abstract String toString ()
Outputs this period as a String
.
The output will include the period amounts and chronology.
Returns | |
---|---|
String |
a string representation of this period, not null |