Module qilletni.api

Package dev.qilletni.api.lib.persistence

Interface PackageConfig

public interface PackageConfig

A persistent configuration file for each package.

Method Summary

Modifier and Type	Method	Description
Optional<String>	get(String key)	Get a value from the configuration.
Map<String,String>	getAll()	Get all the values in the configuration.
String	getOrThrow(String key)	Get a value from the configuration, or throw an exception if it does not exist.
void	loadConfig()	Load the configuration from the file system if it has not been read in yet.
void	reloadConfig()	Load the configuration from the file system, regardless of if it has been read in yet.
void	remove(String key)	Remove a value from the configuration.
void	saveConfig()	Save the configuration to the file system.
void	set(String key, String value)	Set a value in the configuration.

Method Details

loadConfig

void loadConfig()

Load the configuration from the file system if it has not been read in yet.

reloadConfig

void reloadConfig()

Load the configuration from the file system, regardless of if it has been read in yet. This replaces all previously read in values.

saveConfig

void saveConfig()

Save the configuration to the file system.

get

Optional<String> get(String key)

Get a value from the configuration.

Parameters:

key - The key to get the value for

Returns:

The value for the key, if it exists

getOrThrow

String getOrThrow(String key)

Get a value from the configuration, or throw an exception if it does not exist.

Parameters:

key - The key to get the value for

Returns:

The value for the key

set

void set(String key,
 String value)

Set a value in the configuration.

Parameters:

key - The key to set the value for

value - The value to set

remove

void remove(String key)

Remove a value from the configuration.

Parameters:

key - The key to remove the value for

getAll

Map<String,String> getAll()

Get all the values in the configuration.

Returns:

A map of all the values in the configuration