ktConfig/dev.s7a.ktconfig

Package-level declarations

Types

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.PROPERTY])
annotation class Comment(val lines: String)

Configuration comment

Link copied to clipboard
abstract class KtConfig<T : Any>(clazz: KClass<T>, type: KType)
Link copied to clipboard
open class KtConfigFile<T : Any>(clazz: KClass<T>, type: KType, file: File) : KtConfig<T>

Handle config as File.

Link copied to clipboard
interface KtConfigSerializer<T, Z>

User-defined type serializer.

Link copied to clipboard
open class KtConfigString<T : Any>(clazz: KClass<T>, type: KType) : KtConfig<T>

Handle config as String.

Link copied to clipboard
@Target(allowedTargets = [AnnotationTarget.TYPE, AnnotationTarget.CLASS])
annotation class UseSerializer(val with: KClass<out KtConfigSerializer<*, *>>)

Use a user-defined type serializer.

Functions

Link copied to clipboard
inline fun <T : Any> KtConfigFile(file: File): KtConfigFile<T>
inline fun <T : Any> KtConfigFile(file: File, default: T): KtConfigFile.Default<T>
inline fun <T : Any> KtConfigFile(file: File, noinline default: () -> T): KtConfigFile.Default<T>
inline fun <T : Any> KtConfigFile(plugin: JavaPlugin, path: String): KtConfigFile<T>
inline fun <T : Any> KtConfigFile(plugin: JavaPlugin, path: String, default: T): KtConfigFile.Default<T>
inline fun <T : Any> KtConfigFile(plugin: JavaPlugin, path: String, noinline default: () -> T): KtConfigFile.Default<T>

Handle config as File.

Link copied to clipboard
@JvmName(name = "KtConfigFile_")
inline fun <T : Any> JavaPlugin.KtConfigFile(path: String): KtConfigFile<T>
@JvmName(name = "KtConfigFile_")
inline fun <T : Any> JavaPlugin.KtConfigFile(path: String, default: T): KtConfigFile.Default<T>
@JvmName(name = "KtConfigFile_")
inline fun <T : Any> JavaPlugin.KtConfigFile(path: String, noinline default: () -> T): KtConfigFile.Default<T>

Handle config as File.

Link copied to clipboard
inline fun <T : Any> ktConfigFile(file: File): T?

Load config from file.

inline fun <T : Any> ktConfigFile(file: File, default: T): T
inline fun <T : Any> ktConfigFile(file: File, noinline default: () -> T): T

Load config from file. If file doesn't exist or is empty, save default.

inline fun <T : Any> ktConfigFile(plugin: JavaPlugin, path: String): T?

Load config from JavaPlugin.dataFolder/path.

inline fun <T : Any> ktConfigFile(plugin: JavaPlugin, path: String, default: T): T
inline fun <T : Any> ktConfigFile(plugin: JavaPlugin, path: String, noinline default: () -> T): T

Load config from JavaPlugin.dataFolder/path. If the file doesn't exist or is empty, save default.

Link copied to clipboard
@JvmName(name = "ktConfigFile_")
inline fun <T : Any> JavaPlugin.ktConfigFile(path: String): T?

Load config from JavaPlugin.dataFolder/path.

@JvmName(name = "ktConfigFile_")
inline fun <T : Any> JavaPlugin.ktConfigFile(path: String, default: T): T
@JvmName(name = "ktConfigFile_")
inline fun <T : Any> JavaPlugin.ktConfigFile(path: String, noinline default: () -> T): T

Load config from JavaPlugin.dataFolder/path. If the file doesn't exist or is empty, save default.

Link copied to clipboard
inline fun <T : Any> KtConfigString(): KtConfigString<T>
inline fun <T : Any> KtConfigString(default: T): KtConfigString.Default<T>
inline fun <T : Any> KtConfigString(noinline default: () -> T): KtConfigString.Default<T>

Handle config as String.

Link copied to clipboard
inline fun <T : Any> ktConfigString(text: String): T?

Load config from text.

inline fun <T : Any> ktConfigString(text: String, default: T): T
inline fun <T : Any> ktConfigString(text: String, noinline default: () -> T): T

Load config from text. If text is empty, return default.

Link copied to clipboard
inline fun <T : Any> saveKtConfigFile(file: File, content: T)

Save config to file.

inline fun <T : Any> saveKtConfigFile(plugin: JavaPlugin, path: String, content: T)

Save config to JavaPlugin.dataFolder/path.

Link copied to clipboard
@JvmName(name = "saveKtConfigFile_")
inline fun <T : Any> JavaPlugin.saveKtConfigFile(path: String, content: T)

Save config to JavaPlugin.dataFolder/path.

Link copied to clipboard
inline fun <T : Any> saveKtConfigString(content: T): String

Save config to string.