WeekFields

Localized definitions of the day-of-week, week-of-month and week-of-year fields.

A standard week is seven days long, but cultures have different definitions for some other aspects of a week. This class represents the definition of the week, for the purpose of providing TemporalField instances.

WeekFields provides three fields, #dayOfWeek(), #weekOfMonth(), and #weekOfYear() that provide access to the values from any temporal object.

The computations for day-of-week, week-of-month, and week-of-year are based on the proleptic-year, month-of-year, day-of-month, and ISO day-of-week which are based on the epoch-day and the chronology. The values may not be aligned with the year-of-Era depending on the Chronology. A week is defined by:

The first day-of-week. For example, the ISO-8601 standard considers Monday to be the first day-of-week.
The minimal number of days in the first week. For example, the ISO-8601 standard counts the first week as needing at least 4 days.

Together these two values allow a year or month to be divided into weeks.

Week of Month

One field is used: week-of-month. The calculation ensures that weeks never overlap a month boundary. The month is divided into periods where each period starts on the defined first day-of-week. The earliest period is referred to as week 0 if it has less than the minimal number of days and week 1 if it has at least the minimal number of days.

Examples of WeekFields
Date	Day-of-week	First day: Monday Minimal days: 4	First day: Monday Minimal days: 5
2008-12-31	Wednesday	Week 5 of December 2008	Week 5 of December 2008
2009-01-01	Thursday	Week 1 of January 2009	Week 0 of January 2009
2009-01-04	Sunday	Week 1 of January 2009	Week 0 of January 2009
2009-01-05	Monday	Week 2 of January 2009	Week 1 of January 2009

=== Week of Year === One field is used: week-of-year. The calculation ensures that weeks never overlap a year boundary. The year is divided into periods where each period starts on the defined first day-of-week. The earliest period is referred to as week 0 if it has less than the minimal number of days and week 1 if it has at least the minimal number of days. This class is immutable and thread-safe.

Annotations: @SerialVersionUID()
Exceptions thrown: IllegalArgumentException if the minimal days value is invalid

Linear Supertypes

Serializable, AnyRef, Any

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
val dayOfWeek: TemporalField

Returns a field to access the day of week based on this WeekFields.
Returns a field to access the day of week based on this WeekFields.
This is similar to ChronoField#DAY_OF_WEEK but uses values for the day-of-week based on this WeekFields. The days are numbered from 1 to 7 where the first day-of-week is assigned the value 1.
For example, if the first day-of-week is Sunday, then that will have the value 1, with other days ranging from Monday as 2 to Saturday as 7.
In the resolving phase of parsing, a localized day-of-week will be converted to a standardized ChronoField day-of-week. The day-of-week must be in the valid range 1 to 7. Other fields in this class build dates using the standardized day-of-week.
returns
a field providing access to the day-of-week with localized numbering, not null
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(that: Any): Boolean

Checks if this WeekFields is equal to the specified object.
Checks if this WeekFields is equal to the specified object.
The comparison is based on the entire state of the rules, which is the first day-of-week and minimal days.
that
the other rules to compare to, null returns false
returns
true if this is equal to the specified rules

Definition Classes
WeekFields → AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getFirstDayOfWeek: DayOfWeek

Gets the first day-of-week.
Gets the first day-of-week.
The first day-of-week varies by culture. For example, the US uses Sunday, while France and the ISO-8601 standard use Monday. This method returns the first day using the standard DayOfWeek enum.
returns
the first day-of-week, not null
def getMinimalDaysInFirstWeek: Int

Gets the minimal number of days in the first week.
Gets the minimal number of days in the first week.
The number of days considered to define the first week of a month or year varies by culture. For example, the ISO-8601 requires 4 days (more than half a week) to be present before counting the first week.
returns
the minimal number of days in the first week of a month or year, from 1 to 7
def hashCode(): Int

A hash code for this WeekFields.
A hash code for this WeekFields.
returns
a suitable hash code

Definition Classes
WeekFields → AnyRef → Any
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toString(): String

A string representation of this WeekFields instance.
A string representation of this WeekFields instance.
returns
the string representation, not null

Definition Classes
WeekFields → AnyRef → Any
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
val weekBasedYear: TemporalField

Returns a field to access the year of a week-based-year based on this WeekFields.
Returns a field to access the year of a week-based-year based on this WeekFields.
This represents the concept of the year where weeks start on a fixed day-of-week, such as Monday and each week belongs to exactly one year. This field is typically used with WeekFields#dayOfWeek() and WeekFields#weekOfWeekBasedYear().
Week one(1) is the week starting on the WeekFields#getFirstDayOfWeek where there are at least WeekFields#getMinimalDaysInFirstWeek() days in the year. Thus, week one may start before the start of the year. If the first week starts after the start of the year then the period before is in the last week of the previous year.
This field can be used with any calendar system.
In the resolving phase of parsing, a date can be created from a week-based-year, week-of-year and day-of-week.
In strict mode, all three fields are validated against their range of valid values. The week-of-year field is validated to ensure that the resulting week-based-year is the week-based-year requested.
In smart mode, all three fields are validated against their range of valid values. The week-of-week-based-year field is validated from 1 to 53, meaning that the resulting date can be in the following week-based-year to that specified.
In lenient mode, the year and day-of-week are validated against the range of valid values. The resulting date is calculated equivalent to the following three stage approach. First, create a date on the first day of the first week in the requested week-based-year. Then take the week-of-week-based-year, subtract one, and add the amount in weeks to the date. Finally, adjust to the correct day-of-week within the localized week.
returns
a field providing access to the week-based-year, not null
val weekOfMonth: TemporalField

Returns a field to access the week of month based on this WeekFields.
Returns a field to access the week of month based on this WeekFields.
This represents the concept of the count of weeks within the month where weeks start on a fixed day-of-week, such as Monday. This field is typically used with WeekFields#dayOfWeek().
Week one (1) is the week starting on the WeekFields#getFirstDayOfWeek where there are at least WeekFields#getMinimalDaysInFirstWeek() days in the month. Thus, week one may start up to minDays days before the start of the month. If the first week starts after the start of the month then the period before is week zero (0).
For example:
- if the 1st day of the month is a Monday, week one starts on the 1st and there is no week zero
- if the 2nd day of the month is a Monday, week one starts on the 2nd and the 1st is in week zero
- if the 4th day of the month is a Monday, week one starts on the 4th and the 1st to 3rd is in week zero
- if the 5th day of the month is a Monday, week two starts on the 5th and the 1st to 4th is in week one
This field can be used with any calendar system.
In the resolving phase of parsing, a date can be created from a year, week-of-month, month-of-year and day-of-week.
In strict mode, all four fields are validated against their range of valid values. The week-of-month field is validated to ensure that the resulting month is the month requested.
In smart mode, all four fields are validated against their range of valid values. The week-of-month field is validated from 0 to 6, meaning that the resulting date can be in a different month to that specified.
In lenient mode, the year and day-of-week are validated against the range of valid values. The resulting date is calculated equivalent to the following four stage approach. First, create a date on the first day of the first week of January in the requested year. Then take the month-of-year, subtract one, and add the amount in months to the date. Then take the week-of-month, subtract one, and add the amount in weeks to the date. Finally, adjust to the correct day-of-week within the localized week.
returns
a field providing access to the week-of-month, not null
val weekOfWeekBasedYear: TemporalField

Returns a field to access the week of a week-based-year based on this WeekFields.
Returns a field to access the week of a week-based-year based on this WeekFields.
This represents the concept of the count of weeks within the year where weeks start on a fixed day-of-week, such as Monday and each week belongs to exactly one year. This field is typically used with WeekFields#dayOfWeek() and WeekFields#weekBasedYear().
Week one(1) is the week starting on the WeekFields#getFirstDayOfWeek where there are at least WeekFields#getMinimalDaysInFirstWeek() days in the year. If the first week starts after the start of the year then the period before is in the last week of the previous year.
For example:
- if the 1st day of the year is a Monday, week one starts on the 1st
- if the 2nd day of the year is a Monday, week one starts on the 2nd and the 1st is in the last week of the previous year
- if the 4th day of the year is a Monday, week one starts on the 4th and the 1st to 3rd is in the last week of the previous year
- if the 5th day of the year is a Monday, week two starts on the 5th and the 1st to 4th is in week one
This field can be used with any calendar system.
In the resolving phase of parsing, a date can be created from a week-based-year, week-of-year and day-of-week.
In strict mode, all three fields are validated against their range of valid values. The week-of-year field is validated to ensure that the resulting week-based-year is the week-based-year requested.
In smart mode, all three fields are validated against their range of valid values. The week-of-week-based-year field is validated from 1 to 53, meaning that the resulting date can be in the following week-based-year to that specified.
In lenient mode, the year and day-of-week are validated against the range of valid values. The resulting date is calculated equivalent to the following three stage approach. First, create a date on the first day of the first week in the requested week-based-year. Then take the week-of-week-based-year, subtract one, and add the amount in weeks to the date. Finally, adjust to the correct day-of-week within the localized week.
returns
a field providing access to the week-of-week-based-year, not null
val weekOfYear: TemporalField

Returns a field to access the week of year based on this WeekFields.
Returns a field to access the week of year based on this WeekFields.
This represents the concept of the count of weeks within the year where weeks start on a fixed day-of-week, such as Monday. This field is typically used with WeekFields#dayOfWeek().
Week one(1) is the week starting on the WeekFields#getFirstDayOfWeek where there are at least WeekFields#getMinimalDaysInFirstWeek() days in the year. Thus, week one may start up to minDays days before the start of the year. If the first week starts after the start of the year then the period before is week zero (0).
For example:
- if the 1st day of the year is a Monday, week one starts on the 1st and there is no week zero
- if the 2nd day of the year is a Monday, week one starts on the 2nd and the 1st is in week zero
- if the 4th day of the year is a Monday, week one starts on the 4th and the 1st to 3rd is in week zero
- if the 5th day of the year is a Monday, week two starts on the 5th and the 1st to 4th is in week one
This field can be used with any calendar system.
In the resolving phase of parsing, a date can be created from a year, week-of-year and day-of-week.
In strict mode, all three fields are validated against their range of valid values. The week-of-year field is validated to ensure that the resulting year is the year requested.
In smart mode, all three fields are validated against their range of valid values. The week-of-year field is validated from 0 to 54, meaning that the resulting date can be in a different year to that specified.
In lenient mode, the year and day-of-week are validated against the range of valid values. The resulting date is calculated equivalent to the following three stage approach. First, create a date on the first day of the first week in the requested year. Then take the week-of-year, subtract one, and add the amount in weeks to the date. Finally, adjust to the correct day-of-week within the localized week.
returns
a field providing access to the week-of-year, not null

Related Docs: object WeekFields | package temporal

final class WeekFields extends Serializable

Week of Month

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

def clone(): AnyRef

val dayOfWeek: TemporalField

final def eq(arg0: AnyRef): Boolean

def equals(that: Any): Boolean

def finalize(): Unit

final def getClass(): Class[_]

def getFirstDayOfWeek: DayOfWeek

def getMinimalDaysInFirstWeek: Int

def hashCode(): Int

final def isInstanceOf[T0]: Boolean

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toString(): String

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

val weekBasedYear: TemporalField

val weekOfMonth: TemporalField

val weekOfWeekBasedYear: TemporalField

val weekOfYear: TemporalField

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped