Package xyz.srnyx.annoyingapi.file.okaeri

Class ConfigBuilder

java.lang.Object

xyz.srnyx.annoyingapi.file.okaeri.ConfigBuilder

public class ConfigBuilder
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
final @NotNull AnnoyingPlugin	plugin

Constructor Summary

Constructors

Constructor	Description
ConfigBuilder(@NotNull AnnoyingPlugin plugin)	config.yml in JavaPlugin.getDataFolder()
ConfigBuilder(@NotNull AnnoyingPlugin plugin, @NotNull File file)
ConfigBuilder(@NotNull AnnoyingPlugin plugin, @NotNull String name)

Method Summary

Modifier and Type	Method	Description
<C> C	build()
@NotNull ConfigBuilder	config(@NotNull Class<?> configClass)	Must be an instance of OkaeriConfig
@NotNull ConfigBuilder	config(@NotNull Object config)	Must be an instance of OkaeriConfig
@NotNull ConfigBuilder	configMigrations(@NotNull eu.okaeri.configs.migrate.ConfigMigration @NotNull ... migrations)
@NotNull ConfigBuilder	configMigrations(@NotNull Collection<eu.okaeri.configs.migrate.ConfigMigration> migrations)
@NotNull ConfigBuilder	configure(@Nullable Consumer<eu.okaeri.configs.OkaeriConfigOptions> configure)
@NotNull ConfigBuilder	configurer(@Nullable Consumer<eu.okaeri.configs.yaml.bukkit.YamlBukkitConfigurer> configurer)
@NotNull ConfigBuilder	deleteOldDefaultFile(boolean deleteOldDefaultFile)
@NotNull ConfigBuilder	file(@NotNull File file)
@NotNull ConfigBuilder	file(@NotNull String name)
@NotNull ConfigBuilder	internalStateMigrations(@NotNull eu.okaeri.configs.migrate.ConfigMigration @NotNull ... migrations)
@NotNull ConfigBuilder	internalStateMigrations(@NotNull Collection<eu.okaeri.configs.migrate.ConfigMigration> migrations)
@NotNull ConfigBuilder	renameKebabCaseToSnakeCase(boolean renameKebabCaseToSnakeCase)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

plugin

@NotNull
public final @NotNull AnnoyingPlugin plugin

Constructor Details

ConfigBuilder

public ConfigBuilder(@NotNull
 @NotNull AnnoyingPlugin plugin,
 @NotNull
 @NotNull File file)

ConfigBuilder

public ConfigBuilder(@NotNull
 @NotNull AnnoyingPlugin plugin,
 @NotNull
 @NotNull String name)

Parameters:

name - relative to JavaPlugin.getDataFolder()

ConfigBuilder

public ConfigBuilder(@NotNull
 @NotNull AnnoyingPlugin plugin)

config.yml in JavaPlugin.getDataFolder()

Method Details

file

@NotNull
public @NotNull ConfigBuilder file(@NotNull
 @NotNull File file)

file

@NotNull
public @NotNull ConfigBuilder file(@NotNull
 @NotNull String name)

config

@NotNull
public @NotNull ConfigBuilder config(@NotNull
 @NotNull Object config)

Must be an instance of OkaeriConfig

config

@NotNull
public @NotNull ConfigBuilder config(@NotNull
 @NotNull Class<?> configClass)

Must be an instance of OkaeriConfig

configure

@NotNull
public @NotNull ConfigBuilder configure(@Nullable
 @Nullable Consumer<eu.okaeri.configs.OkaeriConfigOptions> configure)

configurer

@NotNull
public @NotNull ConfigBuilder configurer(@Nullable
 @Nullable Consumer<eu.okaeri.configs.yaml.bukkit.YamlBukkitConfigurer> configurer)

internalStateMigrations

@NotNull
public @NotNull ConfigBuilder internalStateMigrations(@NotNull
 @NotNull Collection<eu.okaeri.configs.migrate.ConfigMigration> migrations)

internalStateMigrations

@NotNull
public @NotNull ConfigBuilder internalStateMigrations(@NotNull
 @NotNull eu.okaeri.configs.migrate.ConfigMigration @NotNull ... migrations)

configMigrations

@NotNull
public @NotNull ConfigBuilder configMigrations(@NotNull
 @NotNull Collection<eu.okaeri.configs.migrate.ConfigMigration> migrations)

configMigrations

@NotNull
public @NotNull ConfigBuilder configMigrations(@NotNull
 @NotNull eu.okaeri.configs.migrate.ConfigMigration @NotNull ... migrations)

renameKebabCaseToSnakeCase

@NotNull
public @NotNull ConfigBuilder renameKebabCaseToSnakeCase(boolean renameKebabCaseToSnakeCase)

deleteOldDefaultFile

@NotNull
public @NotNull ConfigBuilder deleteOldDefaultFile(boolean deleteOldDefaultFile)

build

@NotNull
public <C> C build()