Package me.hsgamer.hscore.bukkit.config

Class BukkitConfig

java.lang.Object

me.hsgamer.hscore.bukkit.config.BukkitConfig

All Implemented Interfaces:

Config

public class BukkitConfig
extends Object
implements Config

The bukkit configuration

Field Summary

Fields inherited from interface me.hsgamer.hscore.config.Config

LOGGER

Constructor Summary

Constructors

Constructor	Description
BukkitConfig(File file)	Create a new config
BukkitConfig(org.bukkit.plugin.Plugin plugin)	Create a new config, the file name will be "config.yml"
BukkitConfig(org.bukkit.plugin.Plugin plugin, String filename)	Create a new config

Method Summary

Modifier and Type	Method	Description
boolean	contains(String... path)	Check if the configuration contains the path
Object	get(Object def, String... path)	Get the value from the path
List<String>	getComment(CommentType type, String... path)	Get the comment.
String	getName()	Get the name of the configuration
org.bukkit.configuration.file.YamlConfiguration	getOriginal()	Get the original instance
Map<String[],Object>	getValues(boolean deep, String... path)	Get all values from the path
boolean	isNormalizable(Object object)	Check if the object is normalizable
Object	normalize(Object object)	Normalize the library-specific object
void	reload()	Reload the configuration
void	save()	Save the configuration
void	set(Object value, String... path)	Set the value to the path
void	setComment(CommentType type, List<String> value, String... path)	Set the comment This is a default empty method.
void	setup()	Set up the configuration

Methods inherited from class java.lang.Object

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

Methods inherited from interface me.hsgamer.hscore.config.Config

clear, get, getComment, getInstance, getInstance, getKeys, getNormalized, getNormalized, getNormalizedValues, isInstance, normalizeObject, remove, setComment, setIfAbsent, setIfAbsent

Constructor Details

BukkitConfig

public BukkitConfig(File file)

Create a new config

Parameters:

file - the file

BukkitConfig

public BukkitConfig(org.bukkit.plugin.Plugin plugin,
 String filename)

Create a new config

Parameters:

plugin - the plugin

filename - the file name

BukkitConfig

public BukkitConfig(org.bukkit.plugin.Plugin plugin)

Create a new config, the file name will be "config.yml"

Parameters:

plugin - the plugin

Method Details

getOriginal

public org.bukkit.configuration.file.YamlConfiguration getOriginal()

Description copied from interface: Config

Get the original instance

Specified by:

getOriginal in interface Config

Returns:

the original instance

get

public Object get(Object def,
 String... path)

Description copied from interface: Config

Get the value from the path

Specified by:

get in interface Config

Parameters:

def - the default value if the value is not found

path - the path

Returns:

the value

set

public void set(Object value,
 String... path)

Description copied from interface: Config

Set the value to the path

Specified by:

set in interface Config

Parameters:

value - the value

path - the path

contains

public boolean contains(String... path)

Description copied from interface: Config

Check if the configuration contains the path

Specified by:

contains in interface Config

Parameters:

path - the path

Returns:

true if it does

getName

public String getName()

Description copied from interface: Config

Get the name of the configuration

Specified by:

getName in interface Config

Returns:

the name

getValues

public Map<String[],Object> getValues(boolean deep,
 String... path)

Description copied from interface: Config

Get all values from the path

Specified by:

getValues in interface Config

Parameters:

deep - should we go deeper from the path?

path - the path

Returns:

the values

normalize

public Object normalize(Object object)

Description copied from interface: Config

Normalize the library-specific object

Specified by:

normalize in interface Config

Parameters:

object - the object

Returns:

the normalized object

isNormalizable

public boolean isNormalizable(Object object)

Description copied from interface: Config

Check if the object is normalizable

Specified by:

isNormalizable in interface Config

Parameters:

object - the object

Returns:

true if it is

setup

public void setup()

Description copied from interface: Config

Set up the configuration

Specified by:

setup in interface Config

save

public void save()

Description copied from interface: Config

Save the configuration

Specified by:

save in interface Config

reload

public void reload()

Description copied from interface: Config

Reload the configuration

Specified by:

reload in interface Config

getComment

public List<String> getComment(CommentType type,
 String... path)

Description copied from interface: Config

Get the comment. This is a default empty method. The implementation can override this method to support comments.

Specified by:

getComment in interface Config

Parameters:

type - the comment type

path - the path

Returns:

the comment

setComment

public void setComment(CommentType type,
 List<String> value,
 String... path)

Description copied from interface: Config

Set the comment This is a default empty method. The implementation can override this method to support comments.

Specified by:

setComment in interface Config

Parameters:

type - the comment type

value - the comment, can be null to remove the comment

path - the path