bg.util.leto.api

Interface Leto

All Known Implementing Classes:

LetoBase, LetoBulgarian, LetoGeneric, LetoGregorian, LetoJulian

public interface Leto

This is the interface each Leto (Calendar) has to define.

Method Summary

Modifier and Type	Method and Description
LetoPeriod[]	calculateCalendarPeriods(long days) Calculate the periods based on the number of days since the leto (calendar) EPOCH.
long	calculateDaysFronStartOfCalendar(long year, long month, long day) This method is the reverse of the prevuos method (calculateCalendarPeriods).
LetoPeriodType[]	getCalendarPeriodTypes()
java.lang.String	getDescription() Get the human readable description of this calendar in the default locale.
java.lang.String	getDescription(java.util.Locale locale) Long description of this calendar system.
java.util.Map<java.util.Locale,java.lang.String>	getDescriptionTranslations() Get the available translations in human spoken languages of this calendar descripton.
java.lang.String	getName() Get the name of this calendar in the default locale.
java.lang.String	getName(java.util.Locale locale) Short name of this calendar system.
java.util.Map<java.util.Locale,java.lang.String>	getNameTranslations() Get the available translations of the name of this calendar in different human spoken languages.
long	getStartOfCalendarBeforeUnixEpoch() Get the start of the calendar before unix epoch in days.

Method Detail

getName

java.lang.String getName()

Get the name of this calendar in the default locale.

Returns:

The name of this calendar in the default locale.

getName

java.lang.String getName(java.util.Locale locale)

Short name of this calendar system.

Parameters:

locale - The localization to be used.

Returns:

Short name of that calendar system.

getNameTranslations

java.util.Map<java.util.Locale,java.lang.String> getNameTranslations()

Get the available translations of the name of this calendar in different human spoken languages.

Returns:

The available translations of the name of this calendar in different human spoken languages.

getDescription

java.lang.String getDescription()

Get the human readable description of this calendar in the default locale.

Returns:

The human readable long description of this calendar using the default locale.

getDescription

java.lang.String getDescription(java.util.Locale locale)

Long description of this calendar system.

Parameters:

locale - The localization to be used.

Returns:

The long humand readable description of this calendar system.

getDescriptionTranslations

java.util.Map<java.util.Locale,java.lang.String> getDescriptionTranslations()

Get the available translations in human spoken languages of this calendar descripton.

Returns:

The available translations to human spoken languages of this calendar description.

getStartOfCalendarBeforeUnixEpoch

long getStartOfCalendarBeforeUnixEpoch()

Get the start of the calendar before unix epoch in days. In other words how many days have passed since the start of the calendar till t he Unix Epoch (1-st January 1970).

Returns:

The number of days after the start of the calendar and beofre Unix Epoch.

getCalendarPeriodTypes

LetoPeriodType[] getCalendarPeriodTypes()

Returns:

Period types.

calculateCalendarPeriods

LetoPeriod[] calculateCalendarPeriods(long days)
                               throws LetoException

Calculate the periods based on the number of days since the leto (calendar) EPOCH.

Parameters:

days - Number of days since the calendar starts.

Returns:

The calculated array of periods.

Throws:

LetoException - If there is some unrecoverable error while calculating the date.

calculateDaysFronStartOfCalendar

long calculateDaysFronStartOfCalendar(long year,
                                      long month,
                                      long day)
                               throws LetoException

This method is the reverse of the prevuos method (calculateCalendarPeriods). It would get year, month and a day and will try to get how many days have passes since the start of the calendar. That is a convenient method. Please note that the value of the year an absolute value from the beginning of the calendar. It is not the year for the current (upper level period such as a century). On the other side the month is the manth iside the given year (day from the beginning of the year) and day is the day inside the given month (day from the begining of the month).

Parameters:

year - Year

month - Month

day - Day

Returns:

Number of days since the begining of the calendar.

Throws:

LetoException - If something goes wrong.