HebrewCalendar
public
class
HebrewCalendar
extends Calendar
java.lang.Object | ||
↳ | android.icu.util.Calendar | |
↳ | android.icu.util.HebrewCalendar |
HebrewCalendar
is a subclass of Calendar
that that implements the traditional Hebrew calendar.
This is the civil calendar in Israel and the liturgical calendar
of the Jewish faith worldwide.
The Hebrew calendar is lunisolar and thus has a number of interesting properties that distinguish it from the Gregorian. Months start on the day of (an arithmetic approximation of) each new moon. Since the solar year (approximately 365.24 days) is not an even multiple of the lunar month (approximately 29.53 days) an extra "leap month" is inserted in 7 out of every 19 years. To make matters even more interesting, the start of a year can be delayed by up to three days in order to prevent certain holidays from falling on the Sabbath and to prevent certain illegal year lengths. Finally, the lengths of certain months can vary depending on the number of days in the year.
The leap month is known as "Adar 1" and is inserted between the
months of Shevat and Adar in leap years. Since the leap month does
not come at the end of the year, calculations involving
month numbers are particularly complex. Users of this class should
make sure to use the roll
and add
methods
rather than attempting to perform date arithmetic by manipulating
the fields directly.
Note: In the traditional Hebrew calendar, days start at sunset. However, in order to keep the time fields in this class synchronized with those of the other calendars and with local clock time, we treat days and months as beginning at midnight, roughly 6 hours after the corresponding sunset.
If you are interested in more information on the rules behind the Hebrew calendar, see one of the following references:
- "Calendrical Calculations", by Nachum Dershowitz & Edward Reingold, Cambridge University Press, 1997, pages 85-91.
- Hebrew Calendar Science and Myths, http://web.archive.org/web/20090423084613/http://www.geocities.com/Athens/1584/
- The Calendar FAQ, http://www.faqs.org/faqs/calendars/faq/
This class should not be subclassed.
HebrewCalendar usually should be instantiated using
Calendar.getInstance(ULocale)
passing in a ULocale
with the tag "@calendar=hebrew"
.
See also:
Summary
Constants | |
---|---|
int |
ADAR
Constant for the Adar, the 7th month of the Hebrew year. |
int |
ADAR_1
Constant for Adar I, the 6th month of the Hebrew year (present in leap years only). |
int |
AV
Constant for Av, the 12th month of the Hebrew year. |
int |
ELUL
Constant for Elul, the 13th month of the Hebrew year. |
int |
HESHVAN
Constant for Heshvan, the 2nd month of the Hebrew year. |
int |
IYAR
Constant for Iyar, the 9th month of the Hebrew year. |
int |
KISLEV
Constant for Kislev, the 3rd month of the Hebrew year. |
int |
NISAN
Constant for Nisan, the 8th month of the Hebrew year. |
int |
SHEVAT
Constant for Shevat, the 5th month of the Hebrew year. |
int |
SIVAN
Constant for Sivan, the 10th month of the Hebrew year. |
int |
TAMUZ
Constant for Tammuz, the 11th month of the Hebrew year. |
int |
TEVET
Constant for Tevet, the 4th month of the Hebrew year. |
int |
TISHRI
Constant for Tishri, the 1st month of the Hebrew year. |
Inherited constants |
---|
Inherited fields |
---|
Public constructors | |
---|---|
HebrewCalendar()
Constructs a default |
|
HebrewCalendar(TimeZone zone)
Constructs a |
|
HebrewCalendar(TimeZone zone, ULocale locale)
Constructs a |
|
HebrewCalendar(TimeZone zone, Locale aLocale)
Constructs a |
|
HebrewCalendar(ULocale locale)
Constructs a |
|
HebrewCalendar(int year, int month, int date)
Constructs a |
|
HebrewCalendar(int year, int month, int date, int hour, int minute, int second)
Constructs a |
|
HebrewCalendar(Date date)
Constructs a |
|
HebrewCalendar(Locale aLocale)
Constructs a |
Public methods | |
---|---|
void
|
add(int field, int amount)
Add a signed amount to a specified field, using this calendar's rules. |
String
|
getTemporalMonthCode()
Gets The Temporal monthCode value corresponding to the month for the date. |
String
|
getType()
[icu] Returns the calendar type name string for this Calendar object. |
boolean
|
inTemporalLeapYear()
[icu] Returns true if the date is in a leap year. |
void
|
roll(int field, int amount)
Rolls (up/down) a specified amount time on the given field. |
void
|
setTemporalMonthCode(String temporalMonth)
Sets The Temporal monthCode which is a string identifier that starts with the literal grapheme "M" followed by two graphemes representing the zero-padded month number of the current month in a normal (non-leap) year and suffixed by an optional literal grapheme "L" if this is a leap month in a lunisolar calendar. |
Protected methods | |
---|---|
void
|
handleComputeFields(int julianDay)
Subclasses may override this method to compute several fields specific to each calendar system. |
int
|
handleComputeMonthStart(int eyear, int month, boolean useMonth)
Return JD of start of given month/year. |
int
|
handleGetExtendedYear()
Returns the extended year defined by the current fields. |
int
|
handleGetLimit(int field, int limitType)
Subclass API for defining limits of different types. |
int
|
handleGetMonthLength(int extendedYear, int month)
Returns the length of the given month in the given year |
int
|
handleGetYearLength(int eyear)
Returns the number of days in the given Hebrew year |
Inherited methods | |
---|---|
Constants
ADAR
public static final int ADAR
Constant for the Adar, the 7th month of the Hebrew year.
Constant Value: 6 (0x00000006)
ADAR_1
public static final int ADAR_1
Constant for Adar I, the 6th month of the Hebrew year (present in leap years only). In non-leap years, the calendar jumps from Shevat (5th month) to Adar (7th month).
Constant Value: 5 (0x00000005)
AV
public static final int AV
Constant for Av, the 12th month of the Hebrew year.
Constant Value: 11 (0x0000000b)
ELUL
public static final int ELUL
Constant for Elul, the 13th month of the Hebrew year.
Constant Value: 12 (0x0000000c)
HESHVAN
public static final int HESHVAN
Constant for Heshvan, the 2nd month of the Hebrew year.
Constant Value: 1 (0x00000001)
IYAR
public static final int IYAR
Constant for Iyar, the 9th month of the Hebrew year.
Constant Value: 8 (0x00000008)
KISLEV
public static final int KISLEV
Constant for Kislev, the 3rd month of the Hebrew year.
Constant Value: 2 (0x00000002)
NISAN
public static final int NISAN
Constant for Nisan, the 8th month of the Hebrew year.
Constant Value: 7 (0x00000007)
SHEVAT
public static final int SHEVAT
Constant for Shevat, the 5th month of the Hebrew year.
Constant Value: 4 (0x00000004)
SIVAN
public static final int SIVAN
Constant for Sivan, the 10th month of the Hebrew year.
Constant Value: 9 (0x00000009)
TAMUZ
public static final int TAMUZ
Constant for Tammuz, the 11th month of the Hebrew year.
Constant Value: 10 (0x0000000a)
TEVET
public static final int TEVET
Constant for Tevet, the 4th month of the Hebrew year.
Constant Value: 3 (0x00000003)
TISHRI
public static final int TISHRI
Constant for Tishri, the 1st month of the Hebrew year.
Constant Value: 0 (0x00000000)
Public constructors
HebrewCalendar
public HebrewCalendar ()
Constructs a default HebrewCalendar
using the current time
in the default time zone with the default FORMAT
locale.
See also:
HebrewCalendar
public HebrewCalendar (TimeZone zone)
Constructs a HebrewCalendar
based on the current time
in the given time zone with the default FORMAT
locale.
Parameters | |
---|---|
zone |
TimeZone : The time zone for the new calendar. |
See also:
HebrewCalendar
public HebrewCalendar (TimeZone zone, ULocale locale)
Constructs a HebrewCalendar
based on the current time
in the given time zone with the given locale.
Parameters | |
---|---|
zone |
TimeZone : The time zone for the new calendar. |
locale |
ULocale : The locale for the new calendar. |
HebrewCalendar
public HebrewCalendar (TimeZone zone, Locale aLocale)
Constructs a HebrewCalendar
based on the current time
in the given time zone with the given locale.
Parameters | |
---|---|
zone |
TimeZone : The time zone for the new calendar. |
aLocale |
Locale : The locale for the new calendar. |
HebrewCalendar
public HebrewCalendar (ULocale locale)
Constructs a HebrewCalendar
based on the current time
in the default time zone with the given locale.
Parameters | |
---|---|
locale |
ULocale : The locale for the new calendar. |
HebrewCalendar
public HebrewCalendar (int year, int month, int date)
Constructs a HebrewCalendar
with the given date set
in the default time zone with the default FORMAT
locale.
Parameters | |
---|---|
year |
int : The value used to set the calendar's YEAR time field. |
month |
int : The value used to set the calendar's MONTH time field.
The value is 0-based. e.g., 0 for Tishri. |
date |
int : The value used to set the calendar's DATE time field. |
See also:
HebrewCalendar
public HebrewCalendar (int year, int month, int date, int hour, int minute, int second)
Constructs a HebrewCalendar
with the given date
and time set for the default time zone with the default FORMAT
locale.
Parameters | |
---|---|
year |
int : The value used to set the calendar's YEAR time field. |
month |
int : The value used to set the calendar's MONTH time field.
The value is 0-based. e.g., 0 for Tishri. |
date |
int : The value used to set the calendar's DATE time field. |
hour |
int : The value used to set the calendar's HOUR_OF_DAY time field. |
minute |
int : The value used to set the calendar's MINUTE time field. |
second |
int : The value used to set the calendar's SECOND time field. |
See also:
HebrewCalendar
public HebrewCalendar (Date date)
Constructs a HebrewCalendar
with the given date set
in the default time zone with the default FORMAT
locale.
Parameters | |
---|---|
date |
Date : The date to which the new calendar is set. |
See also:
HebrewCalendar
public HebrewCalendar (Locale aLocale)
Constructs a HebrewCalendar
based on the current time
in the default time zone with the given locale.
Parameters | |
---|---|
aLocale |
Locale : The locale for the new calendar. |
Public methods
add
public void add (int field, int amount)
Add a signed amount to a specified field, using this calendar's rules.
For example, to add three days to the current date, you can call
add(Calendar.DATE, 3)
.
When adding to certain fields, the values of other fields may conflict and
need to be changed. For example, when adding one to the MONTH
field
for the date "30 Av 5758", the DAY_OF_MONTH
field
must be adjusted so that the result is "29 Elul 5758" rather than the invalid
"30 Elul 5758".
This method is able to add to
all fields except for ERA
, DST_OFFSET
,
and ZONE_OFFSET
.
Note: You should always use roll
and add rather
than attempting to perform arithmetic operations directly on the fields
of a HebrewCalendar. Since the MONTH
field behaves
discontinuously in non-leap years, simple arithmetic can give invalid results.
Parameters | |
---|---|
field |
int : the time field. |
amount |
int : the amount to add to the field. |
Throws | |
---|---|
IllegalArgumentException |
if the field is invalid or refers to a field that cannot be handled by this method. |
getTemporalMonthCode
public String getTemporalMonthCode ()
Gets The Temporal monthCode value corresponding to the month for the date. The value is a string identifier that starts with the literal grapheme "M" followed by two graphemes representing the zero-padded month number of the current month in a normal (non-leap) year and suffixed by an optional literal grapheme "L" if this is a leap month in a lunisolar calendar. For the Hebrew calendar, the values are "M01" .. "M12" for non-leap year, and "M01" .. "M05", "M05L", "M06" .. "M12" for leap year.
Returns | |
---|---|
String |
One of 13 possible strings in {"M01".. "M05", "M05L", "M06" .. "M12"}. |
getType
public String getType ()
[icu] Returns the calendar type name string for this Calendar object. The returned string is the legacy ICU calendar attribute value, for example, "gregorian" or "japanese".
See type="old type name" for the calendar attribute of locale IDs at http://www.unicode.org/reports/tr35/#Key_Type_Definitions
Returns | |
---|---|
String |
legacy calendar type name string |
inTemporalLeapYear
public boolean inTemporalLeapYear ()
[icu] Returns true if the date is in a leap year. Recalculate the current time field values if the time value has been changed by a call to * setTime(). This method is semantically const, but may alter the object in memory. A "leap year" is a year that contains more days than other years (for solar or lunar calendars) or more months than other years (for lunisolar calendars like Hebrew or Chinese), as defined in the ECMAScript Temporal proposal.
Returns | |
---|---|
boolean |
true if the date in the fields is in a Temporal proposal defined leap year. False otherwise. |
roll
public void roll (int field, int amount)
Rolls (up/down) a specified amount time on the given field. For
example, to roll the current date up by three days, you can call
roll(Calendar.DATE, 3)
. If the
field is rolled past its maximum allowable value, it will "wrap" back
to its minimum and continue rolling.
For example, calling roll(Calendar.DATE, 10)
on a Hebrew calendar set to "25 Av 5758" will result in the date "5 Av 5758".
When rolling certain fields, the values of other fields may conflict and
need to be changed. For example, when rolling the MONTH
field
upward by one for the date "30 Av 5758", the DAY_OF_MONTH
field
must be adjusted so that the result is "29 Elul 5758" rather than the invalid
"30 Elul".
This method is able to roll
all fields except for ERA
, DST_OFFSET
,
and ZONE_OFFSET
. Subclasses may, of course, add support for
additional fields in their overrides of roll
.
Note: You should always use roll and add
rather
than attempting to perform arithmetic operations directly on the fields
of a HebrewCalendar. Since the MONTH
field behaves
discontinuously in non-leap years, simple arithmetic can give invalid results.
Parameters | |
---|---|
field |
int : the time field. |
amount |
int : the amount by which the field should be rolled. |
Throws | |
---|---|
IllegalArgumentException |
if the field is invalid or refers to a field that cannot be handled by this method. |
setTemporalMonthCode
public void setTemporalMonthCode (String temporalMonth)
Sets The Temporal monthCode which is a string identifier that starts with the literal grapheme "M" followed by two graphemes representing the zero-padded month number of the current month in a normal (non-leap) year and suffixed by an optional literal grapheme "L" if this is a leap month in a lunisolar calendar. For Hebrew calendar, the values are "M01" .. "M12" for non-leap years, and "M01" .. "M05", "M05L", "M06" .. "M12" for leap year.
Parameters | |
---|---|
temporalMonth |
String : The value to be set for temporal monthCode. |
Protected methods
handleComputeFields
protected void handleComputeFields (int julianDay)
Subclasses may override this method to compute several fields specific to each calendar system. These are:
- ERA
- YEAR
- MONTH
- DAY_OF_MONTH
- DAY_OF_YEAR
- EXTENDED_YEAR
In addition, subclasses should compute any subclass-specific fields, that is, fields from BASE_FIELD_COUNT to getFieldCount() - 1.
Parameters | |
---|---|
julianDay |
int |
handleComputeMonthStart
protected int handleComputeMonthStart (int eyear, int month, boolean useMonth)
Return JD of start of given month/year.
Parameters | |
---|---|
eyear |
int : the extended year |
month |
int : the zero-based month, or 0 if useMonth is false |
useMonth |
boolean : if false, compute the day before the first day of
the given year, otherwise, compute the day before the first day of
the given month |
Returns | |
---|---|
int |
the Julian day number of the day before the first day of the given month and year |
handleGetExtendedYear
protected int handleGetExtendedYear ()
Returns the extended year defined by the current fields. This will use the EXTENDED_YEAR field or the YEAR and supra-year fields (such as ERA) specific to the calendar system, depending on which set of fields is newer.
Returns | |
---|---|
int |
the extended year |
handleGetLimit
protected int handleGetLimit (int field, int limitType)
Subclass API for defining limits of different types. Subclasses must implement this method to return limits for the following fields:
ERA YEAR MONTH WEEK_OF_YEAR WEEK_OF_MONTH DAY_OF_MONTH DAY_OF_YEAR DAY_OF_WEEK_IN_MONTH YEAR_WOY EXTENDED_YEAR
Parameters | |
---|---|
field |
int : one of the above field numbers |
limitType |
int : one of MINIMUM , GREATEST_MINIMUM ,
LEAST_MAXIMUM , or MAXIMUM |
Returns | |
---|---|
int |
handleGetMonthLength
protected int handleGetMonthLength (int extendedYear, int month)
Returns the length of the given month in the given year
Parameters | |
---|---|
extendedYear |
int |
month |
int |
Returns | |
---|---|
int |
handleGetYearLength
protected int handleGetYearLength (int eyear)
Returns the number of days in the given Hebrew year
Parameters | |
---|---|
eyear |
int |
Returns | |
---|---|
int |