java.lang.Object | ||
↳ | org.joda.time.base.BaseSingleFieldPeriod | |
↳ | org.joda.time.Weeks |
An immutable time period representing a number of weeks.
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.
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
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. | ||||||||||
ONE | Constant representing one week. | ||||||||||
THREE | Constant representing three weeks. | ||||||||||
TWO | Constant representing two weeks. | ||||||||||
ZERO | Constant representing zero weeks. |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns a new instance with the weeks divided by the specified divisor.
| |||||||||||
Gets the duration field type, which is
weeks . | |||||||||||
Gets the period type, which is
weeks . | |||||||||||
Gets the number of weeks that this period represents.
| |||||||||||
Is this weeks instance greater than the specified number of weeks.
| |||||||||||
Is this weeks instance less than the specified number of 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.
| |||||||||||
Returns a new instance with the weeks multiplied by the specified scalar.
| |||||||||||
Returns a new instance with the weeks value negated.
| |||||||||||
Creates a new
Weeks by parsing a string in the ISO8601 format 'PnW'. | |||||||||||
Returns a new instance with the specified number of weeks added.
| |||||||||||
Returns a new instance with the specified number of weeks added.
| |||||||||||
Creates a new
Weeks 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.
| |||||||||||
Gets this instance as a String in the ISO8601 duration format.
| |||||||||||
Obtains an instance of
Weeks that may be cached. | |||||||||||
Creates a
Weeks representing the number of whole weeks
between the two specified partial datetimes. | |||||||||||
Creates a
Weeks representing the number of whole weeks
between the two specified datetimes. | |||||||||||
Creates a
Weeks representing the number of whole weeks
in the specified interval. |
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.joda.time.base.BaseSingleFieldPeriod
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
java.lang.Comparable
| |||||||||||
From interface
org.joda.time.ReadablePeriod
|
Constant representing the maximum number of weeks that can be stored in this object.
Constant representing the minimum number of weeks that can be stored in this object.
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.
divisor | the amount to divide by, may be negative |
---|
ArithmeticException | if the divisor is zero |
---|
Gets the duration field type, which is weeks
.
Gets the number of weeks that this period represents.
Is this weeks instance greater than the specified number of weeks.
other | the other period, null means zero |
---|
Is this weeks instance less than the specified number of weeks.
other | the other period, null means zero |
---|
Returns a new instance with the specified number of weeks taken away.
This instance is immutable and unaffected by this method call.
weeks | the amount of weeks to take away, may be negative |
---|
ArithmeticException | if the result overflows an int |
---|
Returns a new instance with the specified number of weeks taken away.
This instance is immutable and unaffected by this method call.
weeks | the amount of weeks to take away, may be negative, null means zero |
---|
ArithmeticException | if the result overflows an int |
---|
Returns a new instance with the weeks multiplied by the specified scalar.
This instance is immutable and unaffected by this method call.
scalar | the amount to multiply by, may be negative |
---|
ArithmeticException | if the result overflows an int |
---|
Returns a new instance with the weeks value negated.
ArithmeticException | if the result overflows an int |
---|
Creates a new Weeks
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.
periodStr | the period string, null returns zero |
---|
IllegalArgumentException | if the string format is invalid |
---|
Returns a new instance with the specified number of weeks added.
This instance is immutable and unaffected by this method call.
weeks | the amount of weeks to add, may be negative, null means zero |
---|
ArithmeticException | if the result overflows an int |
---|
Returns a new instance with the specified number of weeks added.
This instance is immutable and unaffected by this method call.
weeks | the amount of weeks to add, may be negative |
---|
ArithmeticException | if the result overflows an int |
---|
Creates a new Weeks
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.
period | the period to get the number of hours from, null returns zero |
---|
IllegalArgumentException | if the period contains imprecise duration values |
---|
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.
ArithmeticException | if the number of days is too large to be represented |
---|
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.
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.
ArithmeticException | if the number of hours is too large to be represented |
---|
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.
ArithmeticException | if the number of minutes is too large to be represented |
---|
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.
ArithmeticException | if the number of seconds is too large to be represented |
---|
Gets this instance as a String in the ISO8601 duration format.
For example, "P4W" represents 4 weeks.
Obtains an instance of Weeks
that may be cached.
Weeks
is immutable, so instances can be cached and shared.
This factory method provides access to shared instances.
weeks | the number of weeks to obtain an instance for |
---|
Creates a Weeks
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.
start | the start partial date, must not be null |
---|---|
end | the end partial date, must not be null |
IllegalArgumentException | if the partials are null or invalid |
---|
Creates a Weeks
representing the number of whole weeks
between the two specified datetimes.
start | the start instant, must not be null |
---|---|
end | the end instant, must not be null |
IllegalArgumentException | if the instants are null or invalid |
---|
Creates a Weeks
representing the number of whole weeks
in the specified interval.
interval | the interval to extract weeks from, null returns zero |
---|
IllegalArgumentException | if the partials are null or invalid |
---|