Configuration File

Creating a configuration file

Yaml

Normal Example

Configuration config = new YamlConfiguration(new File("path/file.yml"));
config.load(); // If the file doesn't exist it will create it.

Factory Example

PreparedConfigurationFactory factory = new PreparedConfigurationFactory(
        ConfigurationFactory.YAML,
        new File("src/test/resources/test.yml")
);
        
Configuration config = factory.create().load();

Toml

Normal Example

Configuration config = new TomlConfiguration(new File("path/file.toml"));
config.load(); // If the file doesn't exist it will create it.

Factory Example

PreparedConfigurationFactory factory = new PreparedConfigurationFactory(
        ConfigurationFactory.TOML,
        new File("src/test/resources/test.yml")
);
        
Configuration config = factory.create().load();

Read

Basic

key: "Value"

String string = config.getString("key");

There are many methods for almost all types.

Default values

String string config.getString("key", "Default value");

If the value doesn't exist or returns null, it will use the default value instead.

List | Number | String -> String

key: "Value"

or

key:
- "Element 1"
- "Element 2"

//                                  (path, list joiner, default value)
String string = config.getAdaptedString("key", "\n", "Default Value");

Write

config.set("key", "value");

Save Changes

config.save();