net.time4j.calendar

Class CommonElements

java.lang.Object

net.time4j.calendar.CommonElements

public class CommonElements
extends java.lang.Object

Defines access to elements which can be used by all calendars defined in this package.

Since:

3.20/4.16

Field Summary

Fields

Modifier and Type	Field and Description
static ChronoElement<java.lang.Integer>	RELATED_GREGORIAN_YEAR Represents the related gregorian year which corresponds to the start of any given non-gregorian calendar year.

Method Summary

Modifier and Type	Method and Description
static <T extends ChronoEntity<T> & CalendarDate> StdCalendarElement<Weekday,T>	localDayOfWeek(Chronology<T> chronology, Weekmodel model) Defines an element for the weekday with a localized day number in the value range 1-7.
static <T extends ChronoEntity<T> & CalendarDate> StdCalendarElement<java.lang.Integer,T>	weekOfMonth(Chronology<T> chronology, Weekmodel model) Creates an integer element for the week of month in given chronology dependent on given week model.
static <T extends ChronoEntity<T> & CalendarDate> StdCalendarElement<java.lang.Integer,T>	weekOfYear(Chronology<T> chronology, Weekmodel model) Creates an integer element for the week of year in given chronology dependent on given week model.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

RELATED_GREGORIAN_YEAR

@FormattableElement(format="r")
public static final ChronoElement<java.lang.Integer> RELATED_GREGORIAN_YEAR

Represents the related gregorian year which corresponds to the start of any given non-gregorian calendar year.

The element is read-only.

Since:

3.20/4.16

Method Detail

localDayOfWeek

@FormattableElement(format="e",
                    standalone="c")
public static <T extends ChronoEntity<T> & CalendarDate> StdCalendarElement<Weekday,T> localDayOfWeek(Chronology<T> chronology,
                                                                                                                                                                            Weekmodel model)

Defines an element for the weekday with a localized day number in the value range 1-7.

The given chronology must support a 7-day-week with an element of name "DAY_OF_WEEK" otherwise an exception will be thrown.

This element defines localized weekday numbers in numerical formatting and also a localized sorting order of weekdays, but still manages values of type Weekday. However, the value range with its minimum and maximum is localized, too, i.e. the element defines as minium the value getFirstDayOfWeek().

Type Parameters:

T - chronological type

Parameters:

chronology - the calendrical chronology

model - the underlying week model

Returns:

day of week with localized order

Throws:

java.lang.IllegalArgumentException - if the chronology does not support this element

Since:

3.24/4.20

weekOfYear

@FormattableElement(format="w")
public static <T extends ChronoEntity<T> & CalendarDate> StdCalendarElement<java.lang.Integer,T> weekOfYear(Chronology<T> chronology,
                                                                                                                                             Weekmodel model)

Creates an integer element for the week of year in given chronology dependent on given week model.

The given chronology must support a 7-day-week with elements of names "DAY_OF_WEEK" and "DAY_OF_YEAR", otherwise an exception will be thrown.

Type Parameters:

T - chronological type

Parameters:

chronology - the calendrical chronology

model - the underlying week model

Returns:

generic calendar element

Throws:

java.lang.IllegalArgumentException - if the chronology does not support this element

Since:

3.24/4.20

weekOfMonth

@FormattableElement(format="W")
public static <T extends ChronoEntity<T> & CalendarDate> StdCalendarElement<java.lang.Integer,T> weekOfMonth(Chronology<T> chronology,
                                                                                                                                              Weekmodel model)

Creates an integer element for the week of month in given chronology dependent on given week model.

The given chronology must support a 7-day-week with elements of names "DAY_OF_WEEK" and "DAY_OF_MONTH", otherwise an exception will be thrown.

Type Parameters:

T - chronological type

Parameters:

chronology - the calendar chronology

model - the underlying week model

Returns:

generic calendar element

Throws:

java.lang.IllegalArgumentException - if the chronology does not support this element

Since:

3.24/4.20