Package me.a8kj.config.file.impl

Class BasicVelocityConfig

java.lang.Object

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

me.a8kj.config.file.impl.BasicVelocityConfig

All Implemented Interfaces:

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

public class BasicVelocityConfig
extends BaseConfig<String>

A specialized implementation of configuration for Velocity using Configurate 4.

This version supports both GenericMap and MapPaired memory types to ensure data is correctly persisted to disk using Yaml BLOCK style for better readability.

Since:

0.2

Author:

a8kj7sea

Constructor Summary

Constructors

Constructor	Description
BasicVelocityConfig()

Method Summary

Modifier and Type	Method	Description
protected void	onPostCreate(ConfigFile<String> config)	Logic executed after the configuration file is created.
protected void	onPostDelete(ConfigFile<String> config)	Logic executed after the configuration file is deleted.
ConfigOperation<String>	read()	Provides a read operation to load Yaml data into memory.
ConfigOperation<String>	update()	Provides an update operation to save memory state back to 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

BasicVelocityConfig

public BasicVelocityConfig()

Method Details

onPostCreate

protected void onPostCreate(ConfigFile<String> config)

Logic executed after the configuration file is created. Fires ConfigCreateEvent and logs the process.

Overrides:

onPostCreate in class BaseConfig<String>

Parameters:

config - The configuration file instance.

onPostDelete

protected void onPostDelete(ConfigFile<String> config)

Logic executed after the configuration file is deleted. Fires ConfigDeleteEvent and logs the warning.

Overrides:

onPostDelete in class BaseConfig<String>

Parameters:

config - The configuration file instance.

read

public ConfigOperation<String> read()

Provides a read operation to load Yaml data into memory. Uses BLOCK style and 2-space indentation by default.

Specified by:

read in interface ReadableConfig<String>

Specified by:

read in class BaseConfig<String>

Returns:

A ConfigOperation for reading data.

update

public ConfigOperation<String> update()

Provides an update operation to save memory state back to Yaml file. Supports multi-layer path resolution by splitting keys with dot notation.

Specified by:

update in interface UpdatableConfig<String>

Specified by:

update in class BaseConfig<String>

Returns:

A ConfigOperation for updating data.