Class Duration
- All Implemented Interfaces:
Serializable
,Comparable<Duration>
PnDTnHnMnS
, with 'P' and 'T' optional. Days are considered to be exactly 24
hours.
Similarly to the java.time.Duration
class, this class does not support year or month sections in the format.
This implementation does not support fractions or negative values.
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate static final int
Hours per day.private static final int
Minutes per hour.private static final Pattern
The pattern for parsing.private final long
The number of seconds in the duration.private static final int
Seconds per day.private static final int
Seconds per hour.private static final int
Seconds per minute.private static final long
static final Duration
Constant for a duration of zero. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprivate
Duration
(long seconds) Constructs an instance ofDuration
using seconds. -
Method Summary
Modifier and TypeMethodDescriptionint
private static Duration
create
(long seconds) Obtains an instance ofDuration
using seconds.private static Duration
create
(long daysAsSecs, long hoursAsSecs, long minsAsSecs, long secs) boolean
int
hashCode()
static Duration
parse
(CharSequence text) Obtains aDuration
from a text string such asPnDTnHnMnS
.private static long
parseNumber
(CharSequence text, String parsed, int multiplier, String errorText) long
toMillis()
Converts this duration to the total length in milliseconds.toString()
A string representation of this duration using ISO-8601 seconds based representation, such asPT8H6M12S
.
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
ZERO
Constant for a duration of zero. -
HOURS_PER_DAY
private static final int HOURS_PER_DAYHours per day.- See Also:
-
MINUTES_PER_HOUR
private static final int MINUTES_PER_HOURMinutes per hour.- See Also:
-
SECONDS_PER_MINUTE
private static final int SECONDS_PER_MINUTESeconds per minute.- See Also:
-
SECONDS_PER_HOUR
private static final int SECONDS_PER_HOURSeconds per hour.- See Also:
-
SECONDS_PER_DAY
private static final int SECONDS_PER_DAYSeconds per day.- See Also:
-
PATTERN
The pattern for parsing. -
seconds
private final long secondsThe number of seconds in the duration.
-
-
Constructor Details
-
Duration
private Duration(long seconds) Constructs an instance ofDuration
using seconds.- Parameters:
seconds
- the length of the duration in seconds, positive or negative
-
-
Method Details
-
parse
Obtains aDuration
from a text string such asPnDTnHnMnS
.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 formatPnDTnHnMnS
with days considered to be exactly 24 hours.This implementation does not support negative numbers or fractions (so the smallest non-zero value a Duration can have is one second).
The string optionally starts with the ASCII letter "P" 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" may 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 not be prefixed by the ASCII negative or positive symbol. The number of days, hours, minutes and seconds must parse to a
long
.Examples:
"PT20S" -- parses as "20 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"
- Parameters:
text
- the text to parse, not null- Returns:
- the parsed duration, not null
- Throws:
IllegalArgumentException
- if the text cannot be parsed to a duration
-
parseNumber
-
create
-
create
Obtains an instance ofDuration
using seconds.- Parameters:
seconds
- the length of the duration in seconds, positive only
-
toMillis
public long toMillis()Converts this duration to the total length in milliseconds.- Returns:
- the total length of the duration in milliseconds
-
equals
-
hashCode
public int hashCode() -
toString
A string representation of this duration using ISO-8601 seconds based representation, such asPT8H6M12S
.The format of the returned string will be
PnDTnHnMnS
, where n is the relevant days, hours, minutes or seconds part of the duration. If a section has a zero value, it is omitted. The hours, minutes and seconds are all positive.Examples:
"20 seconds" -- "PT20S "15 minutes" (15 * 60 seconds) -- "PT15M" "10 hours" (10 * 3600 seconds) -- "PT10H" "2 days" (2 * 86400 seconds) -- "P2D"
-
compareTo
- Specified by:
compareTo
in interfaceComparable<Duration>
-