Returns a copy of the specified temporal object with the specified period added.
Returns a copy of the specified temporal object with the specified period added.
The period added is a multiple of this unit. For example, this method could be used to add "3 days" to a date by calling this method on the instance representing "days", passing the date and the period "3". The period to be added may be negative, which is equivalent to subtraction.
There are two equivalent ways of using this method.
The first is to invoke this method directly.
The second is to use TemporalUnit)
:
// these two lines are equivalent, but the second approach is recommended temporal = thisUnit.doPlus(temporal); temporal = temporal.plus(thisUnit);It is recommended to use the second approach,
plus(TemporalUnit)
,
as it is a lot clearer to read in code.Implementations should perform any queries or calculations using the units
available in ChronoUnit
or the fields available in ChronoField
.
If the field is not supported a DateTimeException
must be thrown.
Implementations must not alter the specified temporal object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
the type of the Temporal object
the temporal object to adjust, not null
the period of this unit to add, positive or negative
the adjusted temporal object, not null
DateTimeException
if the period cannot be added
Calculates the period in terms of this unit between two temporal objects of the same type.
Calculates the period in terms of this unit between two temporal objects of the same type.
This calculates the period between two temporals in terms of this unit.
The start and end points are supplied as temporal objects and must be of the same type.
The result will be negative if the end is before the start.
For example, the period in hours between two temporal objects can be calculated
using HOURS.between(startTime, endTime)
.
The calculation returns a whole number, representing the number of complete units between the two temporals. For example, the period in hours between the times 11:30 and 13:29 will only b one hour as it is one minute short of two hours.
There are two equivalent ways of using this method.
The first is to invoke this method directly.
The second is to use TemporalUnit)
:
// these two lines are equivalent between = thisUnit.between(start, end); between = start.until(end, thisUnit);The choice should be made based on which makes the code more readable.
For example, this method allows the number of days between two dates to be calculated:
long daysBetween = DAYS.between(start, end); // or alternatively long daysBetween = start.until(end, DAYS);Implementations should perform any queries or calculations using the units available in
ChronoUnit
or the fields available in ChronoField
.
If the unit is not supported a DateTimeException must be thrown.
Implementations must not alter the specified temporal objects.
the base temporal object, not null
the other temporal object, not null
the period between temporal1 and temporal2 in terms of this unit; positive if temporal2 is later than temporal1, negative if earlier
ArithmeticException
if numeric overflow occurs
DateTimeException
if the period cannot be calculated
Gets the estimated duration of this unit in the ISO calendar system.
Gets the estimated duration of this unit in the ISO calendar system.
All of the units in this class have an estimated duration. Days vary due to daylight saving time, while months have different lengths.
the estimated duration of this unit, not null
Checks if this unit is a date unit.
Checks if this unit is a date unit.
true if a date unit, false if a time unit
Checks if the duration of the unit is an estimate.
Checks if the duration of the unit is an estimate.
All time units in this class are considered to be accurate, while all date units in this class are considered to be estimated.
This definition ignores leap seconds, but considers that Days vary due to daylight saving time and months have different lengths.
true if the duration is estimated, false if accurate
Checks if this unit is supported by the specified temporal object.
Checks if this unit is supported by the specified temporal object.
This checks that the implementing date-time can add/subtract this unit. This can be used to avoid throwing an exception.
the temporal object to check, not null
true if the unit is supported
Checks if this unit is a time unit.
Checks if this unit is a time unit.
true if a time unit, false if a date unit
Outputs this unit as a String
using the name.
Outputs this unit as a String
using the name.
the name of this unit, not null