Package me.confuser.banmanager.common.configs

Class Config

java.lang.Object

me.confuser.banmanager.common.configs.Config

Direct Known Subclasses:

ConsoleConfig, DefaultConfig, ExemptionsConfig, GeoIpConfig, MessagesConfig, ReasonsConfig, SchedulesConfig, WebhookConfig

public abstract class Config
extends Object

Field Summary

Fields

Modifier and Type	Field	Description
YamlConfiguration	conf
protected File	dataFolder
protected File	file
protected CommonLogger	logger

Constructor Summary

Constructors

Constructor	Description
Config(File dataFolder, File file, CommonLogger logger)
Config(File dataFolder, String fileName, CommonLogger logger)

Method Summary

Modifier and Type	Method	Description
abstract void	afterLoad()
boolean	load()	Lazy load
boolean	onLoad(File file)	Load configuration from file
abstract void	onSave()
void	save()
Config	setFile(File input)	Must be called before using config.load() or config.save();

Methods inherited from class java.lang.Object

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

Field Details

conf

public YamlConfiguration conf

file

protected File file

dataFolder

protected File dataFolder

logger

protected CommonLogger logger

Constructor Details

Config

public Config(File dataFolder,
 File file,
 CommonLogger logger)

Config

public Config(File dataFolder,
 String fileName,
 CommonLogger logger)

Method Details

setFile

public Config setFile(File input)

Must be called before using config.load() or config.save();

Parameters:

input -

Returns:

(Config) instance

load

public boolean load()

Lazy load

Returns:

true if the config was loaded successfully, false otherwise

afterLoad

public abstract void afterLoad()

onSave

public abstract void onSave()

onLoad

public boolean onLoad(File file)
               throws Exception

Load configuration from file

Parameters:

file - the file to load

Returns:

true if the config was loaded successfully, false otherwise

Throws:

Exception - if the file does not exist

save

public void save()