public final Enum ChronoUnit

Implements java.time.temporal.TemporalUnit.addTo.

Doc from java.time.temporal.TemporalUnit.addTo.

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 Temporal#plus(long, TemporalUnit):

  // these two lines are equivalent, but the second approach is recommended
  temporal = thisUnit.addTo(temporal, amount);
  temporal = temporal.plus(amount, thisUnit);

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 an UnsupportedTemporalTypeException 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.

Annotations

@SuppressWarnings:unchecked

@Override

Implements java.time.temporal.TemporalUnit.between.

Doc from java.time.temporal.TemporalUnit.between.

Calculates the amount of time between two temporal objects.

This calculates the amount in terms of this unit. The start and end points are supplied as temporal objects and must be of compatible types. The implementation will convert the second type to be an instance of the first type before the calculating the amount. The result will be negative if the end is before the start. For example, the amount 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. If there are smaller unit fields, their values are considered when determining the final whole number. For example, the amount in hours between the times 11:30 and 13:29 will only be one hour as it is one minute short of two hours, or the amount in months between the dates 2024-09-29 and 2025-02-28 (the last day in February) will be 4 months as it is one day short of 5 months.

There are two equivalent ways of using this method. The first is to invoke this method directly. The second is to use Temporal#until(Temporal, TemporalUnit):

  // these two lines are equivalent
  between = thisUnit.between(start, end);
  between = start.until(end, thisUnit);

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 an UnsupportedTemporalTypeException must be thrown. Implementations must not alter the specified temporal objects.

Annotations

@Override

Implements java.time.temporal.TemporalUnit.getDuration.

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.

Returns:Duration

the estimated duration of this unit, not null

Annotations

@Override

Implements java.time.temporal.TemporalUnit.isDateBased.

Checks if this unit is a date unit.

All units from days to eras inclusive are date-based. Time-based units and FOREVER return false.

Returns:boolean

true if a date unit, false if a time unit

Annotations

@Override

Implements java.time.temporal.TemporalUnit.isDurationEstimated.

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.

Returns:boolean

true if the duration is estimated, false if accurate

Annotations

@Override

Overrides default java.time.temporal.TemporalUnit.isSupportedBy.

Doc from java.time.temporal.TemporalUnit.isSupportedBy.

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.

This default implementation derives the value using Temporal#plus(long, TemporalUnit).

Annotations

@Override

Implements java.time.temporal.TemporalUnit.isTimeBased.

Checks if this unit is a time unit.

All units from nanos to half-days inclusive are time-based. Date-based units and FOREVER return false.

Returns:boolean

true if a time unit, false if a date unit

Annotations

@Override

Overrides java.lang.Enum.toString.

Implements java.time.temporal.TemporalUnit.toString.

Doc from java.time.temporal.TemporalUnit.toString.

Gets a descriptive name for the unit.

This should be in the plural and upper-first camel case, such as 'Days' or 'Minutes'.

Annotations

@Override