Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.joda.time.base.AbstractPeriod
org.joda.time.base.BasePeriod
org.joda.time.MutablePeriod
Duration
.
The definition of a period also affects the equals method. A period of 1
day is not equal to a period of 24 hours, nor 1 hour equal to 60 minutes.
This is because periods represent an abstracted definition of a time period
(eg. a day may not actually be 24 hours, it might be 23 or 25 at daylight
savings boundary). To compare the actual duration of two periods, convert
both to durations using toDuration, an operation that emphasises that the
result may differ according to the date you choose.
MutablePeriod is mutable and not thread-safe, unless concurrent threads
are not invoking mutator methods.
Period
Constructor Summary | |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
Method Summary | |
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
Object |
|
MutablePeriod |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
void |
|
Methods inherited from class org.joda.time.base.BasePeriod | |
addField , addFieldInto , addPeriod , addPeriodInto , checkPeriodType , getFieldType , getPeriodType , getValue , mergePeriod , mergePeriodInto , setField , setFieldInto , setPeriod , setPeriod , setValue , setValues , size , toDurationFrom , toDurationTo |
Methods inherited from class org.joda.time.base.AbstractPeriod | |
equals , get , getFieldTypes , getValues , hashCode , indexOf , isSupported , toMutablePeriod , toPeriod , toString , toString |
public MutablePeriod()
Creates a zero-length period using the standard period type.
public MutablePeriod(Object period)
Creates a period by converting or copying from another object. The recognised object types are defined inConverterManager
and include ReadablePeriod, ReadableInterval and String. The String formats are described byISOPeriodFormat.standard()
.
- Parameters:
period
- period to convert
public MutablePeriod(Object period, Chronology chrono)
Creates a period by converting or copying from another object. The recognised object types are defined inConverterManager
and include ReadablePeriod, ReadableInterval and String. The String formats are described byISOPeriodFormat.standard()
.
- Parameters:
period
- period to convertchrono
- the chronology to use, null means ISO in default zone
public MutablePeriod(Object period, PeriodType type)
Creates a period by converting or copying from another object. The recognised object types are defined inConverterManager
and include ReadablePeriod, ReadableInterval and String. The String formats are described byISOPeriodFormat.standard()
.
- Parameters:
period
- period to converttype
- which set of fields this period supports, null means use converter
public MutablePeriod(Object period, PeriodType type, Chronology chrono)
Creates a period by converting or copying from another object. The recognised object types are defined inConverterManager
and include ReadablePeriod, ReadableInterval and String. The String formats are described byISOPeriodFormat.standard()
.
- Parameters:
period
- period to converttype
- which set of fields this period supports, null means use converterchrono
- the chronology to use, null means ISO in default zone
public MutablePeriod(int hours, int minutes, int seconds, int millis)
Create a period from a set of field values using the standard set of fields.
- Parameters:
hours
- amount of hours in this periodminutes
- amount of minutes in this periodseconds
- amount of seconds in this periodmillis
- amount of milliseconds in this period
public MutablePeriod(int years, int months, int weeks, int days, int hours, int minutes, int seconds, int millis)
Create a period from a set of field values using the standard set of fields.
- Parameters:
years
- amount of years in this periodmonths
- amount of months in this periodweeks
- amount of weeks in this perioddays
- amount of days in this periodhours
- amount of hours in this periodminutes
- amount of minutes in this periodseconds
- amount of seconds in this periodmillis
- amount of milliseconds in this period
public MutablePeriod(int years, int months, int weeks, int days, int hours, int minutes, int seconds, int millis, PeriodType type)
Create a period from a set of field values.
- Parameters:
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 unsupportedtype
- which set of fields this period supports, null means AllType
public MutablePeriod(long duration)
Creates a period from the given millisecond duration using the standard set of fields. Only precise fields in the period type will be used. For the standard period type this is the time fields only. Thus 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 precise field, hours in this case. For example, a duration 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 have two options:
- convert the duration to an
Interval
, and from there obtain the period- specify a period type that contains precise definitions of the day and larger fields, such as the UTC or precise types.
- Parameters:
duration
- the duration, in milliseconds
public MutablePeriod(long startInstant, long endInstant)
Creates a period from the given interval endpoints using the standard set of fields.
- Parameters:
startInstant
- interval start, in millisecondsendInstant
- interval end, in milliseconds
public MutablePeriod(long startInstant, long endInstant, Chronology chrono)
Creates a period from the given interval endpoints using the standard set of fields.
- Parameters:
startInstant
- interval start, in millisecondsendInstant
- interval end, in millisecondschrono
- the chronology to use, null means ISO in default zone
public MutablePeriod(long startInstant, long endInstant, PeriodType type)
Creates a period from the given interval endpoints.
- Parameters:
startInstant
- interval start, in millisecondsendInstant
- interval end, in millisecondstype
- which set of fields this period supports, null means standard
public MutablePeriod(long startInstant, long endInstant, PeriodType type, Chronology chrono)
Creates a period from the given interval endpoints.
- Parameters:
startInstant
- interval start, in millisecondsendInstant
- interval end, in millisecondstype
- which set of fields this period supports, null means standardchrono
- the chronology to use, null means ISO in default zone
public MutablePeriod(long duration, Chronology chronology)
Creates a period from the given millisecond duration using the standard set of fields. Only precise fields in the period type will be used. Imprecise fields will not be populated. If the duration is small then this method will perform as you might expect and split the fields evenly. If the duration is large then all the remaining duration will be stored in the largest available precise field. For details as to which fields are precise, review the period type javadoc.
- Parameters:
duration
- the duration, in millisecondschronology
- the chronology to use to split the duration, null means ISO default
public MutablePeriod(long duration, PeriodType type)
Creates a period from the given millisecond duration. Only precise fields in the period type will be used. Imprecise fields will not be populated. If the duration is small then this method will perform as you might expect and split the fields evenly. If the duration is large then all the remaining duration will be stored in the largest available precise field. For details as to which fields are precise, review the period type javadoc.
- Parameters:
duration
- the duration, in millisecondstype
- which set of fields this period supports, null means standard
public MutablePeriod(long duration, PeriodType type, Chronology chronology)
Creates a period from the given millisecond duration. Only precise fields in the period type will be used. Imprecise fields will not be populated. If the duration is small then this method will perform as you might expect and split the fields evenly. If the duration is large then all the remaining duration will be stored in the largest available precise field. For details as to which fields are precise, review the period type javadoc.
- Parameters:
duration
- the duration, in millisecondstype
- which set of fields this period supports, null means standardchronology
- the chronology to use to split the duration, null means ISO default
public MutablePeriod(PeriodType type)
Creates a zero-length period using the specified period type.
- Parameters:
type
- which set of fields this period supports
public MutablePeriod(ReadableDuration duration, ReadableInstant endInstant)
Creates a period from the given duration and end point.
- Parameters:
duration
- the duration of the interval, null means zero-lengthendInstant
- the interval end, null means now
public MutablePeriod(ReadableDuration duration, ReadableInstant endInstant, PeriodType type)
Creates a period from the given duration and end point.
- Parameters:
duration
- the duration of the interval, null means zero-lengthendInstant
- the interval end, null means nowtype
- which set of fields this period supports, null means standard
public MutablePeriod(ReadableInstant startInstant, ReadableDuration duration)
Creates a period from the given start point and the duration.
- Parameters:
startInstant
- the interval start, null means nowduration
- the duration of the interval, null means zero-length
public MutablePeriod(ReadableInstant startInstant, ReadableDuration duration, PeriodType type)
Creates a period from the given start point and the duration.
- Parameters:
startInstant
- the interval start, null means nowduration
- the duration of the interval, null means zero-lengthtype
- which set of fields this period supports, null means standard
public MutablePeriod(ReadableInstant startInstant, ReadableInstant endInstant)
Creates a period from the given interval endpoints using the standard set of fields. The chronology of the start instant is used, unless that is null when the chronology of the end instant is used instead.
- Parameters:
startInstant
- interval start, null means nowendInstant
- interval end, null means now
public MutablePeriod(ReadableInstant startInstant, ReadableInstant endInstant, PeriodType type)
Creates a period from the given interval endpoints. The chronology of the start instant is used, unless that is null when the chronology of the end instant is used instead.
- Parameters:
startInstant
- interval start, null means nowendInstant
- interval end, null means nowtype
- which set of fields this period supports, null means AllType
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.
- Specified by:
- add in interface ReadWritablePeriod
- Parameters:
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
public void add(long duration)
Adds a millisecond duration to this one by dividing the duration into fields and callingadd(ReadablePeriod)
. When dividing the duration, only precise fields in the period type will be used. For large durations, all the remaining duration will be stored in the largest available precise field.
- Parameters:
duration
- the duration, in milliseconds
public void add(long duration, Chronology chrono)
Adds a millisecond duration to this one by dividing the duration into fields and callingadd(ReadablePeriod)
. When dividing the duration, only precise fields in the period type will be used. For large durations, all the remaining duration will be stored in the largest available precise field.
- Parameters:
duration
- the duration, in millisecondschrono
- the chronology to use, null means ISO default
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.
- Specified by:
- add in interface ReadWritablePeriod
- Parameters:
field
- a DurationFieldType instance that is supported by this period, not nullvalue
- the value to add to the field
public void add(ReadableDuration duration)
Adds a duration to this one by dividing the duration into fields and callingadd(ReadablePeriod)
.
- Parameters:
duration
- the duration to add, null means add nothing
public void add(ReadableInterval interval)
Adds an interval to this one by dividing the interval into fields and callingadd(ReadablePeriod)
.
- Specified by:
- add in interface ReadWritablePeriod
- Parameters:
interval
- the interval to add, null means add nothing
public void add(ReadablePeriod period)
Adds a period to this one by adding each field in turn.
- Specified by:
- add in interface ReadWritablePeriod
- Parameters:
period
- the period to add, null means add nothing
public void addDays(int days)
Adds the specified days to the number of days in the period.
- Specified by:
- addDays in interface ReadWritablePeriod
- Parameters:
days
- the number of days
public void addHours(int hours)
Adds the specified hours to the number of hours in the period.
- Specified by:
- addHours in interface ReadWritablePeriod
- Parameters:
hours
- the number of hours
public void addMillis(int millis)
Adds the specified millis to the number of millis in the period.
- Specified by:
- addMillis in interface ReadWritablePeriod
- Parameters:
millis
- the number of millis
public void addMinutes(int minutes)
Adds the specified minutes to the number of minutes in the period.
- Specified by:
- addMinutes in interface ReadWritablePeriod
- Parameters:
minutes
- the number of minutes
public void addMonths(int months)
Adds the specified months to the number of months in the period.
- Specified by:
- addMonths in interface ReadWritablePeriod
- Parameters:
months
- the number of months
public void addSeconds(int seconds)
Adds the specified seconds to the number of seconds in the period.
- Specified by:
- addSeconds in interface ReadWritablePeriod
- Parameters:
seconds
- the number of seconds
public void addWeeks(int weeks)
Adds the specified weeks to the number of weeks in the period.
- Specified by:
- addWeeks in interface ReadWritablePeriod
- Parameters:
weeks
- the number of weeks
public void addYears(int years)
Adds the specified years to the number of years in the period.
- Specified by:
- addYears in interface ReadWritablePeriod
- Parameters:
years
- the number of years
public void clear()
Clears the period, setting all values back to zero.
- Specified by:
- clear in interface ReadWritablePeriod
public Object clone()
Clone this object.
- Returns:
- a clone of this object.
public MutablePeriod copy()
Clone this object without having to cast the returned object.
- Returns:
- a clone of the this object.
public int getDays()
Gets the days field part of the period.
- Returns:
- the number of days in the period, zero if unsupported
public int getHours()
Gets the hours field part of the period.
- Returns:
- the number of hours in the period, zero if unsupported
public int getMillis()
Gets the millis field part of the period.
- Returns:
- the number of millis in the period, zero if unsupported
public int getMinutes()
Gets the minutes field part of the period.
- Returns:
- the number of minutes in the period, zero if unsupported
public int getMonths()
Gets the months field part of the period.
- Returns:
- the number of months in the period, zero if unsupported
public int getSeconds()
Gets the seconds field part of the period.
- Returns:
- the number of seconds in the period, zero if unsupported
public int getWeeks()
Gets the weeks field part of the period.
- Returns:
- the number of weeks in the period, zero if unsupported
public int getYears()
Gets the years field part of the period.
- Returns:
- the number of years in the period, zero if unsupported
public void mergePeriod(ReadablePeriod period)
Merges all the fields from the specified period into this one. Fields that are not present in the specified period are left unaltered.
- Overrides:
- mergePeriod in interface BasePeriod
- Parameters:
period
- the period to set, null ignored
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.
- Specified by:
- set in interface ReadWritablePeriod
- Parameters:
field
- a DurationFieldType instance that is supported by this period, not nullvalue
- the new value for the field
public void setDays(int days)
Sets the number of days of the period.
- Specified by:
- setDays in interface ReadWritablePeriod
- Parameters:
days
- the number of days
public void setHours(int hours)
Sets the number of hours of the period.
- Specified by:
- setHours in interface ReadWritablePeriod
- Parameters:
hours
- the number of hours
public void setMillis(int millis)
Sets the number of millis of the period.
- Specified by:
- setMillis in interface ReadWritablePeriod
- Parameters:
millis
- the number of millis
public void setMinutes(int minutes)
Sets the number of minutes of the period.
- Specified by:
- setMinutes in interface ReadWritablePeriod
- Parameters:
minutes
- the number of minutes
public void setMonths(int months)
Sets the number of months of the period.
- Specified by:
- setMonths in interface ReadWritablePeriod
- Parameters:
months
- the number of months
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.
- Specified by:
- setPeriod in interface ReadWritablePeriod
- Overrides:
- setPeriod in interface BasePeriod
- Parameters:
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
public void setPeriod(long duration)
Sets all the fields in one go from a millisecond duration dividing the fields using the period type. When dividing the duration, only precise fields in the period type will be used. For large durations, all the remaining duration will be stored in the largest available precise field.
- Parameters:
duration
- the duration, in milliseconds
public void setPeriod(long startInstant, long endInstant)
Sets all the fields in one go from a millisecond interval using ISOChronology and dividing the fields using the period type.
- Parameters:
startInstant
- interval start, in millisecondsendInstant
- interval end, in milliseconds
public void setPeriod(long startInstant, long endInstant, Chronology chrono)
Sets all the fields in one go from a millisecond interval.
- Parameters:
startInstant
- interval start, in millisecondsendInstant
- interval end, in millisecondschrono
- the chronology to use, not null
public void setPeriod(long duration, Chronology chrono)
Sets all the fields in one go from a millisecond duration. When dividing the duration, only precise fields in the period type will be used. For large durations, all the remaining duration will be stored in the largest available precise field.
- Parameters:
duration
- the duration, in millisecondschrono
- the chronology to use, not null
public void setPeriod(ReadableDuration duration)
Sets all the fields in one go from a duration dividing the fields using the period type. When dividing the duration, only precise fields in the period type will be used. For large durations, all the remaining duration will be stored in the largest available precise field.
- Parameters:
duration
- the duration to set, null means zero length
public void setPeriod(ReadableDuration duration, Chronology chrono)
Sets all the fields in one go from a duration dividing the fields using the period type. When dividing the duration, only precise fields in the period type will be used. For large durations, all the remaining duration will be stored in the largest available precise field.
- Parameters:
duration
- the duration to set, null means zero lengthchrono
- the chronology to use, null means ISO default
public void setPeriod(ReadableInstant start, ReadableInstant end)
Sets all the fields in one go from two instants representing an interval. The chronology of the start instant is used, unless that is null when the chronology of the end instant is used instead.
- Parameters:
start
- the start instant, null means nowend
- the end instant, null means now
public void setPeriod(ReadableInterval interval)
Sets all the fields in one go from an interval using the ISO chronology and dividing the fields using the period type.
- Specified by:
- setPeriod in interface ReadWritablePeriod
- Parameters:
interval
- the interval to set, null means zero length
public void setPeriod(ReadablePeriod period)
Sets all the fields in one go from another ReadablePeriod.
- Specified by:
- setPeriod in interface ReadWritablePeriod
- Overrides:
- setPeriod in interface BasePeriod
- Parameters:
period
- the period to set, null means zero length period
public void setSeconds(int seconds)
Sets the number of seconds of the period.
- Specified by:
- setSeconds in interface ReadWritablePeriod
- Parameters:
seconds
- the number of seconds
public void setValue(int index, int value)
Sets the value of one of the fields by index.
- Specified by:
- setValue in interface ReadWritablePeriod
- Overrides:
- setValue in interface BasePeriod
- Parameters:
index
- the field indexvalue
- the new value for the field
public void setWeeks(int weeks)
Sets the number of weeks of the period.
- Specified by:
- setWeeks in interface ReadWritablePeriod
- Parameters:
weeks
- the number of weeks
public void setYears(int years)
Sets the number of years of the period.
- Specified by:
- setYears in interface ReadWritablePeriod
- Parameters:
years
- the number of years