Class Weeks
- All Implemented Interfaces:
Serializable
,Comparable<BaseSingleFieldPeriod>
,ReadablePeriod
Weeks
is an immutable period that can only store weeks.
It does not store years, months or hours for example. As such it is a
type-safe way of representing a number of weeks in an application.
The number of weeks is set in the constructor, and may be queried using
getWeeks()
. Basic mathematical operations are provided -
plus()
, minus()
, multipliedBy()
and
dividedBy()
.
Weeks
is thread-safe and immutable.
- Since:
- 1.4
- Author:
- Stephen Colebourne
- See Also:
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Weeks
Constant representing the maximum number of weeks that can be stored in this object.static final Weeks
Constant representing the minimum number of weeks that can be stored in this object.static final Weeks
Constant representing one week.static final Weeks
Constant representing three weeks.static final Weeks
Constant representing two weeks.static final Weeks
Constant representing zero weeks. -
Method Summary
Modifier and TypeMethodDescriptiondividedBy
(int divisor) Returns a new instance with the weeks divided by the specified divisor.Gets the duration field type, which isweeks
.Gets the period type, which isweeks
.int
getWeeks()
Gets the number of weeks that this period represents.boolean
isGreaterThan
(Weeks other) Is this weeks instance greater than the specified number of weeks.boolean
isLessThan
(Weeks other) Is this weeks instance less than the specified number of weeks.minus
(int weeks) Returns a new instance with the specified number of weeks taken away.Returns a new instance with the specified number of weeks taken away.multipliedBy
(int scalar) Returns a new instance with the weeks multiplied by the specified scalar.negated()
Returns a new instance with the weeks value negated.static Weeks
parseWeeks
(String periodStr) Creates a newWeeks
by parsing a string in the ISO8601 format 'PnW'.plus
(int weeks) Returns a new instance with the specified number of weeks added.Returns a new instance with the specified number of weeks added.static Weeks
standardWeeksIn
(ReadablePeriod period) Creates a newWeeks
representing the number of complete standard length weeks in the specified period.Converts this period in weeks to a period in days assuming a 7 day week.Converts this period in weeks to a duration in milliweeks assuming a 7 day week, 24 hour day, 60 minute hour and 60 second minute.Converts this period in weeks to a period in hours assuming a 7 day week and 24 hour day.Converts this period in weeks to a period in minutes assuming a 7 day week, 24 hour day and 60 minute hour.Converts this period in weeks to a period in seconds assuming a 7 day week, 24 hour day, 60 minute hour and 60 second minute.toString()
Gets this instance as a String in the ISO8601 duration format.static Weeks
weeks
(int weeks) Obtains an instance ofWeeks
that may be cached.static Weeks
weeksBetween
(ReadableInstant start, ReadableInstant end) Creates aWeeks
representing the number of whole weeks between the two specified datetimes.static Weeks
weeksBetween
(ReadablePartial start, ReadablePartial end) Creates aWeeks
representing the number of whole weeks between the two specified partial datetimes.static Weeks
weeksIn
(ReadableInterval interval) Creates aWeeks
representing the number of whole weeks in the specified interval.Methods inherited from class org.joda.time.base.BaseSingleFieldPeriod
between, between, compareTo, equals, get, getFieldType, getValue, getValue, hashCode, isSupported, setValue, size, standardPeriodIn, toMutablePeriod, toPeriod
-
Field Details
-
ZERO
Constant representing zero weeks. -
ONE
Constant representing one week. -
TWO
Constant representing two weeks. -
THREE
Constant representing three weeks. -
MAX_VALUE
Constant representing the maximum number of weeks that can be stored in this object. -
MIN_VALUE
Constant representing the minimum number of weeks that can be stored in this object.
-
-
Method Details
-
weeks
Obtains an instance ofWeeks
that may be cached.Weeks
is immutable, so instances can be cached and shared. This factory method provides access to shared instances.- Parameters:
weeks
- the number of weeks to obtain an instance for- Returns:
- the instance of Weeks
-
weeksBetween
Creates aWeeks
representing the number of whole weeks between the two specified datetimes.- Parameters:
start
- the start instant, must not be nullend
- the end instant, must not be null- Returns:
- the period in weeks
- Throws:
IllegalArgumentException
- if the instants are null or invalid
-
weeksBetween
Creates aWeeks
representing the number of whole weeks between the two specified partial datetimes.The two partials must contain the same fields, for example you can specify two
LocalDate
objects.- Parameters:
start
- the start partial date, must not be nullend
- the end partial date, must not be null- Returns:
- the period in weeks
- Throws:
IllegalArgumentException
- if the partials are null or invalid
-
weeksIn
Creates aWeeks
representing the number of whole weeks in the specified interval.- Parameters:
interval
- the interval to extract weeks from, null returns zero- Returns:
- the period in weeks
- Throws:
IllegalArgumentException
- if the partials are null or invalid
-
standardWeeksIn
Creates a newWeeks
representing the number of complete standard length weeks in the specified period.This factory method converts all fields from the period to hours using standardised durations for each field. Only those fields which have a precise duration in the ISO UTC chronology can be converted.
- One week consists of 7 days.
- One day consists of 24 hours.
- One hour consists of 60 minutes.
- One minute consists of 60 weeks.
- One second consists of 1000 milliseconds.
- Parameters:
period
- the period to get the number of hours from, null returns zero- Returns:
- the period in weeks
- Throws:
IllegalArgumentException
- if the period contains imprecise duration values
-
parseWeeks
Creates a newWeeks
by parsing a string in the ISO8601 format 'PnW'.The parse will accept the full ISO syntax of PnYnMnWnDTnHnMnS however only the weeks component may be non-zero. If any other component is non-zero, an exception will be thrown.
- Parameters:
periodStr
- the period string, null returns zero- Returns:
- the period in weeks
- Throws:
IllegalArgumentException
- if the string format is invalid
-
getFieldType
Gets the duration field type, which isweeks
.- Specified by:
getFieldType
in classBaseSingleFieldPeriod
- Returns:
- the period type
-
getPeriodType
Gets the period type, which isweeks
.- Specified by:
getPeriodType
in interfaceReadablePeriod
- Specified by:
getPeriodType
in classBaseSingleFieldPeriod
- Returns:
- the period type
-
toStandardDays
Converts this period in weeks to a period in days assuming a 7 day week.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 long. This may not be true for some unusual chronologies. However, it is included as it is a useful operation for many applications and business rules.
- Returns:
- a period representing the number of days for this number of weeks
- Throws:
ArithmeticException
- if the number of days is too large to be represented
-
toStandardHours
Converts this period in weeks to a period in hours assuming a 7 day week and 24 hour day.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 long and all days are 24 hours long. This is not true when daylight savings 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.
- Returns:
- a period representing the number of hours for this number of weeks
- Throws:
ArithmeticException
- if the number of hours is too large to be represented
-
toStandardMinutes
Converts this period in weeks to a period in minutes assuming a 7 day week, 24 hour day and 60 minute hour.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 long, all days are 24 hours long and all hours are 60 minutes long. This is not true when daylight savings 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.
- Returns:
- a period representing the number of minutes for this number of weeks
- Throws:
ArithmeticException
- if the number of minutes is too large to be represented
-
toStandardSeconds
Converts this period in weeks 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 long, all days are 24 hours long, all hours are 60 minutes long and all minutes are 60 seconds long. This is not true when daylight savings 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.
- Returns:
- a period representing the number of seconds for this number of weeks
- Throws:
ArithmeticException
- if the number of seconds is too large to be represented
-
toStandardDuration
Converts this period in weeks to a duration in milliweeks 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 long, all days are 24 hours long, all hours are 60 minutes long and all minutes are 60 seconds long. 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.
- Returns:
- a duration equivalent to this number of weeks
-
getWeeks
public int getWeeks()Gets the number of weeks that this period represents.- Returns:
- the number of weeks in the period
-
plus
Returns a new instance with the specified number of weeks added.This 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 specified number of weeks
- Throws:
ArithmeticException
- if the result overflows an int
-
plus
Returns a new instance with the specified number of weeks added.This instance is immutable and unaffected by this method call.
- Parameters:
weeks
- the amount of weeks to add, may be negative, null means zero- Returns:
- the new period plus the specified number of weeks
- Throws:
ArithmeticException
- if the result overflows an int
-
minus
Returns a new instance with the specified number of weeks taken away.This 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 specified number of weeks
- Throws:
ArithmeticException
- if the result overflows an int
-
minus
Returns a new instance with the specified number of weeks taken away.This instance is immutable and unaffected by this method call.
- Parameters:
weeks
- the amount of weeks to take away, may be negative, null means zero- Returns:
- the new period minus the specified number of weeks
- Throws:
ArithmeticException
- if the result overflows an int
-
multipliedBy
Returns a new instance with the weeks multiplied by the specified scalar.This instance is immutable and unaffected by this method call.
- Parameters:
scalar
- the amount to multiply by, may be negative- Returns:
- the new period multiplied by the specified scalar
- Throws:
ArithmeticException
- if the result overflows an int
-
dividedBy
Returns a new instance with the weeks divided by the specified divisor. The calculation uses integer division, thus 3 divided by 2 is 1.This instance is immutable and unaffected by this method call.
- Parameters:
divisor
- the amount to divide by, may be negative- Returns:
- the new period divided by the specified divisor
- Throws:
ArithmeticException
- if the divisor is zero
-
negated
Returns a new instance with the weeks value negated.- Returns:
- the new period with a negated value
- Throws:
ArithmeticException
- if the result overflows an int
-
isGreaterThan
Is this weeks instance greater than the specified number of weeks.- Parameters:
other
- the other period, null means zero- Returns:
- true if this weeks instance is greater than the specified one
-
isLessThan
Is this weeks instance less than the specified number of weeks.- Parameters:
other
- the other period, null means zero- Returns:
- true if this weeks instance is less than the specified one
-
toString
Gets this instance as a String in the ISO8601 duration format.For example, "P4W" represents 4 weeks.
- Specified by:
toString
in interfaceReadablePeriod
- Overrides:
toString
in classObject
- Returns:
- the value as an ISO8601 string
-