rebar/io.github.pylonmc.rebar.config/Config

Config

class Config(val file: File, val internalConfig: YamlConfiguration = YamlConfiguration.loadConfiguration(file)) : ConfigSection(source)

Wraps a config file and provides useful facilities for writing/reading it.

If the file changes on disk, you will need to create a new Config object to get the latest version of the file.

Constructors

Config

constructor(path: Path)

constructor(plugin: Plugin, path: String)

constructor(file: File, internalConfig: YamlConfiguration = YamlConfiguration.loadConfiguration(file))

Properties

file

val file: File

internalConfig

val internalConfig: YamlConfiguration

The YamlConfiguration that this object wraps.

internalSection

val internalSection: ConfigurationSection

keys

val keys: Set<String>

Returns all the keys in the section.

Functions

createSection

fun createSection(key: String): ConfigSection

get

fun <T> get(key: String, adapter: ConfigAdapter<T>): T?

Returns null if the key does not exist or if the value cannot be converted to the desired type.

fun <T> get(key: String, adapter: ConfigAdapter<T>, defaultValue: T): T

Returns defaultValue if the key does not exist or if the value cannot be converted to the desired type.

fun <T> get(key: String, adapter: ConfigAdapter<T>, defaultValue: () -> T): T

Returns the computed defaultValue if the key does not exist or if the value cannot be converted to the desired type.

getOrThrow

fun <T> getOrThrow(key: String, adapter: ConfigAdapter<T>): T

Throws an error if the key does not exist or if the value cannot be converted to the desired type.

getSection

fun getSection(key: String): ConfigSection?

getSectionOrThrow

fun getSectionOrThrow(key: String): ConfigSection

getSections

fun getSections(): List<ConfigSection>

Gets all the values in the section that are themselves sections.

merge

fun merge(other: ConfigSection)

'Merges' other with this ConfigSection by copying all of its keys into this ConfigSection. If a key exists in both section, this ConfigSection's keys take priority.

save

fun save()

Saves the configuration to the file it was loaded from.

set

fun <T> set(key: String, value: T)