|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ReadableDuration
Defines an exact duration of time in milliseconds.
The implementation of this interface may be mutable or immutable. This interface only gives access to retrieve data, never to change it.
Methods that are passed a duration as a parameter will treat null
as a zero length duration.
The compareTo
method is no longer defined in this class in version 2.0.
Instead, the definition is simply inherited from the Comparable
interface.
This approach is necessary to preserve binary compatibility.
The definition of the comparison is ascending order by millisecond duration.
Implementors are recommended to extend AbstractInstant
instead of this interface.
ReadableInterval
,
ReadablePeriod
Method Summary | |
---|---|
boolean |
equals(Object readableDuration)
Compares this object with the specified object for equality based on the millisecond length. |
long |
getMillis()
Gets the total length of this duration in milliseconds. |
int |
hashCode()
Gets a hash code for the duration that is compatable with the equals method. |
boolean |
isEqual(ReadableDuration duration)
Is the length of this duration equal to the duration passed in. |
boolean |
isLongerThan(ReadableDuration duration)
Is the length of this duration longer than the duration passed in. |
boolean |
isShorterThan(ReadableDuration duration)
Is the length of this duration shorter than the duration passed in. |
Duration |
toDuration()
Get this duration as an immutable Duration object. |
Period |
toPeriod()
Converts this duration to a Period instance using the standard period type and the ISO chronology. |
String |
toString()
Gets the value as a String in the ISO8601 duration format using hours, minutes and seconds (including fractional milliseconds). |
Methods inherited from interface java.lang.Comparable |
---|
compareTo |
Method Detail |
---|
long getMillis()
Duration toDuration()
Duration
object.
This will either typecast this instance, or create a new Duration
.
Period toPeriod()
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, see Period.Period(ReadableInstant,ReadableDuration)
.
boolean isEqual(ReadableDuration duration)
duration
- another duration to compare to, null means zero milliseconds
boolean isLongerThan(ReadableDuration duration)
duration
- another duration to compare to, null means zero milliseconds
boolean isShorterThan(ReadableDuration duration)
duration
- another duration to compare to, null means zero milliseconds
boolean equals(Object readableDuration)
equals
in class Object
readableDuration
- a readable duration to check against
int hashCode()
long len = getMillis(); return (int) (len ^ (len >>> 32));
hashCode
in class Object
String toString()
For example, "PT6H3M7S" represents 6 hours, 3 minutes, 7 seconds.
toString
in class Object
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |