Module org.tquadrat.foundation.config

Package org.tquadrat.foundation.config

Interface INIBeanSpec

All Superinterfaces:

ConfigBeanSpec

@ClassVersion(sourceVersion="$Id: INIBeanSpec.java 1061 2023-09-25 16:32:43Z tquadrat $")
@API(status=STABLE,
     since="0.1.0")
public interface INIBeanSpec
extends ConfigBeanSpec

When a configuration bean should be connected with an INI file (a Windows style configuration file), the respective configuration bean specification interface needs to extend this interface.

A configuration bean can be connected to only one INI file, and properties that are kept in Preferences cannot be held in the INI, too, and vice versa.

The configuration bean specification must use the annotation @INIFileConfig to specify the path to the configuration file. In addition, each getter has to be annotated with @INIValue to define its coordinates in the configuration.

When the file is created by the program itself, the respective comments from the annotations will be added to the new file; for the groups, these can be provided through the @INIGroup and @INIGroups annotations

The configuration values will not be loaded automatically from the INI file. A call to loadINIFile() is required.

A call to updateINIFile() persists the respective value.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: INIBeanSpec.java 1061 2023-09-25 16:32:43Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.config.INIBeanSpec"

⁠

Method Summary

Modifier and Type	Method	Description
void	loadINIFile()	Loads the configuration values from the INIFile that is connected to this configuration bean.
Optional<INIFile>	obtainINIFile()	Returns a reference to the INIFile instance that backs up this configuration bean.
void	updateINIFile()	Persists the configuration values to the INIFile that is connected to this configuration bean.

Methods inherited from interface org.tquadrat.foundation.config.ConfigBeanSpec

addListener, getCharset, getLocale, getResourceBundle, getTimezone, isDebug, isTest, removeListener, setCharset, setLocale, setTimezone

Method Details

loadINIFile

void loadINIFile()

Loads the configuration values from the INIFile that is connected to this configuration bean.

obtainINIFile

Optional<INIFile> obtainINIFile()

Returns a reference to the INIFile instance that backs up this configuration bean.

Returns:

An instance of Optional that holds the INIFile instance.

updateINIFile

void updateINIFile()

Persists the configuration values to the INIFile that is connected to this configuration bean.