Defines a duration of time that can be queried and modified using datetime fields.
The implementation of this interface will be mutable.
It may provide more advanced methods than those in the interface.
add
public void add(int years,
int months,
int weeks,
int days,
int hours,
int minutes,
int seconds,
int millis)
Adds to each field of this period.
years
- amount of years to add to this period, which must be zero if unsupportedmonths
- amount of months to add to this period, which must be zero if unsupportedweeks
- amount of weeks to add to this period, which must be zero if unsupporteddays
- amount of days to add to this period, which must be zero if unsupportedhours
- amount of hours to add to this period, which must be zero if unsupportedminutes
- amount of minutes to add to this period, which must be zero if unsupportedseconds
- amount of seconds to add to this period, which must be zero if unsupportedmillis
- amount of milliseconds to add to this period, which must be zero if unsupported
add
public void add(DurationFieldType field,
int value)
Adds to the value of one of the fields.
The field type specified must be one of those that is supported by the period.
field
- a DurationFieldType instance that is supported by this periodvalue
- the value to add to the field
add
public void add(ReadableInterval interval)
Adds an interval to this one by dividing the interval into
fields and then adding each field in turn.
interval
- the interval to add, null means add nothing
add
public void add(ReadablePeriod period)
Adds a period to this one by adding each field in turn.
period
- the period to add, null means add nothing
addDays
public void addDays(int days)
Adds the specified days to the number of days in the period.
days
- the number of days
addHours
public void addHours(int hours)
Adds the specified hours to the number of hours in the period.
hours
- the number of hours
addMillis
public void addMillis(int millis)
Adds the specified millis to the number of millis in the period.
millis
- the number of millis
addMinutes
public void addMinutes(int minutes)
Adds the specified minutes to the number of minutes in the period.
minutes
- the number of minutes
addMonths
public void addMonths(int months)
Adds the specified months to the number of months in the period.
months
- the number of months
addSeconds
public void addSeconds(int seconds)
Adds the specified seconds to the number of seconds in the period.
seconds
- the number of seconds
addWeeks
public void addWeeks(int weeks)
Adds the specified weeks to the number of weeks in the period.
weeks
- the number of weeks
addYears
public void addYears(int years)
Adds the specified years to the number of years in the period.
years
- the number of years
clear
public void clear()
Clears the period, setting all values back to zero.
set
public void set(DurationFieldType field,
int value)
Sets the value of one of the fields.
The field type specified must be one of those that is supported by the period.
field
- a DurationFieldType instance that is supported by this periodvalue
- the new value for the field
setDays
public void setDays(int days)
Sets the number of days of the period.
days
- the number of days
setHours
public void setHours(int hours)
Sets the number of hours of the period.
hours
- the number of hours
setMillis
public void setMillis(int millis)
Sets the number of millis of the period.
millis
- the number of millis
setMinutes
public void setMinutes(int minutes)
Sets the number of minutes of the period.
minutes
- the number of minutes
setMonths
public void setMonths(int months)
Sets the number of months of the period.
months
- the number of months
setPeriod
public void setPeriod(int years,
int months,
int weeks,
int days,
int hours,
int minutes,
int seconds,
int millis)
Sets all the fields in one go.
years
- amount of years in this period, which must be zero if unsupportedmonths
- amount of months in this period, which must be zero if unsupportedweeks
- amount of weeks in this period, which must be zero if unsupporteddays
- amount of days in this period, which must be zero if unsupportedhours
- amount of hours in this period, which must be zero if unsupportedminutes
- amount of minutes in this period, which must be zero if unsupportedseconds
- amount of seconds in this period, which must be zero if unsupportedmillis
- amount of milliseconds in this period, which must be zero if unsupported
setPeriod
public void setPeriod(ReadableInterval interval)
Sets all the fields in one go from an interval dividing the
fields using the period type.
interval
- the interval to set, null means zero length
setPeriod
public void setPeriod(ReadablePeriod period)
Sets all the fields in one go from another ReadablePeriod.
period
- the period to set, null means zero length period
setSeconds
public void setSeconds(int seconds)
Sets the number of seconds of the period.
seconds
- the number of seconds
setValue
public void setValue(int index,
int value)
Sets the value of one of the fields by index.
index
- the field indexvalue
- the new value for the field
setWeeks
public void setWeeks(int weeks)
Sets the number of weeks of the period.
weeks
- the number of weeks
setYears
public void setYears(int years)
Sets the number of years of the period.
years
- the number of years