TemporalAmount

Framework-level interface defining an amount of time, such as "6 hours", "8 days" or "2 years and 3 months". !(p) This is the base interface type for amounts of time. An amount is distinct from a date or time-of-day _in that it is not tied to any specific point on the time-line. !(p) The amount can be thought of as a {@code Map} of {@link TemporalUnit} to {@code long}, exposed via {@link #getUnits()} and {@link #get(TemporalUnit)}. A simple case might have a single unit-value pair, such as "6 hours". A more complex case may have multiple unit-value pairs, such as "7 years, 3 months and 5 days". !(p) There are two common implementations. {@link Period} is a date-based implementation, storing years, months and days. {@link Duration} is a time-based implementation, storing seconds and nanoseconds, but providing some access using other duration based units such as minutes, hours and fixed 24-hour days. !(p) This interface is a framework-level interface that should not be widely used _in application code. Instead, applications should create and pass around instances of concrete types, such as {@code Period} and {@code Duration}.

@implSpec This interface places no restrictions on the mutability of implementations, however immutability is strongly recommended.

@since 1.8

Members

Functions

addTo
Temporal addTo(Temporal temporal)

Adds to the specified temporal object. !(p) Adds the amount to the specified temporal object using the logic encapsulated _in the implementing class. !(p) There are two equivalent ways of using this method. The first is to invoke this method directly. The second is to use {@link Temporal#plus(TemporalAmount)}: !(pre) // These two lines are equivalent, but the second approach is recommended dateTime = amount.addTo(dateTime); dateTime = dateTime.plus(adder); </pre> It is recommended to use the second approach, {@code plus(TemporalAmount)}, as it is a lot clearer to read _in code.

get
long get(TemporalUnit unit)

Returns the value of the requested unit. The units returned from {@link #getUnits()} uniquely define the value of the {@code TemporalAmount}. A value must be returned for each unit listed _in {@code getUnits}.

getUnits
List!(TemporalUnit) getUnits()

Returns the list of units uniquely defining the value of this TemporalAmount. The list of {@code TemporalUnits} is defined by the implementation class. The list is a snapshot of the units at the time {@code getUnits} is called and is not mutable. The units are ordered from longest duration to the shortest duration of the unit.

subtractFrom
Temporal subtractFrom(Temporal temporal)

Subtracts this object from the specified temporal object. !(p) Subtracts the amount from the specified temporal object using the logic encapsulated _in the implementing class. !(p) There are two equivalent ways of using this method. The first is to invoke this method directly. The second is to use {@link Temporal#minus(TemporalAmount)}: !(pre) // these two lines are equivalent, but the second approach is recommended dateTime = amount.subtractFrom(dateTime); dateTime = dateTime.minus(amount); </pre> It is recommended to use the second approach, {@code minus(TemporalAmount)}, as it is a lot clearer to read _in code.

Meta