public interface ReadableDuration extends Comparable
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.
ReadableInterval
,
ReadablePeriod
Modifier and Type | Method and Description |
---|---|
int |
compareTo(Object obj)
Compares this duration with the specified duration based on length.
|
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).
|
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)
.
int compareTo(Object obj)
compareTo
in interface Comparable
obj
- a duration to check againstNullPointerException
- if the object is nullClassCastException
- if the given object is not supportedboolean isEqual(ReadableDuration duration)
duration
- another duration to compare to, null means zero millisecondsboolean isLongerThan(ReadableDuration duration)
duration
- another duration to compare to, null means zero millisecondsboolean isShorterThan(ReadableDuration duration)
duration
- another duration to compare to, null means zero millisecondsboolean equals(Object readableDuration)
int hashCode()
long len = getMillis(); return (int) (len ^ (len >>> 32));
Copyright © 2012 JBoss by Red Hat. All Rights Reserved.