Package me.neznamy.tab.api.config

Class YamlConfigurationFile

java.lang.Object

me.neznamy.tab.api.config.ConfigurationFile

me.neznamy.tab.api.config.YamlConfigurationFile

public class YamlConfigurationFile
extends ConfigurationFile

YAML implementation of ConfigurationFile

Field Summary

Fields inherited from class me.neznamy.tab.api.config.ConfigurationFile

file, header, values

Constructor Summary

Constructors

Constructor	Description
YamlConfigurationFile(InputStream source, File destination)	Constructs new instance and attempts to load specified configuration file.

Method Summary

Modifier and Type	Method	Description
void	save()	Saves values from map to the file

Methods inherited from class me.neznamy.tab.api.config.ConfigurationFile

fixHeader, getBoolean, getConfigurationSection, getDouble, getFile, getInt, getInt, getName, getObject, getObject, getObject, getString, getString, getStringList, getStringList, getValues, hasConfigOption, set, setValues

Methods inherited from class java.lang.Object

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

Constructor Details

YamlConfigurationFile

public YamlConfigurationFile(InputStream source,
 File destination)
                      throws org.yaml.snakeyaml.error.YAMLException,
IOException

Constructs new instance and attempts to load specified configuration file. If file does not exist, default file is copied from source.

Parameters:

source - Source to copy file from if it does not exist

destination - File destination to use

Throws:

IllegalArgumentException - if destination is null

IllegalStateException - if file does not exist and source is null

org.yaml.snakeyaml.error.YAMLException - if file has invalid YAML syntax

IOException - if I/O operation with the file unexpectedly fails

Method Details

save

public void save()

Description copied from class: ConfigurationFile

Saves values from map to the file

Specified by:

save in class ConfigurationFile