net.minecore

Class Miner

java.lang.Object

net.minecore.Miner

public class Miner
extends java.lang.Object

Stores data for a player.

Author:

The Numenorean

Constructor Summary

Constructors

Constructor and Description
Miner(java.lang.String playerName) Creates a player with a blank configuration and the given player name

Method Summary

Methods

Modifier and Type	Method and Description
org.bukkit.configuration.Configuration	getConfiguration() Gets the base configuration that the data is stored in.
org.bukkit.configuration.ConfigurationSection	getConfigurationSection(java.lang.String path) Gets a configuration section from this miner's conf, or creates it if it doesnt exist.
java.lang.String	getPlayerName() Gets the name of the player this represents.
java.lang.Object	getValue(java.lang.String path) Helper method.
static Miner	loadMinerFromYamlFile(java.lang.String name, java.io.File f) Loads player data from the given yaml file and returns a new Miner
void	saveMinerToYamlFile(java.io.File f) Saves all the player data to a yaml file at the given location.
void	setValue(java.lang.String path, java.lang.Object value) Helper method.

Methods inherited from class java.lang.Object

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

Constructor Detail

Miner

public Miner(java.lang.String playerName)

Creates a player with a blank configuration and the given player name

Parameters:

playerName - The Name of the player.

Method Detail

getPlayerName

public java.lang.String getPlayerName()

Gets the name of the player this represents.

Returns:

The string representation of a player

getConfigurationSection

public org.bukkit.configuration.ConfigurationSection getConfigurationSection(java.lang.String path)

Gets a configuration section from this miner's conf, or creates it if it doesnt exist.

Parameters:

path - The path to the section

Returns:

A ConfigurationSection

getValue

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

Helper method. Gets a value from the conf for this miner.

Parameters:

path - The path to the value.

Returns:

An objectt, or null

setValue

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

Helper method. Sets a value.

Parameters:

path - Path to the value

value - The value to set.

getConfiguration

public org.bukkit.configuration.Configuration getConfiguration()

Gets the base configuration that the data is stored in.

Returns:

A Configuration

saveMinerToYamlFile

public void saveMinerToYamlFile(java.io.File f)
                         throws java.io.FileNotFoundException,
                                java.io.IOException,
                                org.bukkit.configuration.InvalidConfigurationException

Saves all the player data to a yaml file at the given location.

Parameters:

f - File to save to.

Throws:

java.io.FileNotFoundException

java.io.IOException

org.bukkit.configuration.InvalidConfigurationException

loadMinerFromYamlFile

public static Miner loadMinerFromYamlFile(java.lang.String name,
                          java.io.File f)
                                   throws java.io.IOException,
                                          org.bukkit.configuration.InvalidConfigurationException

Loads player data from the given yaml file and returns a new Miner

Parameters:

name - Name of the player

f - File to load from

Returns:

A new Miner

Throws:

java.io.IOException

org.bukkit.configuration.InvalidConfigurationException