Package org.kingdoms.utils.config.adapters

Class YamlWithDefaults

java.lang.Object

org.kingdoms.utils.config.adapters.YamlWithDefaults

All Implemented Interfaces:

YamlContainer

Direct Known Subclasses:

YamlFiledDefaults, YamlResource

public abstract class YamlWithDefaults
extends Object
implements YamlContainer

Field Summary

Fields

Modifier and Type	Field	Description
protected ConfigSection	config
protected ConfigSection	defaults
protected final @Nullable File	file
protected org.snakeyaml.validation.NodeValidator	validator

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	YamlWithDefaults(@Nullable File file)

Method Summary

Modifier and Type	Method	Description
final ConfigAccessor	accessor()
YamlWithDefaults	createEmptyConfigIfNull()
void	createFile()
final ConfigSection	getConfig()
final ConfigSection	getDefaults()
protected abstract InputStream	getDefaultsInputStream()
protected abstract String	getDefaultsPath()
final @Nullable File	getFile()
protected abstract InputStream	getSchemaInputStream()
protected static InputStream	inputStreamOf(File file)
boolean	isDefault()
YamlWithDefaults	load()
protected void	loadDefaults()
protected void	loadSchema()
void	reload()
void	saveConfig()
boolean	saveDefaultConfig()	Creates directories too if needed
void	setSchema(org.snakeyaml.validation.NodeValidator validator)
protected static void	transferTo(InputStream in, OutputStream out)
void	update()
List<org.snakeyaml.validation.ValidationFailure>	validate()

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

isLoaded

Field Details

file

protected final @Nullable File file

config

protected ConfigSection config

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()

transferTo

protected static void transferTo(InputStream in,
 OutputStream out)
                          throws IOException

Throws:

IOException

createFile

public void createFile()

Specified by:

createFile in interface YamlContainer

getConfig

public final ConfigSection getConfig()

Specified by:

getConfig in interface YamlContainer

accessor

public final ConfigAccessor accessor()

Specified by:

accessor in interface YamlContainer

saveConfig

public void saveConfig()

Specified by:

saveConfig in interface YamlContainer

getFile

public final @Nullable File getFile()

Specified by:

getFile in interface YamlContainer

getDefaultsInputStream

protected abstract InputStream getDefaultsInputStream()

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()

Specified by:

load in interface YamlContainer

loadDefaults

protected void loadDefaults()

reload

public void reload()

Specified by:

reload in interface YamlContainer

createEmptyConfigIfNull

public YamlWithDefaults createEmptyConfigIfNull()

isDefault

public boolean isDefault()

getDefaults

public final ConfigSection getDefaults()

update

public void update()