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.Period
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.
Period is thread-safe and immutable, provided that the PeriodType is as well.
All standard PeriodType classes supplied are thread-safe and immutable.
MutablePeriod
Constructor Summary | |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
| |
|
Method Summary | |
static Period |
|
static Period |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
int |
|
static Period |
|
static Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
static Period |
|
static Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
static Period |
|
Period |
|
Days |
|
Duration |
|
Hours |
|
Minutes |
|
Seconds |
|
Weeks |
|
static Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
Period |
|
static Period |
|
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 Period()
Creates a new empty period with the standard set of fields. One way to initialise a period is as follows:Period = new Period().withYears(6).withMonths(3).withSeconds(23);Bear in mind that this creates four period instances in total, three of which are immediately discarded. The alterative is more efficient, but less readable:Period = new Period(6, 3, 0, 0, 0, 0, 23, 0);The following is also slightly less wasteful:Period = Period.years(6).withMonths(3).withSeconds(23);
public Period(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 Period(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 Period(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 Period(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 Period(int hours, int minutes, int seconds, int millis)
Create a period from a set of field values using the standard set of fields. Note that the parameters specify the time fields hours, minutes, seconds and millis, not the date 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 Period(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 Period(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. There is usually little need to use this constructor. The period type is used primarily to define how to split an interval into a period. As this constructor already is split, the period type does no real work.
- 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 Period(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 UTC
- Parameters:
duration
- the duration, in milliseconds
public Period(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 Period(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 Period(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 Period(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 Period(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 Period(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 Period(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 Period(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 Period(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 Period(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 Period(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 Period(ReadableInstant startInstant, ReadableInstant endInstant)
Creates a period from the given interval endpoints using the standard set of fields.
- Parameters:
startInstant
- interval start, null means nowendInstant
- interval end, null means now
public Period(ReadableInstant startInstant, ReadableInstant endInstant, PeriodType type)
Creates a period from the given interval endpoints.
- Parameters:
startInstant
- interval start, null means nowendInstant
- interval end, null means nowtype
- which set of fields this period supports, null means standard
public Period(ReadablePartial start, ReadablePartial end)
Creates a period from two partially specified times. The two partials must contain the same fields, thus you can specify twoLocalDate
objects, or twoLocalTime
objects, but not one of each. As these are Partial objects, time zones have no effect on the result. The two partials must also both be contiguous - seeDateTimeUtils.isContiguous(ReadablePartial)
for a definition. BothLocalDate
andLocalTime
are contiguous. An alternative way of constructing a Period from two Partials isfieldDifference(ReadablePartial,ReadablePartial)
. That method handles all kinds of partials.
- Parameters:
start
- the start of the period, must not be nullend
- the end of the period, must not be null
- Since:
- 1.1
public Period(ReadablePartial start, ReadablePartial end, PeriodType type)
Creates a period from two partially specified times. The two partials must contain the same fields, thus you can specify twoLocalDate
objects, or twoLocalTime
objects, but not one of each. As these are Partial objects, time zones have no effect on the result. The two partials must also both be contiguous - seeDateTimeUtils.isContiguous(ReadablePartial)
for a definition. BothLocalDate
andLocalTime
are contiguous. An alternative way of constructing a Period from two Partials isfieldDifference(ReadablePartial,ReadablePartial)
. That method handles all kinds of partials.
- Parameters:
start
- the start of the period, must not be nullend
- the end of the period, must not be nulltype
- which set of fields this period supports, null means standard
- Since:
- 1.1
public static Period days(int days)
Create a period with a specified number of days. The standard period type is used, thus you can add other fields such as months or weeks using thewithXxx()
methods. For example,Period.days(2).withHours(6);
If you want a day-based period that cannot have other fields added, then you should consider usingDays
.
- Parameters:
days
- the amount of days in this period
- Returns:
- the period
public static Period fieldDifference(ReadablePartial start, ReadablePartial end)
Creates a period from two partially specified times, calculating by field difference. The two partials must contain the same fields, thus you can specify twoLocalDate
objects, or twoLocalTime
objects, but not one of each. Also, the partial may not contain overlapping fields, such as dayOfWeek and dayOfMonth. Calculation by field difference works by extracting the difference one field at a time and not wrapping into other fields. Thus 2005-06-09/2007-04-12 will yield P1Y-2M3D. For example, you have an event that always runs from the 27th of each month to the 2nd of the next month. If you calculate this period using a standard constructor, then you will get between P3D and P6D depending on the month. If you use this method, then you will get P1M-25D. This field-difference based period can be successfully applied to each month of the year to obtain the correct end date for a given start date.
- Parameters:
start
- the start of the period, must not be nullend
- the end of the period, must not be null
- Since:
- 1.1
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 static Period hours(int hours)
Create a period with a specified number of hours. The standard period type is used, thus you can add other fields such as months or days using thewithXxx()
methods. For example,Period.hours(2).withMinutes(30);
If you want a hour-based period that cannot have other fields added, then you should consider usingHours
.
- Parameters:
hours
- the amount of hours in this period
- Returns:
- the period
public static Period millis(int millis)
Create a period with a specified number of millis. The standard period type is used, thus you can add other fields such as days or hours using thewithXxx()
methods. For example,Period.millis(20).withSeconds(30);
- Parameters:
millis
- the amount of millis in this period
- Returns:
- the period
public Period minus(ReadablePeriod period)
Returns a new period with the specified period subtracted. Each field of the period is subtracted separately. Thus a period of 3 hours 30 minutes minus 2 hours 40 minutes will produce a result of 1 hour and -10 minutes - seenormalizedStandard()
. If the period being added contains a non-zero amount for a field that is not supported in this period then an exception is thrown. This period instance is immutable and unaffected by this method call.
- Parameters:
period
- the period to add, null adds zero and returns this
- Returns:
- the new updated period
- Since:
- 1.5
public Period minusDays(int days)
Returns a new period minus the specified number of days taken away. This period instance is immutable and unaffected by this method call.
- Parameters:
days
- the amount of days to take away, may be negative
- Returns:
- the new period minus the increased days
public Period minusHours(int hours)
Returns a new period minus the specified number of hours taken away. This period instance is immutable and unaffected by this method call.
- Parameters:
hours
- the amount of hours to take away, may be negative
- Returns:
- the new period minus the increased hours
public Period minusMillis(int millis)
Returns a new period minus the specified number of millis taken away. This period instance is immutable and unaffected by this method call.
- Parameters:
millis
- the amount of millis to take away, may be negative
- Returns:
- the new period minus the increased millis
public Period minusMinutes(int minutes)
Returns a new period minus the specified number of minutes taken away. This period instance is immutable and unaffected by this method call.
- Parameters:
minutes
- the amount of minutes to take away, may be negative
- Returns:
- the new period minus the increased minutes
public Period minusMonths(int months)
Returns a new period minus the specified number of months taken away. This period instance is immutable and unaffected by this method call.
- Parameters:
months
- the amount of months to take away, may be negative
- Returns:
- the new period minus the increased months
public Period minusSeconds(int seconds)
Returns a new period minus the specified number of seconds taken away. This period instance is immutable and unaffected by this method call.
- Parameters:
seconds
- the amount of seconds to take away, may be negative
- Returns:
- the new period minus the increased seconds
public Period minusWeeks(int weeks)
Returns a new period minus the specified number of weeks taken away. This period instance is immutable and unaffected by this method call.
- Parameters:
weeks
- the amount of weeks to take away, may be negative
- Returns:
- the new period minus the increased weeks
public Period minusYears(int years)
Returns a new period with the specified number of years taken away. This period instance is immutable and unaffected by this method call.
- Parameters:
years
- the amount of years to take away, may be negative
- Returns:
- the new period with the increased years
public static Period minutes(int minutes)
Create a period with a specified number of minutes. The standard period type is used, thus you can add other fields such as days or hours using thewithXxx()
methods. For example,Period.minutes(2).withSeconds(30);
If you want a minute-based period that cannot have other fields added, then you should consider usingMinutes
.
- Parameters:
minutes
- the amount of minutes in this period
- Returns:
- the period
public static Period months(int months)
Create a period with a specified number of months. The standard period type is used, thus you can add other fields such as years or days using thewithXxx()
methods. For example,Period.months(2).withDays(6);
If you want a month-based period that cannot have other fields added, then you should consider usingMonths
.
- Parameters:
months
- the amount of months in this period
- Returns:
- the period
public Period normalizedStandard()
Normalizes this period using standard rules, assuming a 12 month year, 7 day week, 24 hour day, 60 minute hour and 60 second minute. This method allows you to normalize a period. However to achieve this it makes the assumption that all years are 12 months, all weeks are 7 days, all days are 24 hours, all hours are 60 minutes and all minutes are 60 seconds. This is not true when daylight savings time is considered, and may also not be true for some chronologies. However, it is included as it is a useful operation for many applications and business rules. If the period contains years or months, then the months will be normalized to be between 0 and 11. The days field and below will be normalized as necessary, however this will not overflow into the months field. Thus a period of 1 year 15 months will normalize to 2 years 3 months. But a period of 1 month 40 days will remain as 1 month 40 days. The result will always have aPeriodType
of standard, thus days will be grouped into weeks.
- Returns:
- a normalized period equivalent to this period
- Since:
- 1.5
public Period normalizedStandard(PeriodType type)
Normalizes this period using standard rules, assuming a 12 month year, 7 day week, 24 hour day, 60 minute hour and 60 second minute, providing control over how the result is split into fields. This method allows you to normalize a period. However to achieve this it makes the assumption that all years are 12 months, all weeks are 7 days, all days are 24 hours, all hours are 60 minutes and all minutes are 60 seconds. This is not true when daylight savings time is considered, and may also not be true for some chronologies. However, it is included as it is a useful operation for many applications and business rules. If the period contains years or months, then the months will be normalized to be between 0 and 11. The days field and below will be normalized as necessary, however this will not overflow into the months field. Thus a period of 1 year 15 months will normalize to 2 years 3 months. But a period of 1 month 40 days will remain as 1 month 40 days. The PeriodType parameter controls how the result is created. It allows you to omit certain fields from the result if desired. For example, you may not want the result to include weeks, in which case you pass inPeriodType.yearMonthDayTime()
.
- Parameters:
type
- the period type of the new period, null means standard type
- Returns:
- a normalized period equivalent to this period
- Since:
- 1.5
public Period plus(ReadablePeriod period)
Returns a new period with the specified period added. Each field of the period is added separately. Thus a period of 2 hours 30 minutes plus 3 hours 40 minutes will produce a result of 5 hours 70 minutes - seenormalizedStandard()
. If the period being added contains a non-zero amount for a field that is not supported in this period then an exception is thrown. This period instance is immutable and unaffected by this method call.
- Parameters:
period
- the period to add, null adds zero and returns this
- Returns:
- the new updated period
- Since:
- 1.5
public Period plusDays(int days)
Returns a new period plus the specified number of days added. This period instance is immutable and unaffected by this method call.
- Parameters:
days
- the amount of days to add, may be negative
- Returns:
- the new period plus the increased days
public Period plusHours(int hours)
Returns a new period plus the specified number of hours added. This period instance is immutable and unaffected by this method call.
- Parameters:
hours
- the amount of hours to add, may be negative
- Returns:
- the new period plus the increased hours
public Period plusMillis(int millis)
Returns a new period plus the specified number of millis added. This period instance is immutable and unaffected by this method call.
- Parameters:
millis
- the amount of millis to add, may be negative
- Returns:
- the new period plus the increased millis
public Period plusMinutes(int minutes)
Returns a new period plus the specified number of minutes added. This period instance is immutable and unaffected by this method call.
- Parameters:
minutes
- the amount of minutes to add, may be negative
- Returns:
- the new period plus the increased minutes
public Period plusMonths(int months)
Returns a new period plus the specified number of months added. This period instance is immutable and unaffected by this method call.
- Parameters:
months
- the amount of months to add, may be negative
- Returns:
- the new period plus the increased months
public Period plusSeconds(int seconds)
Returns a new period plus the specified number of seconds added. This period instance is immutable and unaffected by this method call.
- Parameters:
seconds
- the amount of seconds to add, may be negative
- Returns:
- the new period plus the increased seconds
public Period plusWeeks(int weeks)
Returns a new period plus the specified number of weeks added. This period instance is immutable and unaffected by this method call.
- Parameters:
weeks
- the amount of weeks to add, may be negative
- Returns:
- the new period plus the increased weeks
public Period plusYears(int years)
Returns a new period with the specified number of years added. This period instance is immutable and unaffected by this method call.
- Parameters:
years
- the amount of years to add, may be negative
- Returns:
- the new period with the increased years
public static Period seconds(int seconds)
Create a period with a specified number of seconds. The standard period type is used, thus you can add other fields such as days or hours using thewithXxx()
methods. For example,Period.seconds(2).withMillis(30);
If you want a second-based period that cannot have other fields added, then you should consider usingSeconds
.
- Parameters:
seconds
- the amount of seconds in this period
- Returns:
- the period
public Period toPeriod()
Get this period as an immutablePeriod
object by returningthis
.
- Specified by:
- toPeriod in interface ReadablePeriod
- Overrides:
- toPeriod in interface AbstractPeriod
- Returns:
this
public Days toStandardDays()
Converts this period to a period in days assuming a 7 day week, 24 hour day, 60 minute hour and 60 second minute. This method allows you to convert between different types of period. However to achieve this it makes the assumption that all weeks are 7 days, all days are 24 hours, all hours are 60 minutes and all minutes are 60 seconds. This is not true when daylight savings time is considered, and may also not be true for some unusual chronologies. However, it is included as it is a useful operation for many applications and business rules. If the period contains years or months, an exception will be thrown.
- Returns:
- a period representing the number of standard days in this period
- Since:
- 1.5
public Duration toStandardDuration()
Converts this period to a duration assuming a 7 day week, 24 hour day, 60 minute hour and 60 second minute. This method allows you to convert from a period to a duration. However to achieve this it makes the assumption that all weeks are 7 days, all days are 24 hours, all hours are 60 minutes and all minutes are 60 seconds. This is not true when daylight savings time is considered, and may also not be true for some unusual chronologies. However, it is included as it is a useful operation for many applications and business rules. If the period contains years or months, an exception will be thrown.
- Returns:
- a duration equivalent to this period
- Since:
- 1.5
public Hours toStandardHours()
Converts this period to a period in hours assuming a 7 day week, 24 hour day, 60 minute hour and 60 second minute. This method allows you to convert between different types of period. However to achieve this it makes the assumption that all weeks are 7 days, all days are 24 hours, all hours are 60 minutes and all minutes are 60 seconds. This is not true when daylight savings time is considered, and may also not be true for some unusual chronologies. However, it is included as it is a useful operation for many applications and business rules. If the period contains years or months, an exception will be thrown.
- Returns:
- a period representing the number of standard hours in this period
- Since:
- 1.5
public Minutes toStandardMinutes()
Converts this period to a period in minutes assuming a 7 day week, 24 hour day, 60 minute hour and 60 second minute. This method allows you to convert between different types of period. However to achieve this it makes the assumption that all weeks are 7 days, all days are 24 hours, all hours are 60 minutes and all minutes are 60 seconds. This is not true when daylight savings time is considered, and may also not be true for some unusual chronologies. However, it is included as it is a useful operation for many applications and business rules. If the period contains years or months, an exception will be thrown.
- Returns:
- a period representing the number of standard minutes in this period
- Since:
- 1.5
public Seconds toStandardSeconds()
Converts this period to a period in seconds assuming a 7 day week, 24 hour day, 60 minute hour and 60 second minute. This method allows you to convert between different types of period. However to achieve this it makes the assumption that all weeks are 7 days, all days are 24 hours, all hours are 60 minutes and all minutes are 60 seconds. This is not true when daylight savings time is considered, and may also not be true for some unusual chronologies. However, it is included as it is a useful operation for many applications and business rules. If the period contains years or months, an exception will be thrown.
- Returns:
- a period representing the number of standard seconds in this period
- Since:
- 1.5
public Weeks toStandardWeeks()
Converts this period to a period in weeks assuming a 7 day week, 24 hour day, 60 minute hour and 60 second minute. This method allows you to convert between different types of period. However to achieve this it makes the assumption that all weeks are 7 days, all days are 24 hours, all hours are 60 minutes and all minutes are 60 seconds. This is not true when daylight savings time is considered, and may also not be true for some unusual chronologies. However, it is included as it is a useful operation for many applications and business rules. If the period contains years or months, an exception will be thrown.
- Returns:
- a period representing the number of standard weeks in this period
- Since:
- 1.5
public static Period weeks(int weeks)
Create a period with a specified number of weeks. The standard period type is used, thus you can add other fields such as months or days using thewithXxx()
methods. For example,Period.weeks(2).withDays(6);
If you want a week-based period that cannot have other fields added, then you should consider usingWeeks
.
- Parameters:
weeks
- the amount of weeks in this period
- Returns:
- the period
public Period withDays(int days)
Returns a new period with the specified number of days. This period instance is immutable and unaffected by this method call.
- Parameters:
days
- the amount of days to add, may be negative
- Returns:
- the new period with the increased days
public Period withField(DurationFieldType field, int value)
Creates a new Period instance with the specified field set to a new value. This period instance is immutable and unaffected by this method call.
- Parameters:
field
- the field to set, not nullvalue
- the value to set to
- Returns:
- the new period instance
public Period withFieldAdded(DurationFieldType field, int value)
Creates a new Period instance with the valueToAdd added to the specified field. This period instance is immutable and unaffected by this method call.
- Parameters:
field
- the field to set, not nullvalue
- the value to add
- Returns:
- the new period instance
public Period withFields(ReadablePeriod period)
Creates a new Period instance with the fields from the specified period copied on top of those from this period. This period instance is immutable and unaffected by this method call.
- Parameters:
period
- the period to copy from, null ignored
- Returns:
- the new period instance
public Period withHours(int hours)
Returns a new period with the specified number of hours. This period instance is immutable and unaffected by this method call.
- Parameters:
hours
- the amount of hours to add, may be negative
- Returns:
- the new period with the increased hours
public Period withMillis(int millis)
Returns a new period with the specified number of millis. This period instance is immutable and unaffected by this method call.
- Parameters:
millis
- the amount of millis to add, may be negative
- Returns:
- the new period with the increased millis
public Period withMinutes(int minutes)
Returns a new period with the specified number of minutes. This period instance is immutable and unaffected by this method call.
- Parameters:
minutes
- the amount of minutes to add, may be negative
- Returns:
- the new period with the increased minutes
public Period withMonths(int months)
Returns a new period with the specified number of months. This period instance is immutable and unaffected by this method call.
- Parameters:
months
- the amount of months to add, may be negative
- Returns:
- the new period with the increased months
public Period withPeriodType(PeriodType type)
Creates a new Period instance with the same field values but different PeriodType. This period instance is immutable and unaffected by this method call.
- Parameters:
type
- the period type to use, null means standard
- Returns:
- the new period instance
public Period withSeconds(int seconds)
Returns a new period with the specified number of seconds. This period instance is immutable and unaffected by this method call.
- Parameters:
seconds
- the amount of seconds to add, may be negative
- Returns:
- the new period with the increased seconds
public Period withWeeks(int weeks)
Returns a new period with the specified number of weeks. This period instance is immutable and unaffected by this method call.
- Parameters:
weeks
- the amount of weeks to add, may be negative
- Returns:
- the new period with the increased weeks
public Period withYears(int years)
Returns a new period with the specified number of years. This period instance is immutable and unaffected by this method call.
- Parameters:
years
- the amount of years to add, may be negative
- Returns:
- the new period with the increased years
public static Period years(int years)
Create a period with a specified number of years. The standard period type is used, thus you can add other fields such as months or days using thewithXxx()
methods. For example,Period.years(2).withMonths(6);
If you want a year-based period that cannot have other fields added, then you should consider usingYears
.
- Parameters:
years
- the amount of years in this period
- Returns:
- the period