com.chrismin13.additionsapi.files

Class DataFile

java.lang.Object

com.chrismin13.additionsapi.files.DataFile

public class DataFile
extends java.lang.Object

Offers an easy way to access the data.yml without having to get the plugin's instance every time. Instead, most of the file's values can be received easily without having to know the value names.
You must use getInstance() to access the file and it's values.

Author:

chrismin13

Method Summary

Modifier and Type	Method and Description
DataFile	addCustomItemStack(CustomItemStack cStack) Converts a CustomItemStack to a StorageCustomItem to be saved in the data.yml file.
DataFile	addStorageCustomItem(StorageCustomItem sItem) Add a new StorageCustomItem to be saved in the data.yml file.
StorageCustomItem	getCustomItem(org.bukkit.Material material, short durability) Obtains a StorageCustomItem with the specified values.
StorageCustomItem	getCustomItem(java.lang.String idName, java.lang.String texture) Obtains a StorageCustomItem with the specified values.
org.bukkit.configuration.file.YamlConfiguration	getData()
short	getFreeDurability(org.bukkit.Material material) Get a durability value that does not use a texture for the specified Material.
static DataFile	getInstance()
DataFile	reloadData() Reloads the Data File, updating any changes.
DataFile	saveData() Saves the Data File.
DataFile	setup() This method is run when the plugin is enabled and when reloading.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static DataFile getInstance()

setup

public DataFile setup()

This method is run when the plugin is enabled and when reloading. Not meant to be used in any other occasion.

addStorageCustomItem

public DataFile addStorageCustomItem(StorageCustomItem sItem)

Add a new StorageCustomItem to be saved in the data.yml file.
You must also use saveData() to save the changes that you made.

Parameters:

sItem - - The StorageCustomItem to store in the data.yml.

addCustomItemStack

public DataFile addCustomItemStack(CustomItemStack cStack)

Converts a CustomItemStack to a StorageCustomItem to be saved in the data.yml file.
You must also use saveData() to save the changes that you made.

Parameters:

cStack - - The CustomItemStack to convert and save.

getCustomItem

public StorageCustomItem getCustomItem(java.lang.String idName,
                                       java.lang.String texture)

Obtains a StorageCustomItem with the specified values. If the StorageCustomItem does not exist, it will return null.

Parameters:

idName - The ID Name of the StorageCustomItem.

texture - The Texture of the StorageCustomItem

Returns:

The StorageCustomItem with the above values, as well as its Material and durability.

getCustomItem

public StorageCustomItem getCustomItem(org.bukkit.Material material,
                                       short durability)

Obtains a StorageCustomItem with the specified values. If the StorageCustomItem does not exist, it will return null.

Parameters:

material - The Material of the StorageCustomItem.

durability - The durability of the StorageCustomItem

Returns:

The StorageCustomItem with the above values, as well as its ID Name and Texture Name.

getFreeDurability

public short getFreeDurability(org.bukkit.Material material)

Get a durability value that does not use a texture for the specified Material. If there are no more durability points left, an error will be printed.

Parameters:

material - The Material for which you want a free durability point.

Returns:

The durability value that is available for the specified Material.

getData

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

Returns:

A YamlConfiguration of the data.yml file.

saveData

public DataFile saveData()

Saves the Data File.

reloadData

public DataFile reloadData()

Reloads the Data File, updating any changes.