Package org.kingdoms.utils.config.adapters

Class YamlWithDefaults

java.lang.Object

org.kingdoms.utils.config.adapters.YamlAbstractContainer

org.kingdoms.utils.config.adapters.YamlWithDefaults

All Implemented Interfaces:

YamlContainer

Direct Known Subclasses:

YamlFiledDefaults, YamlResource

public abstract class YamlWithDefaults
extends YamlAbstractContainer

Field Summary

Fields

Modifier and Type	Field	Description
protected ConfigSection	defaults
protected org.snakeyaml.validation.NodeValidator	validator

Fields inherited from class org.kingdoms.utils.config.adapters.YamlAbstractContainer

config, file, importDeclarations, importer, reloadHandle, resolveAliases

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	YamlWithDefaults(@Nullable File file)

Method Summary

Modifier and Type	Method	Description
YamlWithDefaults	createEmptyConfigIfNull()
void	createFile()
boolean	defaultExists()
final ConfigSection	getDefaults()
protected abstract InputStream	getDefaultsInputStream()
protected abstract String	getDefaultsPath()
protected abstract InputStream	getSchemaInputStream()
org.snakeyaml.validation.NodeValidator	getValidator()
protected static InputStream	inputStreamOf(File file)
boolean	isDefault()
YamlWithDefaults	load()
protected void	loadDefaults()
protected void	loadSchema()
void	reload()	Reloads the YAML from the local file (YamlContainer.getFile()) if it exists.
boolean	saveDefaultConfig()	Creates directories too if needed
void	setSchema(org.snakeyaml.validation.NodeValidator validator)
String	simpleName()	A simpler and less verbose name than Object.toString() usually the file name or path of the config.
void	update()	Updates outdated configs based on the default config.
List<org.snakeyaml.validation.ValidationFailure>	validate()

Methods inherited from class org.kingdoms.utils.config.adapters.YamlAbstractContainer

accessor, getConfig, getFile, getImportDeclarations, getImporter, reloadHandle, reloadHandle, saveConfig, setImportDeclarations, setImporter, setResolveAliases

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.kingdoms.utils.config.adapters.YamlContainer

importDeclarations, isLoaded

Field Details

defaults

protected ConfigSection defaults

validator

protected org.snakeyaml.validation.NodeValidator validator

Constructor Details

YamlWithDefaults

protected YamlWithDefaults(@Nullable File file)

Method Details

validate

public List<org.snakeyaml.validation.ValidationFailure> validate()

getValidator

public org.snakeyaml.validation.NodeValidator getValidator()

simpleName

public String simpleName()

Description copied from interface: YamlContainer

A simpler and less verbose name than Object.toString() usually the file name or path of the config.

createFile

public void createFile()

getDefaultsInputStream

protected abstract InputStream getDefaultsInputStream()

defaultExists

public boolean defaultExists()

getDefaultsPath

protected abstract String getDefaultsPath()

inputStreamOf

protected static InputStream inputStreamOf(File file)

saveDefaultConfig

public boolean saveDefaultConfig()

Creates directories too if needed

getSchemaInputStream

protected abstract InputStream getSchemaInputStream()

loadSchema

protected void loadSchema()

setSchema

public void setSchema(org.snakeyaml.validation.NodeValidator validator)

load

public YamlWithDefaults load()

loadDefaults

protected void loadDefaults()

reload

public void reload()

Description copied from interface: YamlContainer

Reloads the YAML from the local file (YamlContainer.getFile()) if it exists.

See Also:

• YamlContainer.reload()

createEmptyConfigIfNull

public YamlWithDefaults createEmptyConfigIfNull()

isDefault

public boolean isDefault()

getDefaults

public final ConfigSection getDefaults()

update

public void update()

Updates outdated configs based on the default config.