LetoBase (java 1.0.0 API)

java.lang.Object
- bg.util.leto.base.LetoBase

All Implemented Interfaces:

Leto

Direct Known Subclasses:

LetoBulgarian, LetoGeneric, LetoGregorian, LetoJulian
```
public abstract class LetoBase
extends java.lang.Object
implements Leto
```
This is an abstract class that can be used as base (parent) for any leto (calendar) implementation. It offers some usefull utilities like calculating the current date given the number of days from the leto (calendar) EPOCH.
In fact each instance of a class that inherits from LetoBase, is a representation of a given date.

Constructor Summary

Constructors
Constructor and Description

LetoBase()

Constructors
Constructor and Description
`LetoBase()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`LetoPeriod[]`	`calculateCalendarPeriods(long days)` Calculate the periods based on the number of days since the leto (calendar) EPOCH.
`protected long`	`calculateDaysFromPeriods(LetoPeriod[] periods)` Given the representation of the date by periods, this method calculates the number of days since the start of the calendar.
`long`	`calculateDaysFronStartOfCalendar(long year, long month, long day)` This method is the reverse of the prevuos method (calculateCalendarPeriods).
`java.lang.String`	`checkCorrectness()`
`abstract LetoPeriodType[]`	`getCalendarPeriodTypes()` All inheriting classes should define the supported calendar period types.
`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.
`protected abstract LocaleStringId`	`getDescriptionTranslationIndex()`
`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
`java.lang.String`	`getName(java.util.Locale locale)` Short name of this calendar system.
`protected abstract LocaleStringId`	`getNameTranslationIndex()`
`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.
`LetoPeriod[]`	`getToday()` Calculate the exact period values for the today's date.
`static void`	`main(java.lang.String[] args)`
`abstract long`	`startOfCalendarInDaysBeforeJavaEpoch()` All inheriting classes should define the beginning of their calendar in days before the java EPOCH.
`java.lang.String`	`toJson(boolean indent)`
`java.util.Map<java.lang.String,java.lang.Object>`	`toMap()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface bg.util.leto.api.Leto
getStartOfCalendarBeforeUnixEpoch

- Constructor Detail
  - LetoBase
```
public LetoBase()
```
- Method Detail
  - getNameTranslationIndex
```
protected abstract LocaleStringId getNameTranslationIndex()
```
  - getDescriptionTranslationIndex
```
protected abstract LocaleStringId getDescriptionTranslationIndex()
```
  - getName
```
public java.lang.String getName()
```
    Get the
    
    Specified by:
    
    getName in interface Leto
    
    Returns:
    
    The name of this calendar in the default locale.
  - getName
```
public java.lang.String getName(java.util.Locale locale)
```
    Description copied from interface: Leto
    
    Short name of this calendar system.
    
    Specified by:
    
    getName in interface Leto
    
    Parameters:
    
    locale - The localization to be used.
    
    Returns:
    
    Short name of that calendar system.
  - getDescription
```
public java.lang.String getDescription()
```
    Description copied from interface: Leto
    
    Get the human readable description of this calendar in the default locale.
    
    Specified by:
    
    getDescription in interface Leto
    
    Returns:
    
    The human readable long description of this calendar using the default locale.
  - getDescription
```
public java.lang.String getDescription(java.util.Locale locale)
```
    Description copied from interface: Leto
    
    Long description of this calendar system.
    
    Specified by:
    
    getDescription in interface Leto
    
    Parameters:
    
    locale - The localization to be used.
    
    Returns:
    
    The long humand readable description of this calendar system.
  - getNameTranslations
```
public java.util.Map<java.util.Locale,java.lang.String> getNameTranslations()
```
    Description copied from interface: Leto
    
    Get the available translations of the name of this calendar in different human spoken languages.
    
    Specified by:
    
    getNameTranslations in interface Leto
    
    Returns:
    
    The available translations of the name of this calendar in different human spoken languages.
  - getDescriptionTranslations
```
public java.util.Map<java.util.Locale,java.lang.String> getDescriptionTranslations()
```
    Description copied from interface: Leto
    
    Get the available translations in human spoken languages of this calendar descripton.
    
    Specified by:
    
    getDescriptionTranslations in interface Leto
    
    Returns:
    
    The available translations to human spoken languages of this calendar description.
  - startOfCalendarInDaysBeforeJavaEpoch
```
public abstract long startOfCalendarInDaysBeforeJavaEpoch()
```
    All inheriting classes should define the beginning of their calendar in days before the java EPOCH.
    
    Returns:
    
    The beginning of calendar in days before java EPOCH.
  - getCalendarPeriodTypes
```
public abstract LetoPeriodType[] getCalendarPeriodTypes()
```
    All inheriting classes should define the supported calendar period types. For example the Gregorian calendar would return day, month, year, century (a period of 100 years) and 400 years period.
    
    Specified by:
    
    getCalendarPeriodTypes in interface Leto
    
    Returns:
    
    An array of all of the supported period types sorted in increasing order. The smolest period first (with lower index).
  - getToday
```
public LetoPeriod[] getToday()
                      throws LetoException
```
    Calculate the exact period values for the today's date. In general this method will calculate how much days have elapsed since Java epoch (1-st January 1970) an then add the days from the beginning of the calendar. Based on that data it would try to split that amount of dates into periods and fill in a LetoPeriod array. The LetoPeriod array should have the exact same size as the array returned by getCalendarPeriodTypes().
    
    Returns:
    
    The exact period values of the current today's date.
    
    Throws:
    
    LetoException - If there is a problem during calculation or if the calendar internal structures are not well defined.
  - calculateCalendarPeriods
```
public LetoPeriod[] calculateCalendarPeriods(long days)
                                      throws LetoException
```
    Calculate the periods based on the number of days since the leto (calendar) EPOCH.
    
    Specified by:
    
    calculateCalendarPeriods in interface Leto
    
    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
```
public 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).
    
    Specified by:
    
    calculateDaysFronStartOfCalendar in interface Leto
    
    Parameters:
    
    year - Year
    
    month - Month
    
    day - Day
    
    Returns:
    
    Number of days since the begining of the calendar.
    
    Throws:
    
    LetoException - If something goes wrong.
  - main
```
public static void main(java.lang.String[] args)
                 throws java.lang.Throwable
```
    Throws:
    
    java.lang.Throwable
  - calculateDaysFromPeriods
```
protected long calculateDaysFromPeriods(LetoPeriod[] periods)
                                 throws LetoException
```
    Given the representation of the date by periods, this method calculates the number of days since the start of the calendar.
    
    Parameters:
    
    periods - An array of periods.
    
    Returns:
    
    The number of days since the start of the calendar.
    
    Throws:
    
    LetoException - If there is some unrecoverable error during calculation.
  - checkCorrectness
```
public java.lang.String checkCorrectness()
```
  - toMap
```
public java.util.Map<java.lang.String,java.lang.Object> toMap()
```
  - toJson
```
public java.lang.String toJson(boolean indent)
```

Class LetoBase

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface bg.util.leto.api.Leto

Constructor Detail

LetoBase

Method Detail

getNameTranslationIndex

getDescriptionTranslationIndex

getName

getName

getDescription

getDescription

getNameTranslations

getDescriptionTranslations

startOfCalendarInDaysBeforeJavaEpoch

getCalendarPeriodTypes

getToday

calculateCalendarPeriods

calculateDaysFronStartOfCalendar

main

calculateDaysFromPeriods

checkCorrectness

toMap

toJson