Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
public interface ReadableDuration
extends Comparable
null
as a zero length duration.
ReadableInterval
, ReadablePeriod
Method Summary | |
int |
|
boolean |
|
long |
|
int |
|
boolean |
|
boolean |
|
boolean |
|
Duration |
|
Period |
|
String |
|
public int compareTo(Object obj)
Compares this duration with the specified duration based on length.
- Parameters:
obj
- a duration to check against
- Returns:
- negative value if this is less, 0 if equal, or positive value if greater
public boolean equals(Object readableDuration)
Compares this object with the specified object for equality based on the millisecond length. All ReadableDuration instances are accepted.
- Parameters:
readableDuration
- a readable duration to check against
- Returns:
- true if the length of the duration is equal
public long getMillis()
Gets the total length of this duration in milliseconds.
- Returns:
- the total length of the time duration in milliseconds.
public int hashCode()
Gets a hash code for the duration that is compatable with the equals method. The following formula must be used:long len = getMillis(); return (int) (len ^ (len >>> 32));
- Returns:
- a hash code
public boolean isEqual(ReadableDuration duration)
Is the length of this duration equal to the duration passed in.
- Parameters:
duration
- another duration to compare to, null means zero milliseconds
- Returns:
- true if this duration is equal to than the duration passed in
public boolean isLongerThan(ReadableDuration duration)
Is the length of this duration longer than the duration passed in.
- Parameters:
duration
- another duration to compare to, null means zero milliseconds
- Returns:
- true if this duration is equal to than the duration passed in
public boolean isShorterThan(ReadableDuration duration)
Is the length of this duration shorter than the duration passed in.
- Parameters:
duration
- another duration to compare to, null means zero milliseconds
- Returns:
- true if this duration is equal to than the duration passed in
public Duration toDuration()
Get this duration as an immutableDuration
object. This will either typecast this instance, or create a newDuration
.
- Returns:
- a Duration created using the millisecond duration from this instance
public Period toPeriod()
Converts this duration to a Period instance using the standard period type and the ISO chronology. Only precise fields in the period type will be used. Thus, only the hour, minute, second and millisecond fields on the period will be used. The year, month, week and day fields will not be populated. If the duration is small, less than one day, then this method will perform as you might expect and split the fields evenly. If the duration is larger than one day then all the remaining duration will be stored in the largest available field, hours in this case. For example, a duration effectively equal to (365 + 60 + 5) days will be converted to ((365 + 60 + 5) * 24) hours by this constructor. For more control over the conversion process, you must pair the duration with an instant, seePeriod.Period(ReadableInstant,ReadableDuration)
.
- Returns:
- a Period created using the millisecond duration from this instance
public String toString()
Gets the value as a String in the ISO8601 duration format using hours, minutes and seconds (including fractional milliseconds). For example, "PT6H3M7S" represents 6 hours, 3 minutes, 7 seconds.
- Returns:
- the value as an ISO8601 string