net.glowstone.util.config

Class WorldConfig

java.lang.Object

net.glowstone.util.config.WorldConfig

All Implemented Interfaces:

DynamicallyTypedMap<WorldConfig.Key>, DynamicallyTypedMapWithDoubles<WorldConfig.Key>, DynamicallyTypedMapWithFloats<WorldConfig.Key>

public final class WorldConfig
extends Object
implements DynamicallyTypedMapWithDoubles<WorldConfig.Key>

Utilities for handling the server configuration files.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	WorldConfig.Key An enum containing configuration keys used by the server.

Constructor Summary

Constructors

Constructor and Description
WorldConfig(File directory, File configFile) Initialize a new ServerConfig and associated settings.

Method Summary

Modifier and Type	Method and Description
boolean	getBoolean(WorldConfig.Key key) Retrieves an entry as a boolean.
org.bukkit.configuration.file.YamlConfiguration	getConfig() The actual configuration data.
File	getDirectory() The directory configurations are stored in.
double	getDouble(WorldConfig.Key key) Retrieves an entry as a double.
float	getFloat(WorldConfig.Key key) Retrieves an entry as a float.
int	getInt(WorldConfig.Key key) Retrieves an entry as an int.
String	getString(WorldConfig.Key key) Retrieves an entry as a String.
void	load() Loads the configuration from disk if it exists.
void	save() Save the configuration back to file.
void	set(WorldConfig.Key key, Object value) Change a configuration value at runtime.

Methods inherited from class java.lang.Object

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

Constructor Detail

WorldConfig

public WorldConfig(File directory,
                   File configFile)

Initialize a new ServerConfig and associated settings.

Parameters:

directory - The config directory, or null for default.

configFile - The config file, or null for default.

Method Detail

save

public void save()

Save the configuration back to file.

set

public void set(WorldConfig.Key key,
                Object value)

Change a configuration value at runtime.

Parameters:

key - the config key to write the value to

value - value to write to config key

See Also:

save()

getString

public String getString(WorldConfig.Key key)

Description copied from interface: DynamicallyTypedMap

Retrieves an entry as a String.

Specified by:

getString in interface DynamicallyTypedMap<WorldConfig.Key>

Parameters:

key - the key to look up

Returns:

the value as a String

getInt

public int getInt(WorldConfig.Key key)

Description copied from interface: DynamicallyTypedMap

Retrieves an entry as an int.

Specified by:

getInt in interface DynamicallyTypedMap<WorldConfig.Key>

Parameters:

key - the key to look up

Returns:

the value as an int

getDouble

public double getDouble(WorldConfig.Key key)

Description copied from interface: DynamicallyTypedMapWithDoubles

Retrieves an entry as a double.

Specified by:

getDouble in interface DynamicallyTypedMapWithDoubles<WorldConfig.Key>

Parameters:

key - the key to look up

Returns:

the value as a double

getFloat

public float getFloat(WorldConfig.Key key)

Description copied from interface: DynamicallyTypedMapWithFloats

Retrieves an entry as a float.

Specified by:

getFloat in interface DynamicallyTypedMapWithFloats<WorldConfig.Key>

Parameters:

key - the key to look up

Returns:

the value as a float

getBoolean

public boolean getBoolean(WorldConfig.Key key)

Description copied from interface: DynamicallyTypedMap

Retrieves an entry as a boolean.

Specified by:

getBoolean in interface DynamicallyTypedMap<WorldConfig.Key>

Parameters:

key - the key to look up

Returns:

the value as a boolean

load

public void load()

Loads the configuration from disk if it exists. Creates it if it doesn't exist, creating the folder if necessary. Completes and saves the configuration if it's incomplete.

getDirectory

public File getDirectory()

The directory configurations are stored in.

getConfig

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

The actual configuration data.