org.joda.time.base
Class BaseDuration
- Comparable, ReadableDuration, Serializable
public abstract class BaseDuration
BaseDuration is an abstract implementation of ReadableDuration that stores
data in a
long
duration milliseconds field.
This class should generally not be used directly by API users.
The
ReadableDuration
interface should be used when different
kinds of duration objects are to be referenced.
BaseDuration subclasses may be mutable and not thread-safe.
- Brian S O'Neill
- Stephen Colebourne
BaseDuration
protected BaseDuration(Object duration)
duration
- duration to convert
BaseDuration
protected BaseDuration(long duration)
Creates a duration from the given millisecond duration.
duration
- the duration, in milliseconds
BaseDuration
protected BaseDuration(long startInstant,
long endInstant)
Creates a duration from the given interval endpoints.
startInstant
- interval start, in millisecondsendInstant
- interval end, in milliseconds
BaseDuration
protected BaseDuration(ReadableInstant start,
ReadableInstant end)
Creates a duration from the given interval endpoints.
start
- interval start, null means nowend
- interval end, null means now
getMillis
public long getMillis()
Gets the length of this duration in milliseconds.
- getMillis in interface ReadableDuration
- the length of the duration in milliseconds.
setMillis
protected void setMillis(long duration)
Sets the length of this duration in milliseconds.
duration
- the new length of the duration
toIntervalFrom
public Interval toIntervalFrom(ReadableInstant startInstant)
Converts this duration to an Interval starting at the specified instant.
startInstant
- the instant to start the interval at, null means now
- an Interval starting at the specified instant
toIntervalTo
public Interval toIntervalTo(ReadableInstant endInstant)
Converts this duration to an Interval ending at the specified instant.
endInstant
- the instant to end the interval at, null means now
- an Interval ending at the specified instant
toPeriod
public Period toPeriod(Chronology chrono)
Converts this duration to a Period instance using the standard period type
and the specified chronology.
Only precise fields in the period type will be used.
Exactly which fields are precise depends on the chronology.
Only the time fields are precise for ISO chronology with a time zone.
However, ISO UTC also has precise days and weeks.
For more control over the conversion process, you must pair the duration with
an instant, see
toPeriodFrom(ReadableInstant)
and
toPeriodTo(ReadableInstant)
chrono
- the chronology to use, null means ISO default
- a Period created using the millisecond duration from this instance
toPeriod
public Period toPeriod(PeriodType type)
Converts this duration to a Period instance using the specified period type
and the ISO chronology.
Only precise fields in the period type will be used.
At most these are hours, minutes, seconds and millis - the period
type may restrict the selection further.
For more control over the conversion process, you must pair the duration with
an instant, see
toPeriodFrom(ReadableInstant,PeriodType)
.
type
- the period type to use, null means standard
- a Period created using the millisecond duration from this instance
toPeriod
public Period toPeriod(PeriodType type,
Chronology chrono)
Converts this duration to a Period instance using the specified period type
and chronology.
Only precise fields in the period type will be used.
Exactly which fields are precise depends on the chronology.
Only the time fields are precise for ISO chronology with a time zone.
However, ISO UTC also has precise days and weeks.
For more control over the conversion process, you must pair the duration with
an instant, see
toPeriodFrom(ReadableInstant,PeriodType)
and
toPeriodTo(ReadableInstant,PeriodType)
type
- the period type to use, null means standardchrono
- the chronology to use, null means ISO default
- a Period created using the millisecond duration from this instance
toPeriodFrom
public Period toPeriodFrom(ReadableInstant startInstant)
Converts this duration to a Period instance by adding the duration to a start
instant to obtain an interval using the standard period type.
This conversion will determine the fields of a period accurately.
The results are based on the instant millis, the chronology of the instant,
the standard period type and the length of this duration.
startInstant
- the instant to calculate the period from, null means now
- a Period created using the millisecond duration from this instance
toPeriodFrom
public Period toPeriodFrom(ReadableInstant startInstant,
PeriodType type)
Converts this duration to a Period instance by adding the duration to a start
instant to obtain an interval.
This conversion will determine the fields of a period accurately.
The results are based on the instant millis, the chronology of the instant,
the period type and the length of this duration.
startInstant
- the instant to calculate the period from, null means nowtype
- the period type determining how to split the duration into fields, null means All type
- a Period created using the millisecond duration from this instance
toPeriodTo
public Period toPeriodTo(ReadableInstant endInstant)
Converts this duration to a Period instance by subtracting the duration
from an end instant to obtain an interval using the standard period
type.
This conversion will determine the fields of a period accurately.
The results are based on the instant millis, the chronology of the instant,
the standard period type and the length of this duration.
endInstant
- the instant to calculate the period to, null means now
- a Period created using the millisecond duration from this instance
toPeriodTo
public Period toPeriodTo(ReadableInstant endInstant,
PeriodType type)
Converts this duration to a Period instance by subtracting the duration
from an end instant to obtain an interval using the standard period
type.
This conversion will determine the fields of a period accurately.
The results are based on the instant millis, the chronology of the instant,
the period type and the length of this duration.
endInstant
- the instant to calculate the period to, null means nowtype
- the period type determining how to split the duration into fields, null means All type
- a Period created using the millisecond duration from this instance
Copyright (c) 2001-2006 - Joda.org