Package org.itsallcode.whiterabbit.api.features

Interface MonthDataStorage

All Superinterfaces:

PluginFeature

public interface MonthDataStorage
extends PluginFeature

PluginFeature that provides a storage backend for month data. This class may keep the data on the local disk or on a backend server. YearMonth is used as key for loading and storing entries.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MonthDataStorage.ModelFactory	A MonthDataStorage.ModelFactory allows creating new instances of the data model.

Method Summary

Modifier and Type	Method	Description
List<YearMonth>	getAvailableDataMonths()	Get all months for that data is available in the store.
MonthDataStorage.ModelFactory	getModelFactory()	Get the model factory that can be used to create instances of the model.
Optional<MonthData>	load(YearMonth month)	Get the data for the given month.
List<MonthData>	loadAll()	Get all available data.
void	store(YearMonth month, MonthData data)	Store the data for a given month.

Method Details

load

Optional<MonthData> load(YearMonth month)

Get the data for the given month.

Parameters:

month - the month for which to load the data.

Returns:

the data for the given month.

store

void store(YearMonth month,
 MonthData data)

Store the data for a given month.

Parameters:

month - the month.

data - the data to store.

getAvailableDataMonths

List<YearMonth> getAvailableDataMonths()

Get all months for that data is available in the store.

Returns:

all months for that data is available in the store.

loadAll

List<MonthData> loadAll()

Get all available data.

Returns:

all available data.

getModelFactory

MonthDataStorage.ModelFactory getModelFactory()

Get the model factory that can be used to create instances of the model.

Returns:

the model factory that can be used to create instances of the model.