Class MillisecondStore

java.lang.Object

org.lukashian.store.MillisecondStore

public final class MillisecondStore
extends Object

This singleton class manages the various instances of the Lukashian Calendar. Each instance is implemented by a MillisecondStoreDataProvider.

The int constants in the CalendarKeys class represent the instances that are supported by default. It is also possible to register your own implementation of MillisecondStoreDataProvider and register it.

The default calendar instance will be used when Year, Day and Instant methods do not specify a calendar instance. By default, the default is EARTH. It is possible to set a different default.

Data will only be requested from a MillisecondStoreDataProvider when the mechanism needs it, so no eager loading is done. Whenever data is requested, it is stored in a MillisecondStoreData object for repeated use, so MillisecondStoreDataProviders don't need to implement caching themselves.

See Also:

• MillisecondStoreData
• MillisecondStoreDataProvider

Method Summary

Modifier and Type	Method	Description
void	clearAllData()	Clears all MillisecondStoreData, so that, upon the next call to data(int), the data is re-requested from the MillisecondStoreDataProvider.
void	clearData(int key)	Clears the MillisecondStoreData corresponding to the given key, so that, upon the next call to data(int) with that key, the data is re-requested from the MillisecondStoreDataProvider.
static MillisecondStoreData	data(int calendarKey)	Shortcut method to call getData(int) on the singleton INSTANCE.
static int	defaultCalendarKey()	Shortcut method to call getDefaultCalendarKey() on the singleton INSTANCE.
MillisecondStoreData	getData(int calendarKey)	Gets the MillisecondStoreData generated by the MillisecondStoreDataProvider with the given key.
int	getDefaultCalendarKey()	Get the default calendar key, for when no explicit calendar key is provided.
void	registerProvider(int key, MillisecondStoreDataProvider provider)	Registers the given MillisecondStoreDataProvider under the given key.
void	setDefaultCalendarKey(int defaultCalendarKey)	Set the default calendar key, for when no explicit calendar key is provided.
static MillisecondStore	store()	Gets the singleton instance of the MillisecondStore.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

store

public static MillisecondStore store()

Gets the singleton instance of the MillisecondStore.

defaultCalendarKey

public static int defaultCalendarKey()

Shortcut method to call getDefaultCalendarKey() on the singleton INSTANCE.

data

public static MillisecondStoreData data(int calendarKey)

Shortcut method to call getData(int) on the singleton INSTANCE.

getDefaultCalendarKey

public int getDefaultCalendarKey()

Get the default calendar key, for when no explicit calendar key is provided.

setDefaultCalendarKey

public void setDefaultCalendarKey(int defaultCalendarKey)

Set the default calendar key, for when no explicit calendar key is provided.

registerProvider

public void registerProvider(int key,
 MillisecondStoreDataProvider provider)

Registers the given MillisecondStoreDataProvider under the given key. It is not advisable to overwrite the standard keys, i.e. the int constants in the CalendarKeys class, as other classes might depend on those constants to represent what they are intended to represent.

getData

public MillisecondStoreData getData(int calendarKey)

Gets the MillisecondStoreData generated by the MillisecondStoreDataProvider with the given key.

Data is requested from the MillisecondStoreDataProvider only once, after which it is stored for future use.

Throws:

LukashianException - when the given key is not mapped to a MillisecondStoreDataProvider

clearData

public void clearData(int key)

Clears the MillisecondStoreData corresponding to the given key, so that, upon the next call to data(int) with that key, the data is re-requested from the MillisecondStoreDataProvider.

clearAllData

public void clearAllData()

Clears all MillisecondStoreData, so that, upon the next call to data(int), the data is re-requested from the MillisecondStoreDataProvider.