org.dmfs.rfc5545.calendarmetrics

Class NoLeapMonthCalendarMetrics

java.lang.Object

org.dmfs.rfc5545.calendarmetrics.CalendarMetrics

org.dmfs.rfc5545.calendarmetrics.NoLeapMonthCalendarMetrics

Direct Known Subclasses:

GregorianCalendarMetrics, IslamicCalendarMetrics

public abstract class NoLeapMonthCalendarMetrics
extends CalendarMetrics

An abstract base class for calendar scales that have no leap month. Knowing that a year has no leap months makes a couple of calculations much easier and allows to share code.

Knowing that a calendar scale has no leap months also allows to return the plain month number as packed month, which makes month handling much easier.

Nested Class Summary

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

CalendarMetrics.CalendarMetricsFactory

Field Summary

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

minDaysInFirstWeek, weekStart, weekStartInt

Constructor Summary

Constructors

Constructor and Description
NoLeapMonthCalendarMetrics(java.lang.String name, Weekday weekStart, int minDaysInFirstWeek) Create calendar metrics for a calendar without leap months with the given week numbering.

Method Summary

Modifier and Type	Method and Description
abstract int	getMonthsPerYear() Returns the number of months in a year.
int	getMonthsPerYear(int year) Get the number of months in the given year.
boolean	isLeapMonth(int packedMonth) Returns whether a certain packed month is a leap month, i.e. a month that exists in certain years only.
int	monthNum(int packedMonth) Returns the month number of a packed month.
long	nextDay(long instance) Moves the given instance forward to the next (existing day).
long	nextDay(long instance, int n) Moves the given instance forward by one or more days.
long	nextMonth(long instance) Moves the given instance forward by one month.
long	nextMonth(long instance, int n) Moves the given instance forward by one or more months.
int	packedMonth(int monthNum, boolean leapMonth) Returns a packed month, which is a combination of the month number and a leap month flag.
int	packedMonth(java.lang.String month) Returns a packed month from a string representation.
java.lang.String	packedMonthToString(int packedMonth) Convert the packed month to a numerical string representation.
long	prevDay(long instance) Moves the given instance backward to the previous (existing) day.
long	prevDay(long instance, int n) Moves the given instance backward by one or more days.
long	prevMonth(long instance) Moves the given instance backward by one month.
long	prevMonth(long instance, int n) Moves the given instance backward by one or more months.

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

dayOfMonth, equals, getDayOfMonthOfYearDay, getDayOfWeek, getDayOfWeek, getDayOfYear, getDaysPerPackedMonth, getDaysPerYear, getMaxMonthDayNum, getMaxWeekNoNum, getMaxYearDayNum, getMonthAndDayOfYearDay, getPackedMonthOfYearDay, getWeekDayOfFirstYearDay, getWeekOfYear, getWeekOfYear, getWeeksPerYear, getYearDayOfFirstWeekStart, getYearDayOfIsoYear, getYearDayOfWeekStart, getYearDaysForPackedMonth, hashCode, monthAndDay, packedMonth, scaleEquals, setDayOfWeek, startOfWeek, toInstance, toMillis, toMillis, toString, validate

Methods inherited from class java.lang.Object

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

Constructor Detail

NoLeapMonthCalendarMetrics

public NoLeapMonthCalendarMetrics(java.lang.String name,
                                  Weekday weekStart,
                                  int minDaysInFirstWeek)

Create calendar metrics for a calendar without leap months with the given week numbering.

Parameters:

name - The Name of the Calendar Scale.

weekStart - The first day of the week.

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

Method Detail

packedMonth

public int packedMonth(java.lang.String month)

Description copied from class: CalendarMetrics

Returns a packed month from a string representation. The packed months are arithmetically comparable with respect to their natural order.

The string representation is the 1-based month number followed by an optional L literal to indicate a leap month.

Overrides:

packedMonth in class CalendarMetrics

Parameters:

month - The string representation of the month.

Returns:

A packed representation of the month.

packedMonthToString

public java.lang.String packedMonthToString(int packedMonth)

Description copied from class: CalendarMetrics

Convert the packed month to a numerical string representation.

Overrides:

packedMonthToString in class CalendarMetrics

Parameters:

packedMonth - The packed month.

Returns:

The converted month.

packedMonth

public int packedMonth(int monthNum,
                       boolean leapMonth)

Description copied from class: CalendarMetrics

Returns a packed month, which is a combination of the month number and a leap month flag. The packed months are arithmetically comparable with respect to their natural order.

Note that not all calendar scales support leap months.

Overrides:

packedMonth in class CalendarMetrics

Parameters:

monthNum - The 0-based month number.

leapMonth - true if this is a leap month, false otherwise.

Returns:

A packed representation of the month.

isLeapMonth

public boolean isLeapMonth(int packedMonth)

Description copied from class: CalendarMetrics

Returns whether a certain packed month is a leap month, i.e. a month that exists in certain years only.

Overrides:

isLeapMonth in class CalendarMetrics

Parameters:

packedMonth - The packed month to test.

Returns:

true if the month is a leap month, false otherwise.

monthNum

public int monthNum(int packedMonth)

Description copied from class: CalendarMetrics

Returns the month number of a packed month.

Overrides:

monthNum in class CalendarMetrics

Parameters:

packedMonth - The packed month.

Returns:

the month number that is encoded in the packed month.

getMonthsPerYear

public int getMonthsPerYear(int year)

Description copied from class: CalendarMetrics

Get the number of months in the given year.

Specified by:

getMonthsPerYear in class CalendarMetrics

Parameters:

year - The year.

Returns:

The number of months in that year.

getMonthsPerYear

public abstract int getMonthsPerYear()

Returns the number of months in a year.

Returns:

The number of months in a year.

nextMonth

public long nextMonth(long instance)

Description copied from class: CalendarMetrics

Moves the given instance forward by one month. In many cases this is faster than CalendarMetrics.nextMonth(long, int) with n = 1.

Specified by:

nextMonth in class CalendarMetrics

Parameters:

instance - The instance to modify.

Returns:

A new instance.

nextMonth

public long nextMonth(long instance,
                      int n)

Description copied from class: CalendarMetrics

Moves the given instance forward by one or more months.

Specified by:

nextMonth in class CalendarMetrics

Parameters:

instance - The instance to modify.

n - The number of months to add.

Returns:

A new instance.

prevMonth

public long prevMonth(long instance)

Description copied from class: CalendarMetrics

Moves the given instance backward by one month. In many cases this is faster than CalendarMetrics.prevMonth(long, int) with n = 1.

Specified by:

prevMonth in class CalendarMetrics

Parameters:

instance - The instance to modify.

Returns:

A new instance.

prevMonth

public long prevMonth(long instance,
                      int n)

Description copied from class: CalendarMetrics

Moves the given instance backward by one or more months.

Specified by:

prevMonth in class CalendarMetrics

Parameters:

instance - The instance to modify.

n - The number of months to go back.

Returns:

A new instance.

nextDay

public long nextDay(long instance)

Description copied from class: CalendarMetrics

Moves the given instance forward to the next (existing day).

Specified by:

nextDay in class CalendarMetrics

Parameters:

instance - The instance to modify.

Returns:

A new instance.

nextDay

public long nextDay(long instance,
                    int n)

Description copied from class: CalendarMetrics

Moves the given instance forward by one or more days.

Specified by:

nextDay in class CalendarMetrics

Parameters:

instance - The instance to modify.

n - The number of days to add.

Returns:

A new instance.

prevDay

public long prevDay(long instance)

Description copied from class: CalendarMetrics

Moves the given instance backward to the previous (existing) day.

Specified by:

prevDay in class CalendarMetrics

Parameters:

instance - The instance to modify.

Returns:

A new instance.

prevDay

public long prevDay(long instance,
                    int n)

Description copied from class: CalendarMetrics

Moves the given instance backward by one or more days.

Specified by:

prevDay in class CalendarMetrics

Parameters:

instance - The instance to modify.

n - The number of days to go back.

Returns:

A new instance.