public final class Weeks extends BaseSingleFieldPeriod
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
typesafe 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 threadsafe and immutable.
Modifier and Type  Field and Description 

static Weeks 
MAX_VALUE
Constant representing the maximum number of weeks that can be stored in this object.

static Weeks 
MIN_VALUE
Constant representing the minimum number of weeks that can be stored in this object.

static Weeks 
ONE
Constant representing one week.

static Weeks 
THREE
Constant representing three weeks.

static Weeks 
TWO
Constant representing two weeks.

static Weeks 
ZERO
Constant representing zero weeks.

Modifier and Type  Method and Description 

Weeks 
dividedBy(int divisor)
Returns a new instance with the weeks divided by the specified divisor.

DurationFieldType 
getFieldType()
Gets the duration field type, which is
weeks . 
PeriodType 
getPeriodType()
Gets the period type, which is
weeks . 
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.

Weeks 
minus(int weeks)
Returns a new instance with the specified number of weeks taken away.

Weeks 
minus(Weeks weeks)
Returns a new instance with the specified number of weeks taken away.

Weeks 
multipliedBy(int scalar)
Returns a new instance with the weeks multiplied by the specified scalar.

Weeks 
negated()
Returns a new instance with the weeks value negated.

static Weeks 
parseWeeks(String periodStr)
Creates a new
Weeks by parsing a string in the ISO8601 format 'PnW'. 
Weeks 
plus(int weeks)
Returns a new instance with the specified number of weeks added.

Weeks 
plus(Weeks weeks)
Returns a new instance with the specified number of weeks added.

static Weeks 
standardWeeksIn(ReadablePeriod period)
Creates a new
Weeks representing the number of complete
standard length weeks in the specified period. 
Days 
toStandardDays()
Converts this period in weeks to a period in days assuming a
7 day week.

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.

Hours 
toStandardHours()
Converts this period in weeks to a period in hours assuming a
7 day week and 24 hour day.

Minutes 
toStandardMinutes()
Converts this period in weeks to a period in minutes assuming a
7 day week, 24 hour day and 60 minute hour.

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.

String 
toString()
Gets this instance as a String in the ISO8601 duration format.

static Weeks 
weeks(int weeks)
Obtains an instance of
Weeks that may be cached. 
static Weeks 
weeksBetween(ReadableInstant start,
ReadableInstant end)
Creates a
Weeks representing the number of whole weeks
between the two specified datetimes. 
static Weeks 
weeksBetween(ReadablePartial start,
ReadablePartial end)
Creates a
Weeks representing the number of whole weeks
between the two specified partial datetimes. 
static Weeks 
weeksIn(ReadableInterval interval)
Creates a
Weeks representing the number of whole weeks
in the specified interval. 
between, between, compareTo, equals, get, getFieldType, getValue, getValue, hashCode, isSupported, setValue, size, standardPeriodIn, toMutablePeriod, toPeriod
public static final Weeks ZERO
public static final Weeks ONE
public static final Weeks TWO
public static final Weeks THREE
public static final Weeks MAX_VALUE
public static final Weeks MIN_VALUE
public static Weeks weeks(int weeks)
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 forpublic static Weeks weeksBetween(ReadableInstant start, ReadableInstant end)
Weeks
representing the number of whole weeks
between the two specified datetimes.start
 the start instant, must not be nullend
 the end instant, must not be nullIllegalArgumentException
 if the instants are null or invalidpublic static Weeks weeksBetween(ReadablePartial start, ReadablePartial end)
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 nullend
 the end partial date, must not be nullIllegalArgumentException
 if the partials are null or invalidpublic static Weeks weeksIn(ReadableInterval interval)
Weeks
representing the number of whole weeks
in the specified interval.interval
 the interval to extract weeks from, null returns zeroIllegalArgumentException
 if the partials are null or invalidpublic static Weeks standardWeeksIn(ReadablePeriod period)
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 zeroIllegalArgumentException
 if the period contains imprecise duration valuespublic static Weeks parseWeeks(String periodStr)
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 nonzero. If any other component is nonzero, an exception will be thrown.
periodStr
 the period string, null returns zeroIllegalArgumentException
 if the string format is invalidpublic DurationFieldType getFieldType()
weeks
.getFieldType
in class BaseSingleFieldPeriod
public PeriodType getPeriodType()
weeks
.getPeriodType
in interface ReadablePeriod
getPeriodType
in class BaseSingleFieldPeriod
public Days toStandardDays()
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 representedpublic Hours toStandardHours()
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 representedpublic Minutes toStandardMinutes()
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 representedpublic Seconds toStandardSeconds()
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 representedpublic Duration toStandardDuration()
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.
public int getWeeks()
public Weeks plus(int weeks)
This instance is immutable and unaffected by this method call.
weeks
 the amount of weeks to add, may be negativeArithmeticException
 if the result overflows an intpublic Weeks plus(Weeks weeks)
This instance is immutable and unaffected by this method call.
weeks
 the amount of weeks to add, may be negative, null means zeroArithmeticException
 if the result overflows an intpublic Weeks minus(int weeks)
This instance is immutable and unaffected by this method call.
weeks
 the amount of weeks to take away, may be negativeArithmeticException
 if the result overflows an intpublic Weeks minus(Weeks weeks)
This instance is immutable and unaffected by this method call.
weeks
 the amount of weeks to take away, may be negative, null means zeroArithmeticException
 if the result overflows an intpublic Weeks multipliedBy(int scalar)
This instance is immutable and unaffected by this method call.
scalar
 the amount to multiply by, may be negativeArithmeticException
 if the result overflows an intpublic Weeks dividedBy(int divisor)
This instance is immutable and unaffected by this method call.
divisor
 the amount to divide by, may be negativeArithmeticException
 if the divisor is zeropublic Weeks negated()
ArithmeticException
 if the result overflows an intpublic boolean isGreaterThan(Weeks other)
other
 the other period, null means zeropublic boolean isLessThan(Weeks other)
other
 the other period, null means zeropublic String toString()
For example, "P4W" represents 4 weeks.
toString
in interface ReadablePeriod
toString
in class Object
Copyright © 2002–2024 Joda.org. All rights reserved.