com.elmakers.mine.bukkit.api.data

Interface MageDataStore

public interface MageDataStore

Method Summary

Modifier and Type	Method and Description
default void	close() Close this data store.
void	delete(String id) Remove all data for a single mage
Collection<String>	getAllIds() Retrieve a list of all known Mage ids This may be used in the future for auto-migration between DataStores.
void	initialize(MageController controller, org.bukkit.configuration.ConfigurationSection configuration) Initialize the data store.
void	load(String id, MageDataCallback callback) Deprecated.
default void	load(String id, MageDataCallback callback, boolean lock) Load a single mage by id.
void	migrate(String id) Mark a Mage as having been migrated.
default void	obtainLock(MageData mage) Force-obtain a lock for a mage
void	releaseLock(MageData mage) Force-release a lock for a mage
void	save(Collection<MageData> mages) Save several Mages in a batch.
default void	save(MageData mage, MageDataCallback callback) Deprecated. Replaced by save(MageData, MageDataCallback, boolean).
void	save(MageData mage, MageDataCallback callback, boolean releaseLock) Save a single Mage.

Method Detail

initialize

void initialize(MageController controller,
                org.bukkit.configuration.ConfigurationSection configuration)

Initialize the data store. This will be called on load. Any configuration parameters set in config.yml for this store will be passed in to the ConfigurationSection here.

save

@Deprecated
default void save(MageData mage,
                              MageDataCallback callback)

Deprecated. Replaced by save(MageData, MageDataCallback, boolean).

save

void save(MageData mage,
          MageDataCallback callback,
          boolean releaseLock)

Save a single Mage.

If the provided callback is non-null, it should be called on completion.

save

void save(Collection<MageData> mages)

Save several Mages in a batch.

load

@Deprecated
void load(String id,
                      MageDataCallback callback)

Deprecated.

Load a single mage by id.

If there is no data for this mage, a new empty record should be returned.

If the provided callback is non-null, it should be called on completion.

load

default void load(String id,
                  MageDataCallback callback,
                  boolean lock)

Load a single mage by id.

If there is no data for this mage, a new empty record should be returned.

If the provided callback is non-null, it should be called on completion.

releaseLock

void releaseLock(MageData mage)

Force-release a lock for a mage

obtainLock

default void obtainLock(MageData mage)

Force-obtain a lock for a mage

delete

void delete(String id)

Remove all data for a single mage

getAllIds

Collection<String> getAllIds()

Retrieve a list of all known Mage ids This may be used in the future for auto-migration between DataStores.

migrate

void migrate(String id)

Mark a Mage as having been migrated.

This may be a deletion, backup or flagging, however the implementation prefers.

close

default void close()

Close this data store. This should close any open connections and free up any resources that would be contentious if this data store was immediately re-created.