org.dmfs.rfc5545.calendarmetrics

Class IslamicCalendarMetrics

java.lang.Object

org.dmfs.rfc5545.calendarmetrics.CalendarMetrics

org.dmfs.rfc5545.calendarmetrics.NoLeapMonthCalendarMetrics

org.dmfs.rfc5545.calendarmetrics.IslamicCalendarMetrics

public class IslamicCalendarMetrics
extends NoLeapMonthCalendarMetrics

Provides a set of methods that provide information about the Islamic Calendar.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IslamicCalendarMetrics.IslamicCalendarMetricsFactory
static class	IslamicCalendarMetrics.LeapYearPattern

Nested classes/interfaces inherited from class org.dmfs.rfc5545.calendarmetrics.CalendarMetrics

CalendarMetrics.CalendarMetricsFactory

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CALENDAR_SCALE_CIVIL
static java.lang.String	CALENDAR_SCALE_TLBA
static long	DAYS_PER_CYCLE
static byte[][]	LEAP_YEAR_COUNT One array per IslamicCalendarMetrics.LeapYearPattern that contains the number of leap days that occurred up to a particular year in the 30 year cycle.
static int[]	LEAP_YEAR_PATTERNS An array of (packed) patterns based on different leap year rules.
static long	MILLIS_PER_CYCLE
static long	MILLIS_PER_DAY
static long	MILLIS_TO_1389_10_22C This is the number of milliseconds between {I}0001-01-01 (civil scale) and {I}1389-10-22 (civil scale) (i.e.
static Weekday[]	WEEKDAYS An array of Weekdays.

Fields inherited from class org.dmfs.rfc5545.calendarmetrics.CalendarMetrics

minDaysInFirstWeek, weekStart, weekStartInt

Constructor Summary

Constructors

Constructor and Description
IslamicCalendarMetrics(java.lang.String name, Weekday weekStart, int minDaysInFirstWeek, IslamicCalendarMetrics.LeapYearPattern leapYearPatternIndex, boolean civil) Create calendar metrics for an Islamic calendar with the given week numbering.

Method Summary

Modifier and Type	Method and Description
int	getDayOfMonthOfYearDay(int year, int yearDay) Determines the day of month for a given day of year.
int	getDayOfYear(int year, int packedMonth, int dayOfMonth) Get the day of the year for the specified date.
int	getDaysPerPackedMonth(int year, int packedMonth) Get the number of days in a specific packed month.
int	getDaysPerYear(int year) Get the number of days in the given year.
int	getMaxMonthDayNum() Returns the largest month day number that the current calendar supports.
int	getMaxWeekNoNum() Returns the largest week number that the current calendar supports.
int	getMaxYearDayNum() Returns the largest year day number that the current calendar supports.
int	getMonthAndDayOfYearDay(int year, int yearDay) Determines the month and day for a given day of year.
int	getMonthsPerYear() Returns the number of months in a year.
int	getPackedMonthOfYearDay(int year, int yearDay) Determines the month of a given day of year.
int	getWeekDayOfFirstYearDay(int year) Get the weekday of the first day (which is January the 1st in a Gregorian Calendar) in the given year.
int	getWeekOfYear(int year, int yearDay) Get the ISO week number of the given date.
int	getWeeksPerYear(int year) Get the number of ISO weeks in the given year.
int	getYearDayOfFirstWeekStart(int year) Get the day of year of the start of the first week in a year.
int	getYearDayOfIsoYear(int year, int weekOfYear, int dayOfWeek) Get the day of the year for the specified ISO week date, see ISO week date If the day belongs to the previous year zero or a negative value is returned.
int	getYearDayOfWeekStart(int year, int week) Get the day of year of the start of the given week in a year.
int	getYearDaysForPackedMonth(int year, int packedMonth) Get the number of days preceding the given month in the given year.
long	toGregorian(long islamicInstance) Convert the given Islamic instance to Gregorian calendar.
long	toInstance(long timestamp, java.util.TimeZone timeZone) Converts a timestamp to an instance in the given TimeZone.
long	toMillis(java.util.TimeZone timeZone, int year, int packedMonth, int dayOfMonth, int hours, int minutes, int seconds, int millis) Convert the given (local) date to milliseconds since the epoch using the given TimeZone.

Methods inherited from class org.dmfs.rfc5545.calendarmetrics.NoLeapMonthCalendarMetrics

getMonthsPerYear, isLeapMonth, monthNum, nextDay, nextDay, nextMonth, nextMonth, packedMonth, packedMonth, packedMonthToString, prevDay, prevDay, prevMonth, prevMonth

Methods inherited from class org.dmfs.rfc5545.calendarmetrics.CalendarMetrics

dayOfMonth, equals, getDayOfWeek, getDayOfWeek, getWeekOfYear, hashCode, monthAndDay, packedMonth, scaleEquals, setDayOfWeek, startOfWeek, toMillis, toString, validate

Methods inherited from class java.lang.Object

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

Field Detail

DAYS_PER_CYCLE

public static final long DAYS_PER_CYCLE

See Also:

Constant Field Values

MILLIS_PER_DAY

public static final long MILLIS_PER_DAY

See Also:

Constant Field Values

MILLIS_PER_CYCLE

public static final long MILLIS_PER_CYCLE

See Also:

Constant Field Values

MILLIS_TO_1389_10_22C

public static final long MILLIS_TO_1389_10_22C

This is the number of milliseconds between {I}0001-01-01 (civil scale) and {I}1389-10-22 (civil scale) (i.e. {G}1970-01-01). Since this is the 9th year of the 30 year cycle, the number of leap years in the cycle is the same for all patterns.

See Also:

Constant Field Values

CALENDAR_SCALE_TLBA

public static final java.lang.String CALENDAR_SCALE_TLBA

See Also:

Constant Field Values

CALENDAR_SCALE_CIVIL

public static final java.lang.String CALENDAR_SCALE_CIVIL

See Also:

Constant Field Values

LEAP_YEAR_PATTERNS

public static final int[] LEAP_YEAR_PATTERNS

An array of (packed) patterns based on different leap year rules.

LEAP_YEAR_COUNT

public static final byte[][] LEAP_YEAR_COUNT

One array per IslamicCalendarMetrics.LeapYearPattern that contains the number of leap days that occurred up to a particular year in the 30 year cycle.

WEEKDAYS

public static final Weekday[] WEEKDAYS

An array of Weekdays. This is handy to get a Weekday instance for a given weekday number.

Constructor Detail

IslamicCalendarMetrics

public IslamicCalendarMetrics(java.lang.String name,
                              Weekday weekStart,
                              int minDaysInFirstWeek,
                              IslamicCalendarMetrics.LeapYearPattern leapYearPatternIndex,
                              boolean civil)

Create calendar metrics for an Islamic calendar with the given week numbering.

Parameters:

weekStart - The first day of the week.

minDaysInFirstWeek - The minimal number of days in the first week.

Method Detail

getMaxMonthDayNum

public int getMaxMonthDayNum()

Description copied from class: CalendarMetrics

Returns the largest month day number that the current calendar supports.

Specified by:

getMaxMonthDayNum in class CalendarMetrics

Returns:

The maximum month number in this calendar scale.

getMaxYearDayNum

public int getMaxYearDayNum()

Description copied from class: CalendarMetrics

Returns the largest year day number that the current calendar supports.

Specified by:

getMaxYearDayNum in class CalendarMetrics

Returns:

The maximum year day number in this calendar scale.

getMaxWeekNoNum

public int getMaxWeekNoNum()

Description copied from class: CalendarMetrics

Returns the largest week number that the current calendar supports.

Specified by:

getMaxWeekNoNum in class CalendarMetrics

Returns:

The maximum ISO week number in this calendar scale.

getDaysPerPackedMonth

public int getDaysPerPackedMonth(int year,
                                 int packedMonth)

Description copied from class: CalendarMetrics

Get the number of days in a specific packed month.

Specified by:

getDaysPerPackedMonth in class CalendarMetrics

Parameters:

year - The year.

packedMonth - The packed month.

Returns:

The number of days in that month.

getYearDaysForPackedMonth

public int getYearDaysForPackedMonth(int year,
                                     int packedMonth)

Description copied from class: CalendarMetrics

Get the number of days preceding the given month in the given year.

Specified by:

getYearDaysForPackedMonth in class CalendarMetrics

Parameters:

year - The year.

packedMonth - The packed month.

Returns:

The days in the year preceding the month.

getMonthsPerYear

public int getMonthsPerYear()

Description copied from class: NoLeapMonthCalendarMetrics

Returns the number of months in a year.

Specified by:

getMonthsPerYear in class NoLeapMonthCalendarMetrics

Returns:

The number of months in a year.

getDaysPerYear

public int getDaysPerYear(int year)

Description copied from class: CalendarMetrics

Get the number of days in the given year.

Specified by:

getDaysPerYear in class CalendarMetrics

Parameters:

year - The year.

Returns:

The number of days in that year.

getWeeksPerYear

public int getWeeksPerYear(int year)

Description copied from class: CalendarMetrics

Get the number of ISO weeks in the given year.

Specified by:

getWeeksPerYear in class CalendarMetrics

Parameters:

year - The year.

Returns:

The number of weeks in that year.

getWeekOfYear

public int getWeekOfYear(int year,
                         int yearDay)

Description copied from class: CalendarMetrics

Get the ISO week number of the given date.

Note: this will return 0 if the week belongs to the previous ISO year and a value greater than CalendarMetrics.getWeeksPerYear(int) if the week belongs to the next ISO year.

Specified by:

getWeekOfYear in class CalendarMetrics

Parameters:

year - The year.

yearDay - The day of year.

Returns:

The ISO week number.

getDayOfYear

public int getDayOfYear(int year,
                        int packedMonth,
                        int dayOfMonth)

Description copied from class: CalendarMetrics

Get the day of the year for the specified date.

Specified by:

getDayOfYear in class CalendarMetrics

Parameters:

year - The year.

packedMonth - The packed month.

dayOfMonth - The day of month.

Returns:

The day of year.

getWeekDayOfFirstYearDay

public int getWeekDayOfFirstYearDay(int year)

Description copied from class: CalendarMetrics

Get the weekday of the first day (which is January the 1st in a Gregorian Calendar) in the given year.

Specified by:

getWeekDayOfFirstYearDay in class CalendarMetrics

Parameters:

year - The year.

Returns:

The weekday number.

getYearDayOfFirstWeekStart

public int getYearDayOfFirstWeekStart(int year)

Description copied from class: CalendarMetrics

Get the day of year of the start of the first week in a year. Note this method returns values below 1 if the start of the week is in the previous year. The result depends on the values of CalendarMetrics.weekStart and CalendarMetrics.minDaysInFirstWeek.

Specified by:

getYearDayOfFirstWeekStart in class CalendarMetrics

Parameters:

year - The year.

Returns:

The day of year.

getPackedMonthOfYearDay

public int getPackedMonthOfYearDay(int year,
                                   int yearDay)

Description copied from class: CalendarMetrics

Determines the month of a given day of year.

Specified by:

getPackedMonthOfYearDay in class CalendarMetrics

Parameters:

year - The year.

yearDay - The year day.

Returns:

the packed month.

getDayOfMonthOfYearDay

public int getDayOfMonthOfYearDay(int year,
                                  int yearDay)

Description copied from class: CalendarMetrics

Determines the day of month for a given day of year.

Specified by:

getDayOfMonthOfYearDay in class CalendarMetrics

Parameters:

year - The year.

yearDay - The year day.

Returns:

the month day.

getMonthAndDayOfYearDay

public int getMonthAndDayOfYearDay(int year,
                                   int yearDay)

Description copied from class: CalendarMetrics

Determines the month and day for a given day of year. The result contains both, packed month and day in a single integer. To split the values use CalendarMetrics.packedMonth(int) and CalendarMetrics.dayOfMonth(int) like in:

 int monthAndDay = mCalendarMetrics.getMonthAndDayOfYearDay(year, yearDay);
 int month = CalendarMetrics.packedMonth(monthAndDay);
 int dayOfMonth = CalendarMetrics.dayOfMonth(monthAndDay);
 

Specified by:

getMonthAndDayOfYearDay in class CalendarMetrics

Parameters:

year - The year.

yearDay - The day of the year. Must be a valid value between 1 and the maximum number of days in that year.

Returns:

an integer with the day of month in the lowest significant byte and the packed month in the second lowest significant byte.

getYearDayOfIsoYear

public int getYearDayOfIsoYear(int year,
                               int weekOfYear,
                               int dayOfWeek)

Description copied from class: CalendarMetrics

Get the day of the year for the specified ISO week date, see ISO week date

If the day belongs to the previous year zero or a negative value is returned. If the day belongs to the next year the result is larger than CalendarMetrics.getDaysPerYear(int) for year.

Specified by:

getYearDayOfIsoYear in class CalendarMetrics

Parameters:

year - The year.

weekOfYear - The ISO week of the year.

dayOfWeek - The day of the week.

Returns:

The day of year.

getYearDayOfWeekStart

public int getYearDayOfWeekStart(int year,
                                 int week)

Description copied from class: CalendarMetrics

Get the day of year of the start of the given week in a year. Note this method returns values below 1 if the start of the week is in the previous year. The result depends on the values of CalendarMetrics.weekStart and CalendarMetrics.minDaysInFirstWeek.

Specified by:

getYearDayOfWeekStart in class CalendarMetrics

Parameters:

year - The year.

week - The week.

Returns:

The day of year.

toMillis

public long toMillis(java.util.TimeZone timeZone,
                     int year,
                     int packedMonth,
                     int dayOfMonth,
                     int hours,
                     int minutes,
                     int seconds,
                     int millis)

Description copied from class: CalendarMetrics

Convert the given (local) date to milliseconds since the epoch using the given TimeZone.

Specified by:

toMillis in class CalendarMetrics

Parameters:

timeZone - The time zone or null for floating dates (and all-day dates).

year - The year.

packedMonth - The packed month.

dayOfMonth - The day of the month.

hours - The hour of the day.

minutes - The minutes.

seconds - The seconds.

millis - The milliseconds.

Returns:

The milliseconds since the epoch.

toInstance

public long toInstance(long timestamp,
                       java.util.TimeZone timeZone)

Description copied from class: CalendarMetrics

Converts a timestamp to an instance in the given TimeZone.

Specified by:

toInstance in class CalendarMetrics

Parameters:

timestamp - The time in milliseconds since the epoch.

timeZone - The time zone, may be null in which case UTC will be used.

Returns:

a packed instance.

toGregorian

public long toGregorian(long islamicInstance)

Convert the given Islamic instance to Gregorian calendar.

Parameters:

islamicInstance - An Instance value in islamic calendar scale.

Returns:

The instance in Gregorian calendar scale.