ChronoPeriod

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.

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.

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".

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.

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.

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.

hashCode

public abstract int hashCode ()

A hash code for this period.

isNegative

public boolean isNegative ()

Checks if any of the supported units of this period are negative.

isZero

public boolean isZero ()

Checks if all the supported units of this period are zero.

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.

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.

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.

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.

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.

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.

toString

public abstract String toString ()

Outputs this period as a String.

The output will include the period amounts and chronology.