Package me.a8kj.config.builder

Class StringConfigBuilder

java.lang.Object

me.a8kj.config.builder.StringConfigBuilder

public class StringConfigBuilder
extends Object

A simplified builder class specifically designed for configurations that use String keys. This builder pre-initializes with StringMapPairedDataMemory to streamline the creation process.

Since:

0.1

Author:

a8kj7sea

Method Summary

Modifier and Type	Method	Description
StringConfigBuilder	at(PathProvider pathProvider)	Sets the provider responsible for resolving the configuration's file path.
ConfigFile<String>	build()	Constructs the final ConfigFile with a guaranteed string-based memory.
static StringConfigBuilder	create()	Static factory method to create a new instance of the string-based config builder.
StringConfigBuilder	memory(StringMapPairedDataMemory memory)	Allows overriding the default string memory implementation.
StringConfigBuilder	meta(ConfigMeta meta)	Sets the configuration metadata including the name and path logic.

Methods inherited from class java.lang.Object

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

Method Details

create

public static StringConfigBuilder create()

Static factory method to create a new instance of the string-based config builder.

Returns:

a new StringConfigBuilder instance.

Since:

0.1

meta

public StringConfigBuilder meta(ConfigMeta meta)

Sets the configuration metadata including the name and path logic.

Parameters:

meta - the ConfigMeta instance.

Returns:

the current builder instance for chaining.

Since:

0.1

at

public StringConfigBuilder at(PathProvider pathProvider)

Sets the provider responsible for resolving the configuration's file path.

Parameters:

pathProvider - the PathProvider instance.

Returns:

the current builder instance for chaining.

Since:

0.1

memory

public StringConfigBuilder memory(StringMapPairedDataMemory memory)

Allows overriding the default string memory implementation.

Parameters:

memory - a custom StringMapPairedDataMemory instance.

Returns:

the current builder instance for chaining.

Since:

0.1

build

public ConfigFile<String> build()

Constructs the final ConfigFile with a guaranteed string-based memory.

Returns:

a fully initialized ConfigFile with String keys.

Throws:

NullPointerException - if meta or pathProvider are null.

Since:

0.1