public final class

Duration

extends BaseDuration
implements Serializable ReadableDuration
java.lang.Object
   ↳ org.joda.time.base.AbstractDuration
     ↳ org.joda.time.base.BaseDuration
       ↳ org.joda.time.Duration

Class Overview

An immutable duration specifying a length of time in milliseconds.

A duration is defined by a fixed number of milliseconds. There is no concept of fields, such as days or seconds, as these fields can vary in length. A duration may be converted to a Period to obtain field values. This conversion will typically cause a loss of precision however.

Duration is thread-safe and immutable.

Summary

Fields
public static final Duration ZERO Constant representing zero millisecond duration
Public Constructors
Duration(long duration)
Creates a duration from the given millisecond duration.
Duration(long startInstant, long endInstant)
Creates a duration from the given interval endpoints.
Duration(ReadableInstant start, ReadableInstant end)
Creates a duration from the given interval endpoints.
Duration(Object duration)
Creates a duration from the specified object using the ConverterManager.
Public Methods
long getStandardSeconds()
Gets the length of this duration in seconds assuming 1000 milliseconds in a second.
Duration minus(long amount)
Returns a new duration with this length minus that specified.
Duration minus(ReadableDuration amount)
Returns a new duration with this length minus that specified.
Duration plus(ReadableDuration amount)
Returns a new duration with this length plus that specified.
Duration plus(long amount)
Returns a new duration with this length plus that specified.
static Duration standardDays(long days)
Create a duration with the specified number of days assuming that there are the standard number of milliseconds in a day.
static Duration standardHours(long hours)
Create a duration with the specified number of hours assuming that there are the standard number of milliseconds in an hour.
static Duration standardMinutes(long minutes)
Create a duration with the specified number of minutes assuming that there are the standard number of milliseconds in a minute.
static Duration standardSeconds(long seconds)
Create a duration with the specified number of seconds assuming that there are the standard number of milliseconds in a second.
Duration toDuration()
Get this duration as an immutable Duration object by returning this.
Seconds toStandardSeconds()
Converts this duration to a period in seconds assuming 1000 milliseconds in a second.
Duration withDurationAdded(long durationToAdd, int scalar)
Returns a new duration with this length plus that specified multiplied by the scalar.
Duration withDurationAdded(ReadableDuration durationToAdd, int scalar)
Returns a new duration with this length plus that specified multiplied by the scalar.
Duration withMillis(long duration)
Creates a new Duration instance with a different milisecond length.
[Expand]
Inherited Methods
From class org.joda.time.base.BaseDuration
From class org.joda.time.base.AbstractDuration
From class java.lang.Object
From interface java.lang.Comparable
From interface org.joda.time.ReadableDuration

Fields

public static final Duration ZERO

Constant representing zero millisecond duration

Public Constructors

public Duration (long duration)

Creates a duration from the given millisecond duration.

Parameters
duration the duration, in milliseconds

public Duration (long startInstant, long endInstant)

Creates a duration from the given interval endpoints.

Parameters
startInstant interval start, in milliseconds
endInstant interval end, in milliseconds
Throws
ArithmeticException if the duration exceeds a 64 bit long

public Duration (ReadableInstant start, ReadableInstant end)

Creates a duration from the given interval endpoints.

Parameters
start interval start, null means now
end interval end, null means now
Throws
ArithmeticException if the duration exceeds a 64 bit long

public Duration (Object duration)

Creates a duration from the specified object using the ConverterManager.

Parameters
duration duration to convert
Throws
IllegalArgumentException if duration is invalid

Public Methods

public long getStandardSeconds ()

Gets the length of this duration in seconds assuming 1000 milliseconds in a second.

This returns getMillis() / 1000. The result is an integer division, so 2999 millis returns 2 seconds.

Returns
  • the length of the duration in standard seconds

public Duration minus (long amount)

Returns a new duration with this length minus that specified. This instance is immutable and is not altered.

If the addition is zero, this instance is returned.

Parameters
amount the duration to take away from this one
Returns
  • the new duration instance

public Duration minus (ReadableDuration amount)

Returns a new duration with this length minus that specified. This instance is immutable and is not altered.

If the amount is zero, this instance is returned.

Parameters
amount the duration to take away from this one, null means zero
Returns
  • the new duration instance

public Duration plus (ReadableDuration amount)

Returns a new duration with this length plus that specified. This instance is immutable and is not altered.

If the amount is zero, this instance is returned.

Parameters
amount the duration to add to this one, null means zero
Returns
  • the new duration instance

public Duration plus (long amount)

Returns a new duration with this length plus that specified. This instance is immutable and is not altered.

If the addition is zero, this instance is returned.

Parameters
amount the duration to add to this one
Returns
  • the new duration instance

public static Duration standardDays (long days)

Create a duration with the specified number of days assuming that there are the standard number of milliseconds in a day.

This method assumes that there are 24 hours in a day, 60 minutes in an hour, 60 seconds in a minute and 1000 milliseconds in a second. This will be true for most days, however days with Daylight Savings changes will not have 24 hours, so use this method with care.

A Duration is a representation of an amount of time. If you want to express the concepts of 'days' you should consider using the Days class.

Parameters
days the number of standard days in this duration
Returns
  • the duration, never null
Throws
ArithmeticException if the days value is too large

public static Duration standardHours (long hours)

Create a duration with the specified number of hours assuming that there are the standard number of milliseconds in an hour.

This method assumes that there are 60 minutes in an hour, 60 seconds in a minute and 1000 milliseconds in a second. All currently supplied chronologies use this definition.

A Duration is a representation of an amount of time. If you want to express the concepts of 'hours' you should consider using the Hours class.

Parameters
hours the number of standard hours in this duration
Returns
  • the duration, never null
Throws
ArithmeticException if the hours value is too large

public static Duration standardMinutes (long minutes)

Create a duration with the specified number of minutes assuming that there are the standard number of milliseconds in a minute.

This method assumes that there are 60 seconds in a minute and 1000 milliseconds in a second. All currently supplied chronologies use this definition.

A Duration is a representation of an amount of time. If you want to express the concepts of 'minutes' you should consider using the Minutes class.

Parameters
minutes the number of standard minutes in this duration
Returns
  • the duration, never null
Throws
ArithmeticException if the minutes value is too large

public static Duration standardSeconds (long seconds)

Create a duration with the specified number of seconds assuming that there are the standard number of milliseconds in a second.

This method assumes that there are 1000 milliseconds in a second. All currently supplied chronologies use this definition.

A Duration is a representation of an amount of time. If you want to express the concepts of 'seconds' you should consider using the Seconds class.

Parameters
seconds the number of standard seconds in this duration
Returns
  • the duration, never null
Throws
ArithmeticException if the seconds value is too large

public Duration toDuration ()

Get this duration as an immutable Duration object by returning this.

Returns
  • this

public Seconds toStandardSeconds ()

Converts this duration to a period in seconds assuming 1000 milliseconds in a second.

This method allows you to convert between a duration and a period.

Returns
  • a period representing the number of standard seconds in this period, never null
Throws
ArithmeticException if the number of seconds is too large to be represented

public Duration withDurationAdded (long durationToAdd, int scalar)

Returns a new duration with this length plus that specified multiplied by the scalar. This instance is immutable and is not altered.

If the addition is zero, this instance is returned.

Parameters
durationToAdd the duration to add to this one
scalar the amount of times to add, such as -1 to subtract once
Returns
  • the new duration instance

public Duration withDurationAdded (ReadableDuration durationToAdd, int scalar)

Returns a new duration with this length plus that specified multiplied by the scalar. This instance is immutable and is not altered.

If the addition is zero, this instance is returned.

Parameters
durationToAdd the duration to add to this one, null means zero
scalar the amount of times to add, such as -1 to subtract once
Returns
  • the new duration instance

public Duration withMillis (long duration)

Creates a new Duration instance with a different milisecond length.

Parameters
duration the new length of the duration
Returns
  • the new duration instance