public abstract class

AbstractDuration

extends Object
implements ReadableDuration
java.lang.Object
   ↳ org.joda.time.base.AbstractDuration
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

AbstractDuration provides the common behaviour for duration classes.

This class should generally not be used directly by API users. The ReadableDuration interface should be used when different kinds of durations are to be referenced.

AbstractDuration subclasses may be mutable and not thread-safe.

Summary

Protected Constructors
AbstractDuration()
Constructor.
Public Methods
int compareTo(Object obj)
Compares this duration with the specified duration based on length.
boolean equals(Object duration)
Compares this object with the specified object for equality based on the millisecond length.
int hashCode()
Gets a hash code for the duration that is compatible 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 including only seconds and milliseconds.
[Expand]
Inherited Methods
From class java.lang.Object
From interface java.lang.Comparable
From interface org.joda.time.ReadableDuration

Protected Constructors

protected AbstractDuration ()

Constructor.

Public Methods

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
Throws
NullPointerException if the object is null
ClassCastException if the given object is not supported

public boolean equals (Object duration)

Compares this object with the specified object for equality based on the millisecond length. All ReadableDuration instances are accepted.

Parameters
duration a readable duration to check against
Returns
  • true if the length of the duration is equal

public int hashCode ()

Gets a hash code for the duration that is compatible with the equals method.

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 immutable Duration object.

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, see 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 including only seconds and milliseconds.

For example, "PT72.345S" represents 1 minute, 12 seconds and 345 milliseconds.

For more control over the output, see PeriodFormatterBuilder.

Returns
  • the value as an ISO8601 string