FilesModule/xyz.theprogramsrc.filesmodule.config/YmlConfig

YmlConfig

class YmlConfig(val file: File)

Representation of a YAML config file

Parameters

file

The file to load the config from (usually a file ending in .yml)

Constructors

YmlConfig

constructor(file: File)

Properties

config

var config: YamlConfiguration

The raw YamlConfiguration file

file

val file: File

Functions

add

fun add(path: String, value: Any): YmlConfig

Adds the value of the given path without replacing it if it already exists

destroy

fun destroy(): YmlConfig

Destroys the config file

entries

fun entries(deep: Boolean = false): Set<Map.Entry<String, Any>>

Gets the entry set of the YmlConfig

get

fun get(path: String): Any

Gets the value of the given path

getBoolean

fun getBoolean(path: String): Boolean

Gets the value of the given path as a Boolean

getBooleanList

fun getBooleanList(path: String): List<Boolean>

Gets a List of Boolean from the given path

getBooleanListOrSet

fun getBooleanListOrSet(path: String, default: List<Boolean>): List<Boolean>

Gets a List of Boolean from the given path or sets the default value if it doesn't exist

getBooleanOrSet

fun getBooleanOrSet(path: String, default: Boolean): Boolean

Gets the value of the given path as a Boolean or sets the default value if it doesn't exist

getDouble

fun getDouble(path: String): Double

Gets the value of the given path as a Double

getDoubleList

fun getDoubleList(path: String): List<Double>

Gets a List of Double from the given path

getDoubleListOrSet

fun getDoubleListOrSet(path: String, default: List<Double>): List<Double>

Gets a List of Double from the given path or sets the default value if it doesn't exist

getDoubleOrSet

fun getDoubleOrSet(path: String, default: Double): Double

Gets the value of the given path as a Double or sets the default value if it doesn't exist

getFloat

fun getFloat(path: String): Float

Gets the value of the given path as a Float

getFloatList

fun getFloatList(path: String): List<Float>

Gets a List of Float from the given path

getFloatListOrSet

fun getFloatListOrSet(path: String, default: List<Float>): List<Float>

Gets a List of Float from the given path or sets the default value if it doesn't exist

getFloatOrSet

fun getFloatOrSet(path: String, default: Float): Float

Gets the value of the given path as a Float or sets the default value if it doesn't exist

getInt

fun getInt(path: String): Int

Gets the value of the given path as a Int

getIntList

fun getIntList(path: String): List<Int>

Gets a List of Int from the given path

getIntListOrSet

fun getIntListOrSet(path: String, default: List<Int>): List<Int>

Gets a List of Int from the given path or sets the default value if it doesn't exist

getIntOrSet

fun getIntOrSet(path: String, default: Int): Int

Gets the value of the given path as a Int or sets the default value if it doesn't exist

getList

fun getList(path: String): List<*>

Gets a List from the given path

getListOrSet

fun getListOrSet(path: String, default: List<*>): List<*>

Gets a List from the given path or sets the default value if it doesn't exist

getLong

fun getLong(path: String): Long

Gets the value of the given path as a Long

getLongList

fun getLongList(path: String): List<Long>

Gets a List of Long from the given path

getLongListOrSet

fun getLongListOrSet(path: String, default: List<Long>): List<Long>

Gets a List of Long from the given path or sets the default value if it doesn't exist

getLongOrSet

fun getLongOrSet(path: String, default: Long): Long

Gets the value of the given path as a Long or sets the default value if it doesn't exist

getOrSet

fun getOrSet(path: String, default: Any): Any

Gets the value of the given path or sets the default value if it doesn't exist

getSection

fun getSection(path: String): ConfigurationSection

Gets a configuration section of the given path

getString

fun getString(path: String): String

Gets the value of the given path as a String

getStringList

fun getStringList(path: String): List<String>

Gets a List of String from the given path

getStringListOrSet

fun getStringListOrSet(path: String, default: List<String>): List<String>

Gets a List of String from the given path or sets the default value if it doesn't exist

getStringOrSet

fun getStringOrSet(path: String, default: String): String

Gets the value of the given path as a String or sets the default value if it doesn't exist

has

fun has(path: String): Boolean

Checks if the given path exists

keys

fun keys(deep: Boolean = false): Set<String>

Gets the keys of the YmlConfig

load

fun load(): YmlConfig

Loads the config file and clears the current cache

remove

fun remove(path: String): YmlConfig

Removes the value of the given path

save

fun save(): YmlConfig

Saves the config file

set

fun set(path: String, value: Any): YmlConfig

Sets the value of the given path