Interface IWeekYearRule

A rule determining how "week years" are arranged, including the weeks within the week year. Implementations provided by Noda Time itself can be obtained via the WeekYearRules class.
Since 1.4.x
Availability net45, netstandard1.3, netstandard2.0
Namespace: NodaTime.Calendars
Assembly: NodaTime.dll
Syntax
public interface IWeekYearRule
Remarks

Dates are usually identified within a calendar system by a calendar year, a month within that calendar year, and a day within that month. For example, the date of birth of Ada Lovelace can be identified within the Gregorian calendar system as the year 1815, the month December (12), and the day 10. However, dates can also be identified (again within a calendar system) by week-year, week and day-of-week. How that identification occurs depends on which rule you use - but again as an example, within the Gregorian calendar system, using the ISO-8601 week year rule, the date of Ada Lovelace's birth is week-year 1815, week 49, day-of-week Sunday.

The calendar year of a date and the week-year of a date are the same in most rules for most dates, but aren't always. When they differ, it is usually because a day near the start of the calendar year is deemed to belong to the last week of the previous week-year - or conversely because a day near the end of the calendar year is deemed to belong to the first week of the following week-year. Some rules may be more radical - a UK tax year rule could number weeks from April 6th onwards, such that any date earlier than that in the calendar year would belong to the previous week-year.

The mapping of dates into week-year, week and day-of-week is always relative to a specific calendar system. For example, years in the Hebrew calendar system vary very significantly in length due to leap months, and this is reflected in the number of weeks within the week-years - as low as 50, and as high as 55.

This class allows conversions between the two schemes of identifying dates: GetWeekYear(LocalDate) and GetWeekOfWeekYear(LocalDate) allow the week-year and week to be obtained for a date, and GetLocalDate(Int32, Int32, IsoDayOfWeek, CalendarSystem) allows the reverse mapping. Note that the calendar system does not need to be specified in the former methods as a LocalDate already contains calendar information, and there is no method to obtain the day-of-week as that is not affected by the week year rule being used.

All implementations within Noda Time are immutable, and it is advised that any external implementations should be immutable too.

Methods

GetLocalDate(Int32, Int32, IsoDayOfWeek, CalendarSystem)

Creates a LocalDate from a given week-year, week within that week-year, and day-of-week, for the specified calendar system.
Since 1.4.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
LocalDate GetLocalDate(int weekYear, int weekOfWeekYear, IsoDayOfWeek dayOfWeek, CalendarSystem calendar)
Parameters
Type Name Description
Int32 weekYear The week-year of the new date. Implementations provided by Noda Time allow any year which is a valid calendar year, and sometimes one less than the minimum calendar year and/or one more than the maximum calendar year, to allow for dates near the start of a calendar year to fall in the previous week year, and similarly for dates near the end of a calendar year.
Int32 weekOfWeekYear The week of week-year of the new date. Valid values for this parameter may vary depending on weekYear, as the length of a year in weeks varies.
IsoDayOfWeek dayOfWeek The day-of-week of the new date. Valid values for this parameter may vary depending on weekYear and weekOfWeekYear.
CalendarSystem calendar The calendar system for the date.
Returns
Type Description
LocalDate A LocalDate corresponding to the specified values.
Remarks

Wherever reasonable, implementations should ensure that all valid dates can be constructed via this method. In other words, given a LocalDate date, rule.GetLocalDate(rule.GetWeekYear(date), rule.GetWeekOfWeekYear(date), date.IsoDayOfWeek, date.Calendar) should always return date. This is true for all rules within Noda Time, but third party implementations may choose to simplify their implementations by restricting them to appropriate portions of time.

Implementations may restrict which calendar systems supplied here, but the implementations provided by Noda Time work with all available calendar systems.

Exceptions
Type Condition
ArgumentOutOfRangeException The parameters do not combine to form a valid date.
ArgumentNullException calendar is null.

GetWeekOfWeekYear(LocalDate)

Calculates the week of the week-year in which the given date occurs, according to this rule.
Since 1.4.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
int GetWeekOfWeekYear(LocalDate date)
Parameters
Type Name Description
LocalDate date The date to compute the week of.
Returns
Type Description
Int32 The week of the week-year of date, according to this rule.

GetWeeksInWeekYear(Int32, CalendarSystem)

Returns the number of weeks in the given week-year, within the specified calendar system.
Since 1.4.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
int GetWeeksInWeekYear(int weekYear, CalendarSystem calendar)
Parameters
Type Name Description
Int32 weekYear The week-year to find the range of.
CalendarSystem calendar The calendar system the calculation is relative to.
Returns
Type Description
Int32 The number of weeks in the given week-year within the given calendar.
Exceptions
Type Condition
ArgumentNullException calendar is null.

GetWeekYear(LocalDate)

Calculates the week-year in which the given date occurs, according to this rule.
Since 1.4.x
Availability net45, netstandard1.3, netstandard2.0
Declaration
int GetWeekYear(LocalDate date)
Parameters
Type Name Description
LocalDate date The date to compute the week-year of.
Returns
Type Description
Int32 The week-year of date, according to this rule.

Extension Methods