| java.lang.Object
 org.joda.time.base.BaseSingleFieldPeriod
org.joda.time.Weeks
| Weeks | | final public class Weeks extends BaseSingleFieldPeriod (Code) | | 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.
author:
Stephen Colebourne
since:
1.4 |
| Field Summary | |
| final public static Weeks | MAX_VALUE
Constant representing the maximum number of weeks that can be stored in this object. | | final public static Weeks | MIN_VALUE
Constant representing the minimum number of weeks that can be stored in this object. | | final public static Weeks | ONE
Constant representing one week. | | final public static Weeks | THREE
Constant representing three weeks. | | final public static Weeks | TWO
Constant representing two weeks. | | final public static Weeks | ZERO
Constant representing zero weeks. |
| Method Summary | |
| public Weeks | dividedBy(int divisor)
Returns a new instance with the weeks divided by the specified divisor. | | public DurationFieldType | getFieldType()
Gets the duration field type, which is weeks. | | public PeriodType | getPeriodType()
Gets the period type, which is weeks. | | public int | getWeeks()
Gets the number of weeks that this period represents. | | public boolean | isGreaterThan(Weeks other)
Is this weeks instance greater than the specified number of weeks. | | public boolean | isLessThan(Weeks other)
Is this weeks instance less than the specified number of weeks. | | public Weeks | minus(int weeks)
Returns a new instance with the specified number of weeks taken away. | | public Weeks | minus(Weeks weeks)
Returns a new instance with the specified number of weeks taken away. | | public Weeks | multipliedBy(int scalar)
Returns a new instance with the weeks multiplied by the specified scalar. | | public Weeks | negated()
Returns a new instance with the weeks value negated. | | public static Weeks | parseWeeks(String periodStr)
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. | | public Weeks | plus(int weeks)
Returns a new instance with the specified number of weeks added. | | public Weeks | plus(Weeks weeks)
Returns a new instance with the specified number of weeks added. | | public static Weeks | standardWeeksIn(ReadablePeriod period)
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. | | public Days | 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. | | public Duration | 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. | | public Hours | 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. | | public Minutes | 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. | | public Seconds | 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. | | public String | toString()
Gets this instance as a String in the ISO8601 duration format. | | public static Weeks | weeks(int weeks)
Obtains an instance of Weeks that may be cached. | | public static Weeks | weeksBetween(ReadableInstant start, ReadableInstant end)
Creates a Weeks representing the number of whole weeks
between the two specified datetimes. | | public static Weeks | weeksBetween(ReadablePartial start, ReadablePartial end)
Creates a Weeks representing the number of whole weeks
between the two specified partial datetimes. | | public static Weeks | weeksIn(ReadableInterval interval)
Creates a Weeks representing the number of whole weeks
in the specified interval. |
| MAX_VALUE | | final public static Weeks MAX_VALUE(Code) | | Constant representing the maximum number of weeks that can be stored in this object.
|
| MIN_VALUE | | final public static Weeks MIN_VALUE(Code) | | Constant representing the minimum number of weeks that can be stored in this object.
|
| ONE | | final public static Weeks ONE(Code) | | Constant representing one week.
|
| THREE | | final public static Weeks THREE(Code) | | Constant representing three weeks.
|
| TWO | | final public static Weeks TWO(Code) | | Constant representing two weeks.
|
| ZERO | | final public static Weeks ZERO(Code) | | Constant representing zero weeks.
|
| dividedBy | | public Weeks dividedBy(int divisor)(Code) | | 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 the new period divided by the specified divisor
throws:
ArithmeticException - if the divisor is zero |
| getFieldType | | public DurationFieldType getFieldType()(Code) | | Gets the duration field type, which is weeks.
the period type |
| getPeriodType | | public PeriodType getPeriodType()(Code) | | Gets the period type, which is weeks.
the period type |
| getWeeks | | public int getWeeks()(Code) | | Gets the number of weeks that this period represents.
the number of weeks in the period |
| isGreaterThan | | public boolean isGreaterThan(Weeks other)(Code) | | Is this weeks instance greater than the specified number of weeks.
Parameters:
other - the other period, null means zero true if this weeks instance is greater than the specified one |
| isLessThan | | public boolean isLessThan(Weeks other)(Code) | | Is this weeks instance less than the specified number of weeks.
Parameters:
other - the other period, null means zero true if this weeks instance is less than the specified one |
| minus | | public Weeks minus(int weeks)(Code) | | 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 the new period minus the specified number of weeks
throws:
ArithmeticException - if the result overflows an int |
| minus | | public Weeks minus(Weeks weeks)(Code) | | 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 the new period minus the specified number of weeks
throws:
ArithmeticException - if the result overflows an int |
| multipliedBy | | public Weeks multipliedBy(int scalar)(Code) | | 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 the new period multiplied by the specified scalar
throws:
ArithmeticException - if the result overflows an int |
| negated | | public Weeks negated()(Code) | | Returns a new instance with the weeks value negated.
the new period with a negated value
throws:
ArithmeticException - if the result overflows an int |
| parseWeeks | | public static Weeks parseWeeks(String periodStr)(Code) | | 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.
Parameters:
periodStr - the period string, null returns zero the period in weeks
throws:
IllegalArgumentException - if the string format is invalid |
| plus | | public Weeks plus(int weeks)(Code) | | 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 the new period plus the specified number of weeks
throws:
ArithmeticException - if the result overflows an int |
| plus | | public Weeks plus(Weeks weeks)(Code) | | 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 the new period plus the specified number of weeks
throws:
ArithmeticException - if the result overflows an int |
| standardWeeksIn | | public static Weeks standardWeeksIn(ReadablePeriod period)(Code) | | 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.
- 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.
Months and Years are imprecise and periods containing these values cannot be converted.
Parameters:
period - the period to get the number of hours from, null returns zero the period in weeks
throws:
IllegalArgumentException - if the period contains imprecise duration values |
| toStandardDays | | public Days toStandardDays()(Code) | | 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.
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 |
| toStandardDuration | | public Duration toStandardDuration()(Code) | | 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.
a duration equivalent to this number of weeks |
| toStandardHours | | public Hours toStandardHours()(Code) | | 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.
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 | | public Minutes toStandardMinutes()(Code) | | 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.
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 | | public Seconds toStandardSeconds()(Code) | | 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.
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 |
| toString | | public String toString()(Code) | | Gets this instance as a String in the ISO8601 duration format.
For example, "P4W" represents 4 weeks.
the value as an ISO8601 string |
| weeks | | public static Weeks weeks(int weeks)(Code) | | 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.
Parameters:
weeks - the number of weeks to obtain an instance for the instance of Weeks |
| weeksBetween | | public static Weeks weeksBetween(ReadableInstant start, ReadableInstant end)(Code) | | Creates a Weeks representing the number of whole weeks
between the two specified datetimes.
Parameters:
start - the start instant, must not be null
Parameters:
end - the end instant, must not be null the period in weeks
throws:
IllegalArgumentException - if the instants are null or invalid |
| weeksBetween | | public static Weeks weeksBetween(ReadablePartial start, ReadablePartial end)(Code) | | 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.
Parameters:
start - the start partial date, must not be null
Parameters:
end - the end partial date, must not be null the period in weeks
throws:
IllegalArgumentException - if the partials are null or invalid |
| weeksIn | | public static Weeks weeksIn(ReadableInterval interval)(Code) | | Creates a Weeks representing the number of whole weeks
in the specified interval.
Parameters:
interval - the interval to extract weeks from, null returns zero the period in weeks
throws:
IllegalArgumentException - if the partials are null or invalid |
|
|