public abstract class ChronoPeriod extends java.lang.Object implements TemporalAmount
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.
In JDK 8, this is an interface with default methods. Since there are no default methods in JDK 7, an abstract class is used.
| Constructor and Description |
|---|
ChronoPeriod() |
| Modifier and Type | Method and Description |
|---|---|
abstract Temporal |
addTo(Temporal temporal)
Adds this period to the specified temporal object.
|
static ChronoPeriod |
between(ChronoLocalDate startDateInclusive,
ChronoLocalDate endDateExclusive)
Obtains a
ChronoPeriod consisting of amount of time between two dates. |
abstract boolean |
equals(java.lang.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 java.util.List<TemporalUnit> |
getUnits()
Gets the set of units supported by this period.
|
abstract int |
hashCode()
A hash code for this period.
|
boolean |
isNegative()
Checks if any of the supported units of this period are negative.
|
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.
|
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 java.lang.String |
toString()
Outputs this period as a
String. |
public static ChronoPeriod between(ChronoLocalDate startDateInclusive, ChronoLocalDate endDateExclusive)
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.
startDateInclusive - the start date, inclusive, specifying the chronology of the calculation, not nullendDateExclusive - the end date, exclusive, in any chronology, not nullChronoLocalDate.until(ChronoLocalDate)public abstract long get(TemporalUnit unit)
The supported units are chronology specific.
They will typically be YEARS,
MONTHS and DAYS.
Requesting an unsupported unit will throw an exception.
get in interface TemporalAmountunit - the TemporalUnit for which to return the valueDateTimeException - if the unit is not supportedUnsupportedTemporalTypeException - if the unit is not supportedpublic abstract java.util.List<TemporalUnit> getUnits()
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(TemporalUnit)
to access the entire state of the period.
getUnits in interface TemporalAmountpublic abstract Chronology getChronology()
The period is defined by the chronology.
It controls the supported units and restricts addition/subtraction
to ChronoLocalDate instances of the same chronology.
public boolean isZero()
public boolean isNegative()
public abstract ChronoPeriod plus(TemporalAmount amountToAdd)
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.
amountToAdd - the period to add, not nullChronoPeriod based on this period with the requested period added, not nulljava.lang.ArithmeticException - if numeric overflow occurspublic abstract ChronoPeriod minus(TemporalAmount amountToSubtract)
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.
amountToSubtract - the period to subtract, not nullChronoPeriod based on this period with the requested period subtracted, not nulljava.lang.ArithmeticException - if numeric overflow occurspublic abstract ChronoPeriod multipliedBy(int 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.
scalar - the scalar to multiply by, not nullChronoPeriod based on this period with the amounts multiplied
by the scalar, not nulljava.lang.ArithmeticException - if numeric overflow occurspublic ChronoPeriod 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.
ChronoPeriod based on this period with the amounts negated, not nulljava.lang.ArithmeticException - if numeric overflow occurs, which only happens if
one of the units has the value Long.MIN_VALUEpublic abstract ChronoPeriod 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.
ChronoPeriod based on this period with the amounts of each
unit normalized, not nulljava.lang.ArithmeticException - if numeric overflow occurspublic abstract Temporal addTo(Temporal temporal)
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.
addTo in interface TemporalAmounttemporal - the temporal object to adjust, not nullDateTimeException - if unable to addjava.lang.ArithmeticException - if numeric overflow occurspublic abstract Temporal subtractFrom(Temporal temporal)
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.
subtractFrom in interface TemporalAmounttemporal - the temporal object to adjust, not nullDateTimeException - if unable to subtractjava.lang.ArithmeticException - if numeric overflow occurspublic abstract boolean equals(java.lang.Object obj)
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".
equals in class java.lang.Objectobj - the object to check, null returns falsepublic abstract int hashCode()
hashCode in class java.lang.Objectpublic abstract java.lang.String toString()
String.
The output will include the period amounts and chronology.
toString in class java.lang.ObjectCopyright © 2014. All Rights Reserved.