TemporalUnit

A unit of date-time, such as Days or Hours. !(p) Measurement of time is built on units, such as years, months, days, hours, minutes and seconds. Implementations of this interface represent those units. !(p) An instance of this interface represents the unit itself, rather than an amount of the unit. See {@link Period} for a class that represents an amount _in terms of the common units. !(p) The most commonly used units are defined _in {@link ChronoUnit}. Further units are supplied _in {@link IsoFields}. Units can also be written by application code by implementing this interface. !(p) The unit works using double dispatch. Client code calls methods on a date-time like {@code LocalDateTime} which check if the unit is a {@code ChronoUnit}. If it is, then the date-time must handle it. Otherwise, the method call is re-dispatched to the matching method _in this interface.

@implSpec This interface must be implemented with care to ensure other classes operate correctly. All implementations that can be instantiated must be final, immutable and thread-safe. It is recommended to use an enum where possible.

Constructors

this
this(string name, int ordinal)
Undocumented in source.

Members

Functions

addTo
Temporal addTo(Temporal temporal, long amount)

Returns a copy of the specified temporal object with the specified period added. !(p) 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. !(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(long, TemporalUnit)}: !(pre) // these two lines are equivalent, but the second approach is recommended temporal = thisUnit.addTo(temporal); temporal = temporal.plus(thisUnit); </pre> It is recommended to use the second approach, {@code plus(TemporalUnit)}, as it is a lot clearer to read _in code. !(p) Implementations should perform any queries or calculations using the units available _in {@link ChronoUnit} or the fields available _in {@link ChronoField}. If the unit is not supported an {@code UnsupportedTemporalTypeException} must be thrown. !(p) 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.

between
long between(Temporal temporal1Inclusive, Temporal temporal2Exclusive)

Calculates the amount of time between two temporal objects. !(p) 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 {@code HOURS.between(startTime, endTime)}. !(p) The calculation returns a whole number, representing the number of complete units between the two temporals. 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. !(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#until(Temporal, TemporalUnit)}: !(pre) // these two lines are equivalent between = thisUnit.between(start, end); between = start.until(end, thisUnit); </pre> The choice should be made based on which makes the code more readable. !(p) For example, this method allows the number of days between two dates to be calculated: !(pre) long daysBetween = DAYS.between(start, end); // or alternatively long daysBetween = start.until(end, DAYS); </pre> !(p) Implementations should perform any queries or calculations using the units available _in {@link ChronoUnit} or the fields available _in {@link ChronoField}. If the unit is not supported an {@code UnsupportedTemporalTypeException} must be thrown. Implementations must not alter the specified temporal objects.

getDuration
Duration getDuration()

Gets the duration of this unit, which may be an estimate. !(p) All units return a duration measured _in standard nanoseconds from this method. The duration will be positive and non-zero. For example, an hour has a duration of {@code 60 * 60 * 1,000,000,000ns}. !(p) Some units may return an accurate duration while others return an estimate. For example, days have an estimated duration due to the possibility of daylight saving time changes. To determine if the duration is an estimate, use {@link #isDurationEstimated()}.

isDateBased
bool isDateBased()

Checks if this unit represents a component of a date. !(p) A date is time-based if it can be used to imply meaning from a date. It must have a {@linkplain #getDuration() duration} that is an integral multiple of the length of a standard day. Note that it is valid for both {@code isDateBased()} and {@code isTimeBased()} to return false, such as when representing a unit like 36 hours.

isDurationEstimated
bool isDurationEstimated()

Checks if the duration of the unit is an estimate. !(p) All units have a duration, however the duration is not always accurate. For example, days have an estimated duration due to the possibility of daylight saving time changes. This method returns true if the duration is an estimate and false if it is accurate. Note that accurate/estimated ignores leap seconds.

isSupportedBy
bool isSupportedBy(Temporal temporal)

Checks if this unit is supported by the specified temporal object. !(p) This checks that the implementing date-time can add/subtract this unit. This can be used to avoid throwing an exception. !(p) This implementation derives the value using {@link Temporal#plus(long, TemporalUnit)}.

isTimeBased
bool isTimeBased()

Checks if this unit represents a component of a time. !(p) A unit is time-based if it can be used to imply meaning from a time. It must have a {@linkplain #getDuration() duration} that divides into the length of a standard day without remainder. Note that it is valid for both {@code isDateBased()} and {@code isTimeBased()} to return false, such as when representing a unit like 36 hours.

Meta