Package me.a8kj.config.file

Class BasicBukkitConfig

java.lang.Object

me.a8kj.config.file.BaseConfig<String>

me.a8kj.config.file.BukkitConfig<String>

me.a8kj.config.file.BasicBukkitConfig

All Implemented Interfaces:

CreatableConfig<String>, CRUDOperations<String>, DeletableConfig<String>, ReadableConfig<String>, UpdatableConfig<String>

Direct Known Subclasses:

AutoReadBukkitConfig

public class BasicBukkitConfig
extends BukkitConfig<String>

A standard implementation of BukkitConfig specifically designed for YAML files.

This class bridges the gap between Bukkit's YamlConfiguration and the Moxie memory system. It implements the lifecycle hooks from BaseConfig to dispatch events through the ConfigAPI.

Since:

0.1

Author:

a8kj7sea

Constructor Summary

Constructors

Constructor	Description
BasicBukkitConfig()

Method Summary

Modifier and Type	Method	Description
protected void	onPostCreate(ConfigFile<String> config)	Dispatches a ConfigCreateEvent after the configuration file is successfully created.
protected void	onPostDelete(ConfigFile<String> config)	Dispatches a ConfigDeleteEvent after the configuration file is successfully deleted.
ConfigOperation<String>	read()	Creates a ConfigOperation to read data from a YAML file into memory.
ConfigOperation<String>	update()	Creates a ConfigOperation to save the current memory state back to a YAML file.

Methods inherited from class me.a8kj.config.file.BaseConfig

create, delete, getReader, getWriter, onPreCreate, onPreDelete

Methods inherited from class java.lang.Object

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

Constructor Details

BasicBukkitConfig

public BasicBukkitConfig()

Method Details

onPostCreate

protected void onPostCreate(ConfigFile<String> config)

Dispatches a ConfigCreateEvent after the configuration file is successfully created.

Overrides:

onPostCreate in class BaseConfig<String>

Parameters:

config - The created configuration file instance.

onPostDelete

protected void onPostDelete(ConfigFile<String> config)

Dispatches a ConfigDeleteEvent after the configuration file is successfully deleted.

Overrides:

onPostDelete in class BaseConfig<String>

Parameters:

config - The deleted configuration file instance.

read

public ConfigOperation<String> read()

Creates a ConfigOperation to read data from a YAML file into memory.

The operation loads the YamlConfiguration from disk and populates the memory buffer with non-section keys.

Specified by:

read in interface ReadableConfig<String>

Specified by:

read in class BaseConfig<String>

Returns:

a ConfigOperation for reading YAML data.

update

public ConfigOperation<String> update()

Creates a ConfigOperation to save the current memory state back to a YAML file.

This operation synchronizes the MapPairedDataMemory storage with a YamlConfiguration instance before saving to disk.

Specified by:

update in interface UpdatableConfig<String>

Specified by:

update in class BaseConfig<String>

Returns:

a ConfigOperation for updating YAML disk storage.