Obtains a
Duration
representing a number of standard 24 hour days.
The seconds are calculated based on the standard definition of a day, where each day is 86400 seconds which implies a 24 hour day. The nanosecond in second field is set to zero.
days - the number of days, positive or negative
Duration, not null
ArithmeticException - if the input days exceeds the capacity of Duration
Obtains a
Duration
representing a number of standard hours.
The seconds are calculated based on the standard definition of an hour, where each hour is 3600 seconds. The nanosecond in second field is set to zero.
hours - the number of hours, positive or negative
Duration, not null
ArithmeticException - if the input hours exceeds the capacity of Duration
Obtains a
Duration
representing a number of standard minutes.
The seconds are calculated based on the standard definition of a minute, where each minute is 60 seconds. The nanosecond in second field is set to zero.
minutes - the number of minutes, positive or negative
Duration, not null
ArithmeticException - if the input minutes exceeds the capacity of Duration
Obtains a
Duration
representing a number of seconds.
The nanosecond in second field is set to zero.
seconds - the number of seconds, positive or negative
Duration, not null
Obtains a
Duration
representing a number of seconds and an adjustment in nanoseconds.
This method allows an arbitrary number of nanoseconds to be passed in. The factory will alter the values of the second and nanosecond in order to ensure that the stored nanosecond is in the range 0 to 999,999,999. For example, the following will result in exactly the same duration:
Duration.ofSeconds(3, 1); Duration.ofSeconds(4, -999_999_999); Duration.ofSeconds(2, 1000_000_001);
seconds - the number of seconds, positive or negative
nanoAdjustment - the nanosecond adjustment to the number of seconds, positive or negative
Duration, not null
ArithmeticException - if the adjustment causes the seconds to exceed the capacity of Duration
Obtains a
Duration
representing a number of milliseconds.
The seconds and nanoseconds are extracted from the specified milliseconds.
millis - the number of milliseconds, positive or negative
Duration, not null
Obtains a
Duration
representing a number of nanoseconds.
The seconds and nanoseconds are extracted from the specified nanoseconds.
nanos - the number of nanoseconds, positive or negative
Duration, not null
Obtains a
Duration
representing an amount in the specified unit.
The parameters represent the two parts of a phrase like '6 Hours'. For example:
Duration.of(3, SECONDS); Duration.of(465, HOURS);
Only a subset of units are accepted by this method. The unit must either have an
exact durationor be
ChronoUnit.DAYS
which is treated as 24 hours. Other units throw an exception.
amount - the amount of the duration, measured in terms of the unit, positive or negative
unit - the unit that the duration is measured in, must have an exact duration, not null
Duration, not null
DateTimeException - if the period unit has an estimated duration
ArithmeticException - if a numeric overflow occurs
Obtains an instance of
Duration
from a temporal amount.
This obtains a duration based on the specified amount. A TemporalAmount represents an amount of time, which may be date-based or time-based, which this factory extracts to a duration.
The conversion loops around the set of units from the amount and uses the duration of the unit to calculate the total Duration. Only a subset of units are accepted by this method. The unit must either have an exact duration or be ChronoUnit.DAYS which is treated as 24 hours. If any other units are found then an exception is thrown.
amount - the temporal amount to convert, not null
DateTimeException - if unable to convert to a Duration
ArithmeticException - if numeric overflow occurs
Obtains a
Duration
from a text string such as
PnDTnHnMn.nS
.
This will parse a textual representation of a duration, including the string produced by toString(). The formats accepted are based on the ISO-8601 duration format PnDTnHnMn.nS with days considered to be exactly 24 hours.
The string starts with an optional sign, denoted by the ASCII negative or positive symbol. If negative, the whole period is negated. The ASCII letter "P" is next in upper or lower case. There are then four sections, each consisting of a number and a suffix. The sections have suffixes in ASCII of "D", "H", "M" and "S" for days, hours, minutes and seconds, accepted in upper or lower case. The suffixes must occur in order. The ASCII letter "T" must occur before the first occurrence, if any, of an hour, minute or second section. At least one of the four sections must be present, and if "T" is present there must be at least one section after the "T". The number part of each section must consist of one or more ASCII digits. The number may be prefixed by the ASCII negative or positive symbol. The number of days, hours and minutes must parse to a long. The number of seconds must parse to a long with optional fraction. The decimal point may be either a dot or a comma. The fractional part may have from zero to 9 digits.
The leading plus/minus sign, and negative values for other units are not part of the ISO-8601 standard.
Examples:
"PT20.345S" -- parses as "20.345 seconds"
"PT15M" -- parses as "15 minutes" (where a minute is 60 seconds)
"PT10H" -- parses as "10 hours" (where an hour is 3600 seconds)
"P2D" -- parses as "2 days" (where a day is 24 hours or 86400 seconds)
"P2DT3H4M" -- parses as "2 days, 3 hours and 4 minutes"
"PT-6H3M" -- parses as "-6 hours and +3 minutes"
"-PT6H3M" -- parses as "-6 hours and -3 minutes"
"-PT-6H+3M" -- parses as "+6 hours and -3 minutes"
text - the text to parse, not null
DateTimeParseException - if the text cannot be parsed to a duration
Obtains a
Duration
representing the duration between two temporal objects.
This calculates the duration between two temporal objects. If the objects are of different types, then the duration is calculated based on the type of the first object. For example, if the first argument is a LocalTime then the second argument is converted to a LocalTime.
The specified temporal objects must support the SECONDS unit. For full accuracy, either the NANOS unit or the NANO_OF_SECOND field should be supported.
The result of this method can be a negative period if the end is before the start. To guarantee to obtain a positive duration call abs() on the result.
startInclusive - the start instant, inclusive, not null
endExclusive - the end instant, exclusive, not null
Duration, not null
DateTimeException - if the seconds between the temporals cannot be obtained
ArithmeticException - if the calculation exceeds the capacity of Duration
This returns a value for each of the two supported units, SECONDS and NANOS. All other units throw an exception.
get in interface TemporalAmount
unit - the TemporalUnit for which to return the value
DateTimeException - if the unit is not supported
UnsupportedTemporalTypeException - if the unit is not supported
Gets the set of units supported by this duration.
The supported units are SECONDS, and NANOS. They are returned in the order seconds, nanos.
This set can be used in conjunction with get(TemporalUnit) to access the entire state of the duration.
getUnits in interface TemporalAmount
public boolean isPositive()
A Duration represents a directed distance between two points on the time-line and can therefore be positive, zero or negative. This method checks whether the length is greater than zero.
public boolean isZero()
A Duration represents a directed distance between two points on the time-line and can therefore be positive, zero or negative. This method checks whether the length is zero.
public boolean isNegative()
A Duration represents a directed distance between two points on the time-line and can therefore be positive, zero or negative. This method checks whether the length is less than zero.
public long getSeconds()
Gets the number of seconds in this duration.
The length of the duration is stored using two fields - seconds and nanoseconds. The nanoseconds part is a value from 0 to 999,999,999 that is an adjustment to the length in seconds. The total duration is defined by calling this method and getNano().
A Duration represents a directed distance between two points on the time-line. A negative duration is expressed by the negative sign of the seconds part. A duration of -1 nanosecond is stored as -1 seconds plus 999,999,999 nanoseconds.
public int getNano()
Gets the number of nanoseconds within the second in this duration.
The length of the duration is stored using two fields - seconds and nanoseconds. The nanoseconds part is a value from 0 to 999,999,999 that is an adjustment to the length in seconds. The total duration is defined by calling this method and getSeconds().
A Duration represents a directed distance between two points on the time-line. A negative duration is expressed by the negative sign of the seconds part. A duration of -1 nanosecond is stored as -1 seconds plus 999,999,999 nanoseconds.
Returns a copy of this duration with the specified amount of seconds.
This returns a duration with the specified seconds, retaining the nano-of-second part of this duration.
This instance is immutable and unaffected by this method call.
seconds - the seconds to represent, may be negative
Duration based on this period with the requested seconds, not null
Returns a copy of this duration with the specified nano-of-second.
This returns a duration with the specified nano-of-second, retaining the seconds part of this duration.
This instance is immutable and unaffected by this method call.
nanoOfSecond - the nano-of-second to represent, from 0 to 999,999,999
Duration based on this period with the requested nano-of-second, not null
DateTimeException - if the nano-of-second is invalid
This instance is immutable and unaffected by this method call.
duration - the duration to add, positive or negative, not null
Duration based on this duration with the specified duration added, not null
ArithmeticException - if numeric overflow occurs
Returns a copy of this duration with the specified duration added.
The duration amount is measured in terms of the specified unit. Only a subset of units are accepted by this method. The unit must either have an exact duration or be ChronoUnit.DAYS which is treated as 24 hours. Other units throw an exception.
This instance is immutable and unaffected by this method call.
amountToAdd - the amount to add, measured in terms of the unit, positive or negative
unit - the unit that the amount is measured in, must have an exact duration, not null
Duration based on this duration with the specified duration added, not null
UnsupportedTemporalTypeException - if the unit is not supported
ArithmeticException - if numeric overflow occurs
Returns a copy of this duration with the specified duration in standard 24 hour days added.
The number of days is multiplied by 86400 to obtain the number of seconds to add. This is based on the standard definition of a day as 24 hours.
This instance is immutable and unaffected by this method call.
daysToAdd - the days to add, positive or negative
Duration based on this duration with the specified days added, not null
ArithmeticException - if numeric overflow occurs
This instance is immutable and unaffected by this method call.
hoursToAdd - the hours to add, positive or negative
Duration based on this duration with the specified hours added, not null
ArithmeticException - if numeric overflow occurs
This instance is immutable and unaffected by this method call.
minutesToAdd - the minutes to add, positive or negative
Duration based on this duration with the specified minutes added, not null
ArithmeticException - if numeric overflow occurs
This instance is immutable and unaffected by this method call.
secondsToAdd - the seconds to add, positive or negative
Duration based on this duration with the specified seconds added, not null
ArithmeticException - if numeric overflow occurs
This instance is immutable and unaffected by this method call.
millisToAdd - the milliseconds to add, positive or negative
Duration based on this duration with the specified milliseconds added, not null
ArithmeticException - if numeric overflow occurs
This instance is immutable and unaffected by this method call.
nanosToAdd - the nanoseconds to add, positive or negative
Duration based on this duration with the specified nanoseconds added, not null
ArithmeticException - if numeric overflow occurs
This instance is immutable and unaffected by this method call.
duration - the duration to subtract, positive or negative, not null
Duration based on this duration with the specified duration subtracted, not null
ArithmeticException - if numeric overflow occurs
Returns a copy of this duration with the specified duration subtracted.
The duration amount is measured in terms of the specified unit. Only a subset of units are accepted by this method. The unit must either have an exact duration or be ChronoUnit.DAYS which is treated as 24 hours. Other units throw an exception.
This instance is immutable and unaffected by this method call.
amountToSubtract - the amount to subtract, measured in terms of the unit, positive or negative
unit - the unit that the amount is measured in, must have an exact duration, not null
Duration based on this duration with the specified duration subtracted, not null
ArithmeticException - if numeric overflow occurs
Returns a copy of this duration with the specified duration in standard 24 hour days subtracted.
The number of days is multiplied by 86400 to obtain the number of seconds to subtract. This is based on the standard definition of a day as 24 hours.
This instance is immutable and unaffected by this method call.
daysToSubtract - the days to subtract, positive or negative
Duration based on this duration with the specified days subtracted, not null
ArithmeticException - if numeric overflow occurs
Returns a copy of this duration with the specified duration in hours subtracted.
The number of hours is multiplied by 3600 to obtain the number of seconds to subtract.
This instance is immutable and unaffected by this method call.
hoursToSubtract - the hours to subtract, positive or negative
Duration based on this duration with the specified hours subtracted, not null
ArithmeticException - if numeric overflow occurs
Returns a copy of this duration with the specified duration in minutes subtracted.
The number of hours is multiplied by 60 to obtain the number of seconds to subtract.
This instance is immutable and unaffected by this method call.
minutesToSubtract - the minutes to subtract, positive or negative
Duration based on this duration with the specified minutes subtracted, not null
ArithmeticException - if numeric overflow occurs
This instance is immutable and unaffected by this method call.
secondsToSubtract - the seconds to subtract, positive or negative
Duration based on this duration with the specified seconds subtracted, not null
ArithmeticException - if numeric overflow occurs
This instance is immutable and unaffected by this method call.
millisToSubtract - the milliseconds to subtract, positive or negative
Duration based on this duration with the specified milliseconds subtracted, not null
ArithmeticException - if numeric overflow occurs
This instance is immutable and unaffected by this method call.
nanosToSubtract - the nanoseconds to subtract, positive or negative
Duration based on this duration with the specified nanoseconds subtracted, not null
ArithmeticException - if numeric overflow occurs
This instance is immutable and unaffected by this method call.
multiplicand - the value to multiply the duration by, positive or negative
Duration based on this duration multiplied by the specified scalar, not null
ArithmeticException - if numeric overflow occurs
This instance is immutable and unaffected by this method call.
divisor - the value to divide the duration by, positive or negative, not zero
Duration based on this duration divided by the specified divisor, not null
ArithmeticException - if the divisor is zero or if numeric overflow occurs
This instance is immutable and unaffected by this method call.
divisor - the value to divide the duration by, positive or negative, not null
Duration occurs within this Duration, may be negative
ArithmeticException - if the divisor is zero, or if numeric overflow occurs
Returns a copy of this duration with the length negated.
This method swaps the sign of the total length of this duration. For example, PT1.3S will be returned as PT-1.3S.
This instance is immutable and unaffected by this method call.
Duration based on this duration with the amount negated, not null
ArithmeticException - if numeric overflow occurs
Returns a copy of this duration with a positive length.
This method returns a positive duration by effectively removing the sign from any negative total length. For example, PT-1.3S will be returned as PT1.3S.
This instance is immutable and unaffected by this method call.
Duration based on this duration with an absolute length, not null
ArithmeticException - if numeric overflow occurs
Adds this duration to the specified temporal object.
This returns a temporal object of the same observable type as the input with this duration 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 = thisDuration.addTo(dateTime); dateTime = dateTime.plus(thisDuration);
The calculation will add the seconds, then nanos. Only non-zero amounts will be added.
This instance is immutable and unaffected by this method call.
addTo in interface TemporalAmount
temporal - the temporal object to adjust, not null
DateTimeException - if unable to add
ArithmeticException - if numeric overflow occurs
Subtracts this duration from the specified temporal object.
This returns a temporal object of the same observable type as the input with this duration 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 = thisDuration.subtractFrom(dateTime); dateTime = dateTime.minus(thisDuration);
The calculation will subtract the seconds, then nanos. Only non-zero amounts will be added.
This instance is immutable and unaffected by this method call.
subtractFrom in interface TemporalAmount
temporal - the temporal object to adjust, not null
DateTimeException - if unable to subtract
ArithmeticException - if numeric overflow occurs
public long toDays()
Gets the number of days in this duration.
This returns the total number of days in the duration by dividing the number of seconds by 86400. This is based on the standard definition of a day as 24 hours.
This instance is immutable and unaffected by this method call.
public long toHours()
Gets the number of hours in this duration.
This returns the total number of hours in the duration by dividing the number of seconds by 3600.
This instance is immutable and unaffected by this method call.
public long toMinutes()
Gets the number of minutes in this duration.
This returns the total number of minutes in the duration by dividing the number of seconds by 60.
This instance is immutable and unaffected by this method call.
public long toSeconds()
Gets the number of seconds in this duration.
This returns the total number of whole seconds in the duration.
This instance is immutable and unaffected by this method call.
public long toMillis()
Converts this duration to the total length in milliseconds.
If this duration is too large to fit in a long milliseconds, then an exception is thrown.
If this duration has greater than millisecond precision, then the conversion will drop any excess precision information as though the amount in nanoseconds was subject to integer division by one million.
ArithmeticException - if numeric overflow occurs
public long toNanos()
Converts this duration to the total length in nanoseconds expressed as a
long
.
If this duration is too large to fit in a long nanoseconds, then an exception is thrown.
ArithmeticException - if numeric overflow occurs
public long toDaysPart()
Extracts the number of days in the duration.
This returns the total number of days in the duration by dividing the number of seconds by 86400. This is based on the standard definition of a day as 24 hours.
This instance is immutable and unaffected by this method call.
toDays().
public int toHoursPart()
Extracts the number of hours part in the duration.
This returns the number of remaining hours when dividing toHours() by hours in a day. This is based on the standard definition of a day as 24 hours.
This instance is immutable and unaffected by this method call.
public int toMinutesPart()
Extracts the number of minutes part in the duration.
This returns the number of remaining minutes when dividing toMinutes() by minutes in an hour. This is based on the standard definition of an hour as 60 minutes.
This instance is immutable and unaffected by this method call.
public int toSecondsPart()
Extracts the number of seconds part in the duration.
This returns the remaining seconds when dividing toSeconds() by seconds in a minute. This is based on the standard definition of a minute as 60 seconds.
This instance is immutable and unaffected by this method call.
public int toMillisPart()
Extracts the number of milliseconds part of the duration.
This returns the milliseconds part by dividing the number of nanoseconds by 1,000,000. The length of the duration is stored using two fields - seconds and nanoseconds. The nanoseconds part is a value from 0 to 999,999,999 that is an adjustment to the length in seconds. The total duration is defined by calling getNano() and getSeconds().
This instance is immutable and unaffected by this method call.
public int toNanosPart()
Get the nanoseconds part within seconds of the duration.
The length of the duration is stored using two fields - seconds and nanoseconds. The nanoseconds part is a value from 0 to 999,999,999 that is an adjustment to the length in seconds. The total duration is defined by calling getNano() and getSeconds().
This instance is immutable and unaffected by this method call.
Returns a copy of this
Duration
truncated to the specified unit.
Truncating the duration returns a copy of the original with conceptual fields smaller than the specified unit set to zero. For example, truncating with the MINUTES unit will round down towards zero to the nearest minute, setting the seconds and nanoseconds to zero.
The unit must have a duration that divides into the length of a standard day without remainder. This includes all time-based units on ChronoUnit and DAYS. Other ChronoUnits throw an exception.
This instance is immutable and unaffected by this method call.
unit - the unit to truncate to, not null
Duration based on this duration with the time truncated, not null
DateTimeException - if the unit is invalid for truncation
UnsupportedTemporalTypeException - if the unit is not supported
Compares this duration to the specified
Duration
.
The comparison is based on the total length of the durations. It is "consistent with equals", as defined by Comparable.
compareTo in interface Comparable<Duration>
otherDuration - the other duration to compare to, not null
Checks if this duration is equal to the specified
Duration
.
The comparison is based on the total length of the durations.
public int hashCode()
A hash code for this duration.
A string representation of this duration using ISO-8601 seconds based representation, such as
PT8H6M12.345S
.
The format of the returned string will be PTnHnMnS, where n is the relevant hours, minutes or seconds part of the duration. Any fractional seconds are placed after a decimal point in the seconds section. If a section has a zero value, it is omitted. The hours, minutes and seconds will all have the same sign.
Examples:
"20.345 seconds" -- "PT20.345S
"15 minutes" (15 * 60 seconds) -- "PT15M"
"10 hours" (10 * 3600 seconds) -- "PT10H"
"2 days" (2 * 86400 seconds) -- "PT48H"
Note that multiples of 24 hours are not output as days to avoid confusion with
Period
.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4