Package fr.andross.banitem

Class BanConfig

java.lang.Object

fr.andross.banitem.BanConfig

public final class BanConfig
extends Object

A cached ban configuration from a FileConfiguration

Version:

3.1

Author:

Andross

Method Summary

Modifier and Type	Method	Description
BanAnimation	getAnimation()	Get the ban animation
org.bukkit.configuration.file.FileConfiguration	getConfig()	FileConfiguration loaded in this instance
File	getConfigFile()	Get the config file used in this instance
String	getConfigName()	Get the current config file name used
Set<String>	getIgnoredInventoryTitles()	Get the ignored inventories titles
String	getPrefix()	Gives the plugin prefix used in the config (already colored)
Set<BanAction>	getPriority()	Get the ban actions which requires the highest priority
boolean	saveConfig()	Save the current config into the file

Methods inherited from class java.lang.Object

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

Method Details

getConfigName

@NotNull
public String getConfigName()

Get the current config file name used

Returns:

the current config file name used

getConfigFile

@NotNull
public File getConfigFile()

Get the config file used in this instance

Returns:

the config file used in this instance

getConfig

@NotNull
public org.bukkit.configuration.file.FileConfiguration getConfig()

FileConfiguration loaded in this instance

Returns:

the FileConfiguration loaded

saveConfig

public boolean saveConfig()

Save the current config into the file

Returns:

true if successfully saved, otherwise false

getPrefix

@NotNull
public String getPrefix()

Gives the plugin prefix used in the config (already colored)

Returns:

plugin prefix used in the config (already colored)

getPriority

@NotNull
public Set<BanAction> getPriority()

Get the ban actions which requires the highest priority

Returns:

the ban actions which requires the highest priority

getAnimation

@NotNull
public BanAnimation getAnimation()

Get the ban animation

Returns:

the ban animation

getIgnoredInventoryTitles

@NotNull
public Set<String> getIgnoredInventoryTitles()

Get the ignored inventories titles

Returns:

the ignored inventories titles