org.joda.time.base
Class BaseDuration

java.lang.Object
  extended by org.joda.time.base.AbstractDuration
      extended by org.joda.time.base.BaseDuration
All Implemented Interfaces:
Serializable, Comparable<ReadableDuration>, ReadableDuration
Direct Known Subclasses:
Duration

public abstract class BaseDuration
extends AbstractDuration
implements ReadableDuration, Serializable

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.

Since:
1.0
Author:
Brian S O'Neill, Stephen Colebourne
See Also:
Serialized Form

Constructor Summary
protected BaseDuration(long duration)
          Creates a duration from the given millisecond duration.
protected BaseDuration(long startInstant, long endInstant)
          Creates a duration from the given interval endpoints.
protected BaseDuration(Object duration)
          Creates a duration from the specified object using the ConverterManager.
protected BaseDuration(ReadableInstant start, ReadableInstant end)
          Creates a duration from the given interval endpoints.
 
Method Summary
 long getMillis()
          Gets the length of this duration in milliseconds.
protected  void setMillis(long duration)
          Sets the length of this duration in milliseconds.
 Interval toIntervalFrom(ReadableInstant startInstant)
          Converts this duration to an Interval starting at the specified instant.
 Interval toIntervalTo(ReadableInstant endInstant)
          Converts this duration to an Interval ending at the specified instant.
 Period toPeriod(Chronology chrono)
          Converts this duration to a Period instance using the standard period type and the specified chronology.
 Period toPeriod(PeriodType type)
          Converts this duration to a Period instance using the specified period type and the ISO chronology.
 Period toPeriod(PeriodType type, Chronology chrono)
          Converts this duration to a Period instance using the specified period type and chronology.
 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.
 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.
 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.
 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.
 
Methods inherited from class org.joda.time.base.AbstractDuration
compareTo, equals, hashCode, isEqual, isLongerThan, isShorterThan, toDuration, toPeriod, toString
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 
Methods inherited from interface org.joda.time.ReadableDuration
equals, hashCode, isEqual, isLongerThan, isShorterThan, toDuration, toPeriod, toString
 
Methods inherited from interface java.lang.Comparable
compareTo
 

Constructor Detail

BaseDuration

protected BaseDuration(long duration)
Creates a duration from the given millisecond duration.

Parameters:
duration - the duration, in milliseconds

BaseDuration

protected BaseDuration(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

BaseDuration

protected BaseDuration(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

BaseDuration

protected BaseDuration(Object duration)
Creates a duration from the specified object using the ConverterManager.

Parameters:
duration - duration to convert
Throws:
IllegalArgumentException - if duration is invalid
Method Detail

getMillis

public long getMillis()
Gets the length of this duration in milliseconds.

Specified by:
getMillis in interface ReadableDuration
Returns:
the length of the duration in milliseconds.

setMillis

protected void setMillis(long duration)
Sets the length of this duration in milliseconds.

Parameters:
duration - the new length of the duration

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).

Parameters:
type - the period type to use, null means standard
Returns:
a Period created using the millisecond duration from this instance

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)

Parameters:
chrono - the chronology to use, null means ISO default
Returns:
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)

Parameters:
type - the period type to use, null means standard
chrono - the chronology to use, null means ISO default
Returns:
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.

Parameters:
startInstant - the instant to calculate the period from, null means now
Returns:
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.

Parameters:
startInstant - the instant to calculate the period from, null means now
type - the period type determining how to split the duration into fields, null means All type
Returns:
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.

Parameters:
endInstant - the instant to calculate the period to, null means now
Returns:
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.

Parameters:
endInstant - the instant to calculate the period to, null means now
type - the period type determining how to split the duration into fields, null means All type
Returns:
a Period created using the millisecond duration from this instance

toIntervalFrom

public Interval toIntervalFrom(ReadableInstant startInstant)
Converts this duration to an Interval starting at the specified instant.

Parameters:
startInstant - the instant to start the interval at, null means now
Returns:
an Interval starting at the specified instant

toIntervalTo

public Interval toIntervalTo(ReadableInstant endInstant)
Converts this duration to an Interval ending at the specified instant.

Parameters:
endInstant - the instant to end the interval at, null means now
Returns:
an Interval ending at the specified instant


Copyright © 2002-2012 Joda.org. All Rights Reserved.