com.github.msarhan.ummalqura.calendar

Class UmmalquraCalendar

java.lang.Object

java.util.Calendar

java.util.GregorianCalendar

com.github.msarhan.ummalqura.calendar.UmmalquraCalendar

All Implemented Interfaces:

Serializable, Cloneable, Comparable<Calendar>

public class UmmalquraCalendar
extends GregorianCalendar

Author:

Mouaffak A. Sarhan.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class java.util.Calendar

Calendar.Builder

Field Summary

Fields

Modifier and Type	Field and Description
protected int[]	hFields The calendar field values for the currently set time for this calendar.
static int	JUMADA_AWWAL Value of the Calendar.MONTH field indicating the fifth month of the year in the Ummalqura calendar.
static int	JUMADA_THANI Value of the Calendar.MONTH field indicating the sixth month of the year in the Ummalqura calendar.
static int	MUHARRAM Value of the Calendar.MONTH field indicating the first month of the year in the Ummalqura calendar.
static int	RABI_AWWAL Value of the Calendar.MONTH field indicating the third month of the year in the Ummalqura calendar.
static int	RABI_THANI Value of the Calendar.MONTH field indicating the fourth month of the year in the Ummalqura calendar.
static int	RAJAB Value of the Calendar.MONTH field indicating the seventh month of the year in the Ummalqura calendar.
static int	RAMADHAN Value of the Calendar.MONTH field indicating the ninth month of the year in the Ummalqura calendar.
static int	SAFAR Value of the Calendar.MONTH field indicating the second month of the year in the Ummalqura calendar.
static int	SHAABAN Value of the Calendar.MONTH field indicating the eighth month of the year in the Ummalqura calendar.
static int	SHAWWAL Value of the Calendar.MONTH field indicating the tenth month of the year in the Ummalqura calendar.
static int	THUL_HIJJAH Value of the Calendar.MONTH field indicating the twelfth month of the year in the Ummalqura calendar.
static int	THUL_QIDAH Value of the Calendar.MONTH field indicating the eleventh month of the year in the Ummalqura calendar.

Fields inherited from class java.util.GregorianCalendar

AD, BC

Fields inherited from class java.util.Calendar

ALL_STYLES, AM, AM_PM, APRIL, areFieldsSet, AUGUST, DATE, DAY_OF_MONTH, DAY_OF_WEEK, DAY_OF_WEEK_IN_MONTH, DAY_OF_YEAR, DECEMBER, DST_OFFSET, ERA, FEBRUARY, FIELD_COUNT, fields, FRIDAY, HOUR, HOUR_OF_DAY, isSet, isTimeSet, JANUARY, JULY, JUNE, LONG, LONG_FORMAT, LONG_STANDALONE, MARCH, MAY, MILLISECOND, MINUTE, MONDAY, MONTH, NARROW_FORMAT, NARROW_STANDALONE, NOVEMBER, OCTOBER, PM, SATURDAY, SECOND, SEPTEMBER, SHORT, SHORT_FORMAT, SHORT_STANDALONE, SUNDAY, THURSDAY, time, TUESDAY, UNDECIMBER, WEDNESDAY, WEEK_OF_MONTH, WEEK_OF_YEAR, YEAR, ZONE_OFFSET

Constructor Summary

Constructors

Constructor and Description
UmmalquraCalendar() Constructs a default UmmalquraCalendar using the current time in the default time zone with the default locale.
UmmalquraCalendar(int year, int month, int dayOfMonth) Constructs a UmmalquraCalendar with the given date set in the default time zone with the default locale.
UmmalquraCalendar(int year, int month, int dayOfMonth, int hourOfDay, int minute) Constructs a UmmalquraCalendar with the given date and time set for the default time zone with the default locale.
UmmalquraCalendar(int year, int month, int dayOfMonth, int hourOfDay, int minute, int second) Constructs a UmmalquraCalendar with the given date and time set for the default time zone with the default locale.
UmmalquraCalendar(Locale aLocale) Constructs a UmmalquraCalendar based on the current time in the default time zone with the given locale.
UmmalquraCalendar(TimeZone zone, Locale aLocale) Constructs a UmmalquraCalendar based on the current time in the given time zone with the given locale.

Method Summary

Modifier and Type	Method and Description
protected void	computeFields()
boolean	equals(Object obj)
int	get(int field)
String	getDisplayName(int field, int style, Locale locale) Returns the string representation of the calendar field value in the given style and locale.
Map<String,Integer>	getDisplayNames(int field, int style, Locale locale) Returns a Map containing all names of the calendar field in the given style and locale and their corresponding field values.
int	hashCode()
int	lengthOfMonth() Returns the length of the month represented by this calendar.
static int	lengthOfMonth(int year, int month) Returns the length of a Hijri month in a Hijri year.
int	lengthOfYear() Returns the length of the year represented by this calendar.
static int	lengthOfYear(int year) Returns the length of the given year.
void	set(int field, int value)

Methods inherited from class java.util.GregorianCalendar

add, clone, computeTime, from, getActualMaximum, getActualMinimum, getCalendarType, getGreatestMinimum, getGregorianChange, getLeastMaximum, getMaximum, getMinimum, getTimeZone, getWeeksInWeekYear, getWeekYear, isLeapYear, isWeekDateSupported, roll, roll, setGregorianChange, setTimeZone, setWeekDate, toZonedDateTime

Methods inherited from class java.util.Calendar

after, before, clear, clear, compareTo, complete, getAvailableCalendarTypes, getAvailableLocales, getFirstDayOfWeek, getInstance, getInstance, getInstance, getInstance, getMinimalDaysInFirstWeek, getTime, getTimeInMillis, internalGet, isLenient, isSet, set, set, set, setFirstDayOfWeek, setLenient, setMinimalDaysInFirstWeek, setTime, setTimeInMillis, toInstant, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

MUHARRAM

public static final int MUHARRAM

Value of the Calendar.MONTH field indicating the first month of the year in the Ummalqura calendar.

See Also:

Constant Field Values

SAFAR

public static final int SAFAR

Value of the Calendar.MONTH field indicating the second month of the year in the Ummalqura calendar.

See Also:

Constant Field Values

RABI_AWWAL

public static final int RABI_AWWAL

Value of the Calendar.MONTH field indicating the third month of the year in the Ummalqura calendar.

See Also:

Constant Field Values

RABI_THANI

public static final int RABI_THANI

Value of the Calendar.MONTH field indicating the fourth month of the year in the Ummalqura calendar.

See Also:

Constant Field Values

JUMADA_AWWAL

public static final int JUMADA_AWWAL

Value of the Calendar.MONTH field indicating the fifth month of the year in the Ummalqura calendar.

See Also:

Constant Field Values

JUMADA_THANI

public static final int JUMADA_THANI

Value of the Calendar.MONTH field indicating the sixth month of the year in the Ummalqura calendar.

See Also:

Constant Field Values

RAJAB

public static final int RAJAB

Value of the Calendar.MONTH field indicating the seventh month of the year in the Ummalqura calendar.

See Also:

Constant Field Values

SHAABAN

public static final int SHAABAN

Value of the Calendar.MONTH field indicating the eighth month of the year in the Ummalqura calendar.

See Also:

Constant Field Values

RAMADHAN

public static final int RAMADHAN

Value of the Calendar.MONTH field indicating the ninth month of the year in the Ummalqura calendar.

See Also:

Constant Field Values

SHAWWAL

public static final int SHAWWAL

Value of the Calendar.MONTH field indicating the tenth month of the year in the Ummalqura calendar.

See Also:

Constant Field Values

THUL_QIDAH

public static final int THUL_QIDAH

Value of the Calendar.MONTH field indicating the eleventh month of the year in the Ummalqura calendar.

See Also:

Constant Field Values

THUL_HIJJAH

public static final int THUL_HIJJAH

Value of the Calendar.MONTH field indicating the twelfth month of the year in the Ummalqura calendar.

See Also:

Constant Field Values

hFields

protected int[] hFields

The calendar field values for the currently set time for this calendar. This is an array of FIELD_COUNT integers, with index values ERA through DST_OFFSET.

Constructor Detail

UmmalquraCalendar

public UmmalquraCalendar()

Constructs a default UmmalquraCalendar using the current time in the default time zone with the default locale.

UmmalquraCalendar

public UmmalquraCalendar(Locale aLocale)

Constructs a UmmalquraCalendar based on the current time in the default time zone with the given locale.

Parameters:

aLocale - the given locale.

UmmalquraCalendar

public UmmalquraCalendar(TimeZone zone,
                         Locale aLocale)

Constructs a UmmalquraCalendar based on the current time in the given time zone with the given locale.

Parameters:

zone - the given time zone.

aLocale - the given locale.

UmmalquraCalendar

public UmmalquraCalendar(int year,
                         int month,
                         int dayOfMonth)

Constructs a UmmalquraCalendar with the given date set in the default time zone with the default locale.

Parameters:

year - the value used to set the YEAR calendar field in the calendar.

month - the value used to set the MONTH calendar field in the calendar. Month value is 0-based. e.g., 0 for Muharram.

dayOfMonth - the value used to set the DAY_OF_MONTH calendar field in the calendar.

UmmalquraCalendar

public UmmalquraCalendar(int year,
                         int month,
                         int dayOfMonth,
                         int hourOfDay,
                         int minute)

Constructs a UmmalquraCalendar with the given date and time set for the default time zone with the default locale.

Parameters:

year - the value used to set the YEAR calendar field in the calendar.

month - the value used to set the MONTH calendar field in the calendar. Month value is 0-based. e.g., 0 for Muharram.

dayOfMonth - the value used to set the DAY_OF_MONTH calendar field in the calendar.

hourOfDay - the value used to set the HOUR_OF_DAY calendar field in the calendar.

minute - the value used to set the MINUTE calendar field in the calendar.

UmmalquraCalendar

public UmmalquraCalendar(int year,
                         int month,
                         int dayOfMonth,
                         int hourOfDay,
                         int minute,
                         int second)

Constructs a UmmalquraCalendar with the given date and time set for the default time zone with the default locale.

Parameters:

year - the value used to set the YEAR calendar field in the calendar.

month - the value used to set the MONTH calendar field in the calendar. Month value is 0-based. e.g., 0 for Muharram.

dayOfMonth - the value used to set the DAY_OF_MONTH calendar field in the calendar.

hourOfDay - the value used to set the HOUR_OF_DAY calendar field in the calendar.

minute - the value used to set the MINUTE calendar field in the calendar.

second - the value used to set the SECOND calendar field in the calendar.

Method Detail

get

public int get(int field)

Overrides:

get in class Calendar

set

public void set(int field,
                int value)

Overrides:

set in class Calendar

lengthOfMonth

public int lengthOfMonth()

Returns the length of the month represented by this calendar.

This returns the length of the month in days.

Returns:

the length of the month in days

lengthOfMonth

public static int lengthOfMonth(int year,
                                int month)

Returns the length of a Hijri month in a Hijri year.

This returns the length of the month in days.

Parameters:

year - Hijri year

month - Hijri month

Returns:

the length of the month in days

lengthOfYear

public int lengthOfYear()

Returns the length of the year represented by this calendar.

This returns the length of the year in days, either 354 or 355.

Returns:

355 if the year is leap, 354 otherwise

lengthOfYear

public static int lengthOfYear(int year)

Returns the length of the given year.

This returns the length of the year in days, either 354 or 355.

Parameters:

year - the year to calculate day count for.

Returns:

355 if the year is leap, 354 otherwise

getDisplayName

public String getDisplayName(int field,
                             int style,
                             Locale locale)

Returns the string representation of the calendar field value in the given style and locale. If no string representation is applicable, null is returned. This method calls get(field) to get the calendar field value if the string representation is applicable to the given calendar field.

For example, if this Calendar's date is 1437-01-01, then the string representation of the Calendar.MONTH field would be "Muharram" in the long style in an English locale or "Muh" in the short style. However, no string representation would be available for the Calendar.DAY_OF_MONTH field, and this method would return null.

The default implementation supports the calendar fields for which a UmmalquraDateFormatSymbols has names in the given locale.

Overrides:

getDisplayName in class Calendar

Parameters:

field - the calendar field for which the string representation is returned

style - the style applied to the string representation; one of Calendar.SHORT or Calendar.LONG.

locale - the locale for the string representation

Returns:

the string representation of the given field in the given style, or null if no string representation is applicable.

Throws:

IllegalArgumentException - if field or style is invalid, or if this Calendar is non-lenient and any of the calendar fields have invalid values

NullPointerException - if locale is null

Since:

1.6

getDisplayNames

public Map<String,Integer> getDisplayNames(int field,
                                           int style,
                                           Locale locale)

Returns a Map containing all names of the calendar field in the given style and locale and their corresponding field values. For example, The returned map would contain "Muh" to MUHARRAM, "Saf" to SAFAR, and so on, in the short style in an English locale.

The values of other calendar fields may be taken into account to determine a set of display names. For example, if this Calendar is a lunisolar calendar system and the year value given by the Calendar.YEAR field has a leap month, this method would return month names containing the leap month name, and month names are mapped to their values specific for the year.

This implementation supports display names contained in a UmmalquraDateFormatSymbols. For example, if field is Calendar.MONTH and style is Calendar.ALL_STYLES, this method returns a Map containing all strings returned by UmmalquraDateFormatSymbols.getShortMonths() and UmmalquraDateFormatSymbols.getMonths().

Overrides:

getDisplayNames in class Calendar

Parameters:

field - the calendar field for which the display names are returned

style - the style applied to the display names; one of Calendar.SHORT, Calendar.LONG, or Calendar.ALL_STYLES.

locale - the locale for the display names

Returns:

a Map containing all display names in style and locale and their field values, or null if no display names are defined for field

Throws:

IllegalArgumentException - if field or style is invalid, or if this Calendar is non-lenient and any of the calendar fields have invalid values

NullPointerException - if locale is null

equals

public boolean equals(Object obj)

Overrides:

equals in class GregorianCalendar

hashCode

public int hashCode()

Overrides:

hashCode in class GregorianCalendar

computeFields

protected void computeFields()

Overrides:

computeFields in class GregorianCalendar