CalendarWeek (Time4J-Range 4.38 API)

java.lang.Object
- net.time4j.engine.ChronoEntity<T>
- - net.time4j.range.FixedCalendarInterval<CalendarWeek>
  - - net.time4j.range.CalendarWeek

All Implemented Interfaces:

Serializable, Comparable<CalendarWeek>, Iterable<PlainDate>, ChronoDisplay, ChronoInterval<PlainDate>
```
@CalendarType(value="iso8601")
public final class CalendarWeek
extends FixedCalendarInterval<CalendarWeek>
```
Represents the calendar week starting on Monday according to ISO-8601-paper.

The elements registered by this class are:
- YEAR_OF_WEEKDATE
- WEEK_OF_YEAR
This class does not offer localized formatting. However, a combination of numerical formatting and fixed literals is possible using the root locale. Example for using the German abbreviation KW for a calendar week:
```
     ChronoFormatter<CalendarWeek> f =
          ChronoFormatter.setUp(CalendarWeek.chronology(), Locale.ROOT)
          .addPattern("w. 'KW'", PatternType.CLDR).build();
     System.out.println(f.format(CalendarWeek.of(2016, 4)); // 4. KW
 
```
Note: The current calendar week can be determined by an expression like: nowInSystemTime() or in a more general way CalendarWeek current = SystemClock.inLocalView().now(CalendarWeek.chronology()).
Since:

3.21/4.17

Author:

Meno Hochschild

See Also:

Serialized Form

Concurrency:
This class is immutable and can be used by multiple threads in parallel.

Field Summary

Fields
Modifier and Type	Field and Description
`static ChronoElement<Integer>`	`WEEK_OF_YEAR` Element with the week of year in the value range `1-52/53`.
`static ChronoElement<Integer>`	`YEAR_OF_WEEKDATE` Defines an element for the week-based year in an ISO-8601-weekdate.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`PlainDate`	`at(Weekday dayOfWeek)` Combines this calendar week with given day of week to a calendar date.
`static Chronology<CalendarWeek>`	`chronology()` Yields the associated chronology.
`int`	`compareTo(CalendarWeek other)`
`boolean`	`contains(PlainDate temporal)` Queries if given time point belongs to this interval.
`boolean`	`equals(Object obj)`
`static CalendarWeek`	`from(GregorianDate date)` Converts given gregorian date to a calendar week.
`Boundary<PlainDate>`	`getEnd()` Yields the upper bound of this interval.
`Boundary<PlainDate>`	`getStart()` Yields the lower bound of this interval.
`int`	`getWeek()` Yields the number of calendar week.
`int`	`getYear()` Yields the year number.
`int`	`hashCode()`
`boolean`	`isAfter(PlainDate temporal)` Is this interval after the given time point?
`boolean`	`isBefore(PlainDate temporal)` Is this interval before the given time point?
`static boolean`	`isValid(int yearOfWeekdate, int weekOfYear)` Validates given year-of-weekdate and week-of-year.
`Iterator<PlainDate>`	`iterator()` Iterates over all seven days from Monday to Sunday.
`int`	`length()` Calendar week always consist of seven days.
`CalendarWeek`	`minus(Weeks weeks)` Subtracts given weeks from this calendar week.
`CalendarWeek`	`minus(Years<Weekcycle> years)` Subtracts given years from this calendar week.
`static CalendarWeek`	`nowInSystemTime()` Obtains the current calendar week in system time.
`static CalendarWeek`	`of(int yearOfWeekdate, int weekOfYear)` Creates a new instance based on given week-based year and week-of-year according to ISO-8601.
`static CalendarWeek`	`parseISO(String text)` Interpretes given ISO-conforming text as calendar week.
`CalendarWeek`	`plus(Weeks weeks)` Adds given weeks to this calendar week.
`CalendarWeek`	`plus(Years<Weekcycle> years)` Adds given years to this calendar week.
`String`	`toString()` Outputs this instance as a String in CLDR-format "YYYY-'W'ww" (like "2016-W01").
`CalendarWeek`	`withLastWeekOfYear()` Yields the last calendar week of the year of this instance.

Methods inherited from class net.time4j.range.FixedCalendarInterval
abuts, contains, isBefore, isEmpty, isFinite, isSimultaneous, streamDaily, toFlexInterval, withValue

Methods inherited from class net.time4j.engine.ChronoEntity
contains, get, get, getInt, getMaximum, getMinimum, getRegisteredElements, getTimezone, hasTimezone, isValid, isValid, isValid, matches, with, with, with, with

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.time4j.range.ChronoInterval
intersects, isAfter

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - YEAR_OF_WEEKDATE
```
@FormattableElement(format="Y")
public static final ChronoElement<Integer> YEAR_OF_WEEKDATE
```
    Defines an element for the week-based year in an ISO-8601-weekdate.
    
    The week-based year is usually the same as the calendar year. However, at the begin or end of a calendar year the situation is different because the first week of the weekdate can start after New Year and the last week of the weekdate can end before the last day of the calendar year. Examples:
    - Sunday, [1995-01-01] => [1994-W52-7]
    - Tuesday, [1996-31-12] => [1997-W01-2]
  - WEEK_OF_YEAR
```
@FormattableElement(format="w")
public static final ChronoElement<Integer> WEEK_OF_YEAR
```
    Element with the week of year in the value range 1-52/53.
    
    The calendar week always starts on Monday. The first week which has at least four days within current calendar year is considered as the first week of year.
    
    See Also:
    
    Weekmodel.ISO, Weekmodel.weekOfYear()
- Method Detail
  - of
```
public static CalendarWeek of(int yearOfWeekdate,
                              int weekOfYear)
```
    Creates a new instance based on given week-based year and week-of-year according to ISO-8601.
    
    In order to create the last calendar week of given year, it is recommended to use following expression:
```
     CalendarWeek first = CalendarWeek.of(2016, 1);
     CalendarWeek last = first.withLastWeekOfYear();
 
```
    Parameters:
    
    yearOfWeekdate - week-based year within range -999,999,999 / +999,999,999
    
    weekOfYear - week of year based on ISO-8601 in range 1-52/53
    
    Returns:
    
    new instance
    
    Throws:
    
    IllegalArgumentException - if any argument is out of range
    
    See Also:
    
    isValid(int, int), withLastWeekOfYear()
  - nowInSystemTime
```
public static CalendarWeek nowInSystemTime()
```
    Obtains the current calendar week in system time.
    
    Convenient short-cut for: SystemClock.inLocalView().now(CalendarWeek.chronology()).
    
    Returns:
    
    current calendar week in system time zone using the system clock
    
    Since:
    
    3.24/4.20
    
    See Also:
    
    SystemClock.inLocalView(), ZonalClock.now(net.time4j.engine.Chronology)
  - at
```
public PlainDate at(Weekday dayOfWeek)
```
    Combines this calendar week with given day of week to a calendar date.
    
    Parameters:
    
    dayOfWeek - day of week in range MONDAY - SUNDAY
    
    Returns:
    
    calendar date
  - getYear
```
public int getYear()
```
    Yields the year number.
    
    Returns:
    
    int
    
    See Also:
    
    YEAR_OF_WEEKDATE
  - getWeek
```
public int getWeek()
```
    Yields the number of calendar week.
    
    Note: The last week of year can be obtained by the expression getMaximum(WEEK_OF_YEAR).
    
    Returns:
    
    int
    
    See Also:
    
    WEEK_OF_YEAR, ChronoEntity.getMaximum(ChronoElement), withLastWeekOfYear()
  - getStart
```
public Boundary<PlainDate> getStart()
```
    Description copied from interface: ChronoInterval
    
    Yields the lower bound of this interval.
    
    Returns:
    
    start interval boundary
  - getEnd
```
public Boundary<PlainDate> getEnd()
```
    Description copied from interface: ChronoInterval
    
    Yields the upper bound of this interval.
    
    Returns:
    
    end interval boundary
  - contains
```
public boolean contains(PlainDate temporal)
```
    Description copied from interface: ChronoInterval
    
    Queries if given time point belongs to this interval.
    
    Parameters:
    
    temporal - time point to be queried
    
    Returns:
    
    true if given time point belongs to this interval else false
  - isAfter
```
public boolean isAfter(PlainDate temporal)
```
    Description copied from interface: ChronoInterval
    
    Is this interval after the given time point?
    
    Parameters:
    
    temporal - reference time point
    
    Returns:
    
    true if this interval is after given time point else false
  - isBefore
```
public boolean isBefore(PlainDate temporal)
```
    Description copied from interface: ChronoInterval
    
    Is this interval before the given time point?
    
    Parameters:
    
    temporal - reference time point
    
    Returns:
    
    true if this interval is before given time point else false
  - isValid
```
public static boolean isValid(int yearOfWeekdate,
                              int weekOfYear)
```
    Validates given year-of-weekdate and week-of-year.
    
    Parameters:
    
    yearOfWeekdate - the year of weekdate (can be different from calendar year near New Year)
    
    weekOfYear - the week of weekbased year
    
    Returns:
    
    true if valid else false
    
    Since:
    
    4.37
    
    See Also:
    
    of(int, int)
  - length
```
public int length()
```
    Calendar week always consist of seven days.
    
    Returns:
    
    7
  - from
```
public static CalendarWeek from(GregorianDate date)
```
    Converts given gregorian date to a calendar week.
    
    Parameters:
    
    date - gregorian calendar date (for example PlainDate
    
    Returns:
    
    CalendarWeek
    
    Throws:
    
    IllegalArgumentException - if given date is invalid
    
    Since:
    
    3.28/4.24
  - withLastWeekOfYear
```
public CalendarWeek withLastWeekOfYear()
```
    Yields the last calendar week of the year of this instance.
    
    Returns:
    
    calendar week with week number 52 or 53
  - plus
```
public CalendarWeek plus(Years<Weekcycle> years)
```
    Adds given years to this calendar week.
    
    Parameters:
    
    years - the count of week-based years to be added
    
    Returns:
    
    result of addition
  - plus
```
public CalendarWeek plus(Weeks weeks)
```
    Adds given weeks to this calendar week.
    
    Parameters:
    
    weeks - the count of weeks to be added
    
    Returns:
    
    result of addition
  - minus
```
public CalendarWeek minus(Years<Weekcycle> years)
```
    Subtracts given years from this calendar week.
    
    Parameters:
    
    years - the count of week-based years to be subtracted
    
    Returns:
    
    result of subtraction
  - minus
```
public CalendarWeek minus(Weeks weeks)
```
    Subtracts given weeks from this calendar week.
    
    Parameters:
    
    weeks - the count of weeks to be subtracted
    
    Returns:
    
    result of subtraction
  - compareTo
```
public int compareTo(CalendarWeek other)
```
  - iterator
```
public Iterator<PlainDate> iterator()
```
    Iterates over all seven days from Monday to Sunday.
    
    Returns:
    
    Iterator
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Outputs this instance as a String in CLDR-format "YYYY-'W'ww" (like "2016-W01").
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    String
    
    See Also:
    
    parseISO(String)
  - parseISO
```
public static CalendarWeek parseISO(String text)
                             throws ParseException
```
    Interpretes given ISO-conforming text as calendar week.
    
    The underlying parser uses the CLDR-pattern "YYYY[-]'W'ww".
    
    Parameters:
    
    text - text to be parsed
    
    Returns:
    
    parsed calendar week
    
    Throws:
    
    IndexOutOfBoundsException - if given text is empty
    
    ParseException - if the text is not parseable
    
    See Also:
    
    toString()
  - chronology
```
public static Chronology<CalendarWeek> chronology()
```
    Yields the associated chronology.
    
    Returns:
    
    the underlying rule engine

Class CalendarWeek

Field Summary

Method Summary

Methods inherited from class net.time4j.range.FixedCalendarInterval

Methods inherited from class net.time4j.engine.ChronoEntity

Methods inherited from class java.lang.Object

Methods inherited from interface net.time4j.range.ChronoInterval

Methods inherited from interface java.lang.Iterable

Field Detail

YEAR_OF_WEEKDATE

WEEK_OF_YEAR

Method Detail

of

nowInSystemTime

at

getYear

getWeek

getStart

getEnd

contains

isAfter

isBefore

isValid

length

from

withLastWeekOfYear

plus

plus

minus

minus

compareTo

iterator

equals

hashCode

toString

parseISO

chronology