public class HebrewCalendar extends Calendar
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:
This class should not be subclassed.
HebrewCalendar usually should be instantiated using
Calendar.getInstance(ULocale)
passing in a ULocale
with the tag "@calendar=hebrew"
.
GregorianCalendar
,
Calendar
,
Serialized FormCalendar.FormatConfiguration, Calendar.WeekData
Modifier and Type | Field and Description |
---|---|
static int |
ADAR
Constant for the Adar, the 7th month of the Hebrew year.
|
static int |
ADAR_1
Constant for Adar I, the 6th month of the Hebrew year
(present in leap years only).
|
static int |
AV
Constant for Av, the 12th month of the Hebrew year.
|
static int |
ELUL
Constant for Elul, the 13th month of the Hebrew year.
|
static int |
HESHVAN
Constant for Heshvan, the 2nd month of the Hebrew year.
|
static int |
IYAR
Constant for Iyar, the 9th month of the Hebrew year.
|
static int |
KISLEV
Constant for Kislev, the 3rd month of the Hebrew year.
|
static int |
NISAN
Constant for Nisan, the 8th month of the Hebrew year.
|
static int |
SHEVAT
Constant for Shevat, the 5th month of the Hebrew year.
|
static int |
SIVAN
Constant for Sivan, the 10th month of the Hebrew year.
|
static int |
TAMUZ
Constant for Tammuz, the 11th month of the Hebrew year.
|
static int |
TEVET
Constant for Tevet, the 4th month of the Hebrew year.
|
static int |
TISHRI
Constant for Tishri, the 1st month of the Hebrew year.
|
AM, AM_PM, APRIL, AUGUST, BASE_FIELD_COUNT, DATE, DAY_OF_MONTH, DAY_OF_WEEK, DAY_OF_WEEK_IN_MONTH, DAY_OF_YEAR, DECEMBER, DOW_LOCAL, DST_OFFSET, EPOCH_JULIAN_DAY, ERA, EXTENDED_YEAR, FEBRUARY, FRIDAY, GREATEST_MINIMUM, HOUR, HOUR_OF_DAY, INTERNALLY_SET, IS_LEAP_MONTH, JAN_1_1_JULIAN_DAY, JANUARY, JULIAN_DAY, JULY, JUNE, LEAST_MAXIMUM, MARCH, MAX_DATE, MAX_FIELD_COUNT, MAX_JULIAN, MAX_MILLIS, MAXIMUM, MAY, MILLISECOND, MILLISECONDS_IN_DAY, MIN_DATE, MIN_JULIAN, MIN_MILLIS, MINIMUM, MINIMUM_USER_STAMP, MINUTE, MONDAY, MONTH, NOVEMBER, OCTOBER, ONE_DAY, ONE_HOUR, ONE_MINUTE, ONE_SECOND, ONE_WEEK, ORDINAL_MONTH, PM, RESOLVE_REMAP, SATURDAY, SECOND, SEPTEMBER, SUNDAY, THURSDAY, TUESDAY, UNDECIMBER, UNSET, WALLTIME_FIRST, WALLTIME_LAST, WALLTIME_NEXT_VALID, WEDNESDAY, WEEK_OF_MONTH, WEEK_OF_YEAR, WEEKDAY, WEEKEND, WEEKEND_CEASE, WEEKEND_ONSET, YEAR, YEAR_WOY, ZONE_OFFSET
Constructor and Description |
---|
HebrewCalendar()
Constructs a default
HebrewCalendar using the current time
in the default time zone with the default FORMAT locale. |
HebrewCalendar(Date date)
Constructs a
HebrewCalendar with the given date set
in the default time zone with the default FORMAT locale. |
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. |
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. |
HebrewCalendar(Locale aLocale)
Constructs a
HebrewCalendar based on the current time
in the default time zone with the given locale. |
HebrewCalendar(TimeZone zone)
Constructs a
HebrewCalendar based on the current time
in the given time zone with the default FORMAT locale. |
HebrewCalendar(TimeZone zone,
Locale aLocale)
Constructs a
HebrewCalendar based on the current time
in the given time zone with the given locale. |
HebrewCalendar(TimeZone zone,
ULocale locale)
Constructs a
HebrewCalendar based on the current time
in the given time zone with the given locale. |
HebrewCalendar(ULocale locale)
Constructs a
HebrewCalendar based on the current time
in the default time zone with the given locale. |
Modifier and Type | Method and Description |
---|---|
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.
|
protected void |
handleComputeFields(int julianDay)
Subclasses may override this method to compute several fields
specific to each calendar system.
|
protected int |
handleComputeMonthStart(int eyear,
int month,
boolean useMonth)
Return JD of start of given month/year.
|
protected int |
handleGetExtendedYear()
Returns the extended year defined by the current fields.
|
protected int |
handleGetLimit(int field,
int limitType)
Subclass API for defining limits of different types.
|
protected int |
handleGetMonthLength(int extendedYear,
int month)
Returns the length of the given month in the given year
|
protected int |
handleGetYearLength(int eyear)
Returns the number of days in the given Hebrew year
|
boolean |
inTemporalLeapYear()
[icu] Returns true if the date is in a leap year.
|
protected int |
internalGetMonth()
Deprecated.
This API is ICU internal only.
|
static boolean |
isLeapYear(int year)
Deprecated.
This API is ICU internal only.
|
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 void |
validateField(int field)
Deprecated.
This API is ICU internal only.
|
after, before, clear, clear, clone, compareTo, complete, computeFields, computeGregorianFields, computeGregorianMonthStart, computeJulianDay, computeMillisInDay, computeMillisInDayLong, computeTime, computeZoneOffset, computeZoneOffset, equals, fieldDifference, fieldName, floorDivide, floorDivide, floorDivide, floorDivide, get, getActualMaximum, getActualMinimum, getAvailableLocales, getAvailableULocales, getDateAtTimePattern, getDateTimeFormat, getDateTimeFormat, getDateTimePattern, getDayOfWeekType, getDefaultDayInMonth, getDefaultMonthInYear, getDisplayName, getDisplayName, getFieldCount, getFieldResolutionTable, getFirstDayOfWeek, getGreatestMinimum, getGregorianDayOfMonth, getGregorianDayOfYear, getGregorianMonth, getGregorianYear, getInstance, getInstance, getInstance, getInstance, getInstance, getInstance, getKeywordValuesForLocale, getLeastMaximum, getLimit, getLocale, getMaximum, getMinimalDaysInFirstWeek, getMinimum, getRelatedYear, getRepeatedWallTimeOption, getSkippedWallTimeOption, getStamp, getTime, getTimeInMillis, getTimeZone, getWeekData, getWeekDataForRegion, getWeekendTransition, gregorianMonthLength, gregorianPreviousMonthLength, handleComputeJulianDay, handleCreateFields, handleGetDateFormat, handleGetDateFormat, handleGetDateFormat, handleGetDateFormat, hashCode, haveDefaultCentury, internalGet, internalGet, internalGetMonth, internalGetTimeInMillis, internalSet, isEquivalentTo, isEra0CountingBackward, isGregorianLeapYear, isLenient, isSet, isWeekend, isWeekend, julianDayToDayOfWeek, julianDayToMillis, millisToJulianDay, newerField, newestStamp, pinField, prepareGetActual, resolveFields, roll, set, set, set, set, setFirstDayOfWeek, setLenient, setMinimalDaysInFirstWeek, setRelatedYear, setRepeatedWallTimeOption, setSkippedWallTimeOption, setTime, setTimeInMillis, setTimeZone, setWeekData, toString, validateField, validateFields, weekNumber, weekNumber
public static final int TISHRI
public static final int HESHVAN
public static final int KISLEV
public static final int TEVET
public static final int SHEVAT
public static final int ADAR_1
public static final int ADAR
public static final int NISAN
public static final int IYAR
public static final int SIVAN
public static final int TAMUZ
public static final int AV
public static final int ELUL
public HebrewCalendar()
HebrewCalendar
using the current time
in the default time zone with the default FORMAT
locale.ULocale.Category.FORMAT
public HebrewCalendar(TimeZone zone)
HebrewCalendar
based on the current time
in the given time zone with the default FORMAT
locale.zone
- The time zone for the new calendar.ULocale.Category.FORMAT
public HebrewCalendar(Locale aLocale)
HebrewCalendar
based on the current time
in the default time zone with the given locale.aLocale
- The locale for the new calendar.public HebrewCalendar(ULocale locale)
HebrewCalendar
based on the current time
in the default time zone with the given locale.locale
- The locale for the new calendar.public HebrewCalendar(TimeZone zone, Locale aLocale)
HebrewCalendar
based on the current time
in the given time zone with the given locale.zone
- The time zone for the new calendar.aLocale
- The locale for the new calendar.public HebrewCalendar(TimeZone zone, ULocale locale)
HebrewCalendar
based on the current time
in the given time zone with the given locale.zone
- The time zone for the new calendar.locale
- The locale for the new calendar.public HebrewCalendar(int year, int month, int date)
HebrewCalendar
with the given date set
in the default time zone with the default FORMAT
locale.year
- The value used to set the calendar's YEAR
time field.month
- The value used to set the calendar's MONTH
time field.
The value is 0-based. e.g., 0 for Tishri.date
- The value used to set the calendar's DATE
time field.ULocale.Category.FORMAT
public HebrewCalendar(Date date)
HebrewCalendar
with the given date set
in the default time zone with the default FORMAT
locale.date
- The date to which the new calendar is set.ULocale.Category.FORMAT
public HebrewCalendar(int year, int month, int date, int hour, int minute, int second)
HebrewCalendar
with the given date
and time set for the default time zone with the default FORMAT
locale.year
- The value used to set the calendar's YEAR
time field.month
- The value used to set the calendar's MONTH
time field.
The value is 0-based. e.g., 0 for Tishri.date
- The value used to set the calendar's DATE
time field.hour
- The value used to set the calendar's HOUR_OF_DAY
time field.minute
- The value used to set the calendar's MINUTE
time field.second
- The value used to set the calendar's SECOND
time field.ULocale.Category.FORMAT
public void add(int field, int amount)
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.
add
in class Calendar
field
- the time field.amount
- the amount to add to the field.IllegalArgumentException
- if the field is invalid or refers
to a field that cannot be handled by this method.Calendar.roll(int, int)
public void roll(int field, int amount)
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.
roll
in class Calendar
field
- the time field.amount
- the amount by which the field should be rolled.IllegalArgumentException
- if the field is invalid or refers
to a field that cannot be handled by this method.Calendar.roll(int, boolean)
,
Calendar.add(int, int)
@Deprecated public static boolean isLeapYear(int year)
protected int handleGetLimit(int field, int limitType)
Calendar
ERA YEAR MONTH WEEK_OF_YEAR WEEK_OF_MONTH DAY_OF_MONTH DAY_OF_YEAR DAY_OF_WEEK_IN_MONTH YEAR_WOY EXTENDED_YEAR
handleGetLimit
in class Calendar
field
- one of the above field numberslimitType
- one of MINIMUM
, GREATEST_MINIMUM
,
LEAST_MAXIMUM
, or MAXIMUM
protected int handleGetMonthLength(int extendedYear, int month)
handleGetMonthLength
in class Calendar
protected int handleGetYearLength(int eyear)
handleGetYearLength
in class Calendar
@Deprecated protected void validateField(int field)
Calendar.validateField()
.
Overrides Calendar.validateField(int)
to provide
special handling for month validation for Hebrew calendar.
validateField
in class Calendar
Calendar.validateField(int, int, int)
protected void handleComputeFields(int julianDay)
In addition, subclasses should compute any subclass-specific fields, that is, fields from BASE_FIELD_COUNT to getFieldCount() - 1.
handleComputeFields
in class Calendar
protected int handleGetExtendedYear()
Calendar
handleGetExtendedYear
in class Calendar
protected int handleComputeMonthStart(int eyear, int month, boolean useMonth)
handleComputeMonthStart
in class Calendar
eyear
- the extended yearmonth
- the zero-based month, or 0 if useMonth is falseuseMonth
- if false, compute the day before the first day of
the given year, otherwise, compute the day before the first day of
the given monthpublic String getType()
See type="old type name" for the calendar attribute of locale IDs at http://www.unicode.org/reports/tr35/#Key_Type_Definitions
public boolean inTemporalLeapYear()
inTemporalLeapYear
in class Calendar
public String getTemporalMonthCode()
getTemporalMonthCode
in class Calendar
public void setTemporalMonthCode(String temporalMonth)
setTemporalMonthCode
in class Calendar
temporalMonth
- The value to be set for temporal monthCode.@Deprecated protected int internalGetMonth()
internalGetMonth
in class Calendar
Copyright © 2016 Unicode, Inc. and others.