me.mrCookieSlime.CSCoreLibPlugin.Configuration

Class Config

java.lang.Object

me.mrCookieSlime.CSCoreLibPlugin.Configuration.Config

public class Config
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
Config(java.io.File file) Creates a new Config Object for the specified File
Config(org.bukkit.plugin.Plugin plugin) Creates a new Config Object for the config.yml File of the specified Plugin
Config(java.lang.String path) Creates a new Config Object for the File with in the specified Location

Method Summary

Modifier and Type	Method and Description
boolean	contains(java.lang.String path) Checks whether the Config contains the specified Path
void	createFile() Recreates the File of this Config
boolean	getBoolean(java.lang.String path) Returns the Boolean at the specified Path
org.bukkit.Chunk	getChunk(java.lang.String path) Returns the Chunk at the specified Path
org.bukkit.configuration.file.FileConfiguration	getConfiguration() Converts this Config Object into a plain FileConfiguration Object
java.util.Date	getDate(java.lang.String path) Returns the Date at the specified Path
java.lang.Double	getDouble(java.lang.String path) Returns the Double at the specified Path
java.io.File	getFile() Returns the File the Config is handling
java.lang.Float	getFloat(java.lang.String path) Returns the Float at the specified Path
int	getInt(java.lang.String path) Returns the Integer at the specified Path
java.util.List<java.lang.Integer>	getIntList(java.lang.String path) Returns the IntegerList at the specified Path
org.bukkit.inventory.Inventory	getInventory(java.lang.String path, int size, java.lang.String title) Gets the Contents of an Inventory at the specified Path
org.bukkit.inventory.ItemStack	getItem(java.lang.String path) Returns the ItemStack at the specified Path
java.util.List<org.bukkit.inventory.ItemStack>	getItemList(java.lang.String path) Returns the ItemList at the specified Path
java.util.Set<java.lang.String>	getKeys() Returns all Paths in this Config
java.util.Set<java.lang.String>	getKeys(java.lang.String path) Returns all Sub-Paths in this Config
org.bukkit.Location	getLocation(java.lang.String path) Returns the Location at the specified Path
java.lang.Long	getLong(java.lang.String path) Returns the Long at the specified Path
int	getRandomIntfromList(java.lang.String path) Returns a randomly chosen Integer from an ArrayList at the specified Path
java.lang.String	getRandomStringfromList(java.lang.String path) Returns a randomly chosen String from an ArrayList at the specified Path
org.bukkit.Sound	getSound(java.lang.String path) Returns the Sound at the specified Path
java.lang.String	getString(java.lang.String path) Returns the String at the specified Path
java.util.List<java.lang.String>	getStringList(java.lang.String path) Returns the StringList at the specified Path
java.util.UUID	getUUID(java.lang.String path) Returns the UUID at the specified Path
java.lang.Object	getValue(java.lang.String path) Returns the Object at the specified Path
org.bukkit.World	getWorld(java.lang.String path) Returns the World at the specified Path
void	reload() Reloads the Configuration File
void	save() Saves the Config Object to its File
void	save(java.io.File file) Saves the Config Object to a File
void	setDefaultValue(java.lang.String path, java.lang.Object value) Sets the Value for the specified Path (IF the Path does not yet exist)
void	setInventory(java.lang.String path, org.bukkit.inventory.Inventory inventory) Deprecated.
void	setLocation(java.lang.String path, org.bukkit.Location location) Deprecated.
void	setValue(java.lang.String path, java.lang.Object value) Sets the Value for the specified Path

Methods inherited from class java.lang.Object

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

Constructor Detail

Config

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

Creates a new Config Object for the config.yml File of the specified Plugin

Parameters:

plugin - The Instance of the Plugin, the config.yml is referring to

Config

public Config(java.io.File file)

Creates a new Config Object for the specified File

Parameters:

file - The File for which the Config object is created for

Config

public Config(java.lang.String path)

Creates a new Config Object for the File with in the specified Location

Parameters:

path - The Path of the File which the Config object is created for

Method Detail

getFile

public java.io.File getFile()

Returns the File the Config is handling

Returns:

The File this Config is handling

getConfiguration

public org.bukkit.configuration.file.FileConfiguration getConfiguration()

Converts this Config Object into a plain FileConfiguration Object

Returns:

The converted FileConfiguration Object

setValue

public void setValue(java.lang.String path,
                     java.lang.Object value)

Sets the Value for the specified Path

Parameters:

path - The path in the Config File

value - The Value for that Path

save

public void save()

Saves the Config Object to its File

save

public void save(java.io.File file)

Saves the Config Object to a File

Parameters:

file - The File you are saving this Config to

setDefaultValue

public void setDefaultValue(java.lang.String path,
                            java.lang.Object value)

Sets the Value for the specified Path (IF the Path does not yet exist)

Parameters:

path - The path in the Config File

value - The Value for that Path

contains

public boolean contains(java.lang.String path)

Checks whether the Config contains the specified Path

Parameters:

path - The path in the Config File

Returns:

True/false

getValue

public java.lang.Object getValue(java.lang.String path)

Returns the Object at the specified Path

Parameters:

path - The path in the Config File

Returns:

The Value at that Path

getItem

public org.bukkit.inventory.ItemStack getItem(java.lang.String path)

Returns the ItemStack at the specified Path

Parameters:

path - The path in the Config File

Returns:

The ItemStack at that Path

getRandomStringfromList

public java.lang.String getRandomStringfromList(java.lang.String path)

Returns a randomly chosen String from an ArrayList at the specified Path

Parameters:

path - The path in the Config File

Returns:

A randomly chosen String from the ArrayList at that Path

getRandomIntfromList

public int getRandomIntfromList(java.lang.String path)

Returns a randomly chosen Integer from an ArrayList at the specified Path

Parameters:

path - The path in the Config File

Returns:

A randomly chosen Integer from the ArrayList at that Path

getString

public java.lang.String getString(java.lang.String path)

Returns the String at the specified Path

Parameters:

path - The path in the Config File

Returns:

The String at that Path

getInt

public int getInt(java.lang.String path)

Returns the Integer at the specified Path

Parameters:

path - The path in the Config File

Returns:

The Integer at that Path

getBoolean

public boolean getBoolean(java.lang.String path)

Returns the Boolean at the specified Path

Parameters:

path - The path in the Config File

Returns:

The Boolean at that Path

getStringList

public java.util.List<java.lang.String> getStringList(java.lang.String path)

Returns the StringList at the specified Path

Parameters:

path - The path in the Config File

Returns:

The StringList at that Path

getItemList

public java.util.List<org.bukkit.inventory.ItemStack> getItemList(java.lang.String path)

Returns the ItemList at the specified Path

Parameters:

path - The path in the Config File

Returns:

The ItemList at that Path

getIntList

public java.util.List<java.lang.Integer> getIntList(java.lang.String path)

Returns the IntegerList at the specified Path

Parameters:

path - The path in the Config File

Returns:

The IntegerList at that Path

createFile

public void createFile()

Recreates the File of this Config

getFloat

public java.lang.Float getFloat(java.lang.String path)

Returns the Float at the specified Path

Parameters:

path - The path in the Config File

Returns:

The Float at that Path

getLong

public java.lang.Long getLong(java.lang.String path)

Returns the Long at the specified Path

Parameters:

path - The path in the Config File

Returns:

The Long at that Path

getSound

public org.bukkit.Sound getSound(java.lang.String path)

Returns the Sound at the specified Path

Parameters:

path - The path in the Config File

Returns:

The Sound at that Path

getDate

public java.util.Date getDate(java.lang.String path)

Returns the Date at the specified Path

Parameters:

path - The path in the Config File

Returns:

The Date at that Path

getChunk

public org.bukkit.Chunk getChunk(java.lang.String path)

Returns the Chunk at the specified Path

Parameters:

path - The path in the Config File

Returns:

The Chunk at that Path

getUUID

public java.util.UUID getUUID(java.lang.String path)

Returns the UUID at the specified Path

Parameters:

path - The path in the Config File

Returns:

The UUID at that Path

getWorld

public org.bukkit.World getWorld(java.lang.String path)

Returns the World at the specified Path

Parameters:

path - The path in the Config File

Returns:

The World at that Path

getDouble

public java.lang.Double getDouble(java.lang.String path)

Returns the Double at the specified Path

Parameters:

path - The path in the Config File

Returns:

The Double at that Path

getLocation

public org.bukkit.Location getLocation(java.lang.String path)

Returns the Location at the specified Path

Parameters:

path - The path in the Config File

Returns:

The Location at that Path

setLocation

@Deprecated
public void setLocation(java.lang.String path,
                                     org.bukkit.Location location)

Deprecated.

setInventory

@Deprecated
public void setInventory(java.lang.String path,
                                      org.bukkit.inventory.Inventory inventory)

Deprecated.

getInventory

public org.bukkit.inventory.Inventory getInventory(java.lang.String path,
                                                   int size,
                                                   java.lang.String title)

Gets the Contents of an Inventory at the specified Path

Parameters:

path - The path in the Config File

size - The Size of the Inventory

title - The Title of the Inventory

Returns:

The generated Inventory

getKeys

public java.util.Set<java.lang.String> getKeys()

Returns all Paths in this Config

Returns:

All Paths in this Config

getKeys

public java.util.Set<java.lang.String> getKeys(java.lang.String path)

Returns all Sub-Paths in this Config

Parameters:

path - The path in the Config File

Returns:

All Sub-Paths of the specified Path

reload

public void reload()

Reloads the Configuration File