org.henrya.configj

Class ConfigFile

java.lang.Object

org.henrya.configj.ConfigFile

public class ConfigFile
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
ConfigFile(java.lang.String path) A class for storing human readable data
ConfigFile(java.lang.String path, java.lang.String extension) A class for storing human readable data

Method Summary

Modifier and Type	Method and Description
void	clear() Clears all of the data saved in the file
void	delete() Deletes the file
boolean	getBoolean(java.lang.String key) Gets the value assigned to the key
byte	getByte(java.lang.String key) Gets the value assigned to the key
double	getDouble(java.lang.String key) Gets the value assigned to the key
float	getFloat(java.lang.String key) Gets the value assigned to the key
int	getInt(java.lang.String key) Gets the value assigned to the key
java.util.List<java.lang.String>	getList(java.lang.String key) Gets a List assigned to the key
long	getLong(java.lang.String key) Gets the value assigned to the key
short	getShort(java.lang.String key) Gets the value assigned to the key
java.lang.String	getString(java.lang.String key) Gets the value assigned to the key
boolean	isBoolean(java.lang.String key) Returns whether the value assigned to the key is a boolean
boolean	isByte(java.lang.String key) Returns whether the value assigned to the key is a byte
boolean	isDouble(java.lang.String key) Returns whether the value assigned to the key is a double
boolean	isFloat(java.lang.String key) Returns whether the value assigned to the key is a float
boolean	isInt(java.lang.String key) Returns whether the value assigned to the key is an integer
boolean	isLong(java.lang.String key) Returns whether the value assigned to the key is a long
boolean	isShort(java.lang.String key) Returns whether the value assigned to the key is a short
java.util.Set<java.lang.String>	keySet() Gets a list of all keys saved in the file
void	remove(java.lang.String key) Removes the specified line from the file
void	save() Saves the current data to the file
void	set(java.lang.String key, java.lang.Object value) Assigns a value to a key

Methods inherited from class java.lang.Object

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

Constructor Detail

ConfigFile

public ConfigFile(java.lang.String path)

A class for storing human readable data

Parameters:

path - The path to the new, or existing file excluding the extension

ConfigFile

public ConfigFile(java.lang.String path,
                  java.lang.String extension)

A class for storing human readable data

Parameters:

path - The path to the new, or existing file

extension - The extension of the file excluding the period

Method Detail

save

public void save()

Saves the current data to the file

set

public void set(java.lang.String key,
                java.lang.Object value)

Assigns a value to a key

Parameters:

key - The key

value - The value assigned to the key

remove

public void remove(java.lang.String key)

Removes the specified line from the file

Parameters:

key - The key to remove

clear

public void clear()

Clears all of the data saved in the file

delete

public void delete()

Deletes the file

keySet

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

Gets a list of all keys saved in the file

Returns:

Returns a List of keys

getString

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

Gets the value assigned to the key

Parameters:

key - The key in which to get the value from

Returns:

Returns a String

getInt

public int getInt(java.lang.String key)

Gets the value assigned to the key

Parameters:

key - The key in which to get the value from

Returns:

Returns an int

getDouble

public double getDouble(java.lang.String key)

Gets the value assigned to the key

Parameters:

key - The key in which to get the value from

Returns:

Returns a double

getFloat

public float getFloat(java.lang.String key)

Gets the value assigned to the key

Parameters:

key - The key in which to get the value from

Returns:

Returns a float

getLong

public long getLong(java.lang.String key)

Gets the value assigned to the key

Parameters:

key - The key in which to get the value from

Returns:

Returns a long

getList

public java.util.List<java.lang.String> getList(java.lang.String key)

Gets a List assigned to the key

Parameters:

key - The key in which to get the value from

Returns:

Returns a value

getBoolean

public boolean getBoolean(java.lang.String key)

Gets the value assigned to the key

Parameters:

key - The key in which to get the value from

Returns:

Returns a boolean

getByte

public byte getByte(java.lang.String key)

Gets the value assigned to the key

Parameters:

key - The key in which to get the value from

Returns:

Returns a byte

getShort

public short getShort(java.lang.String key)

Gets the value assigned to the key

Parameters:

key - The key in which to get the value from

Returns:

Returns a short

isInt

public boolean isInt(java.lang.String key)

Returns whether the value assigned to the key is an integer

Parameters:

key - The key to get the value from

Returns:

Returns a boolean

isDouble

public boolean isDouble(java.lang.String key)

Returns whether the value assigned to the key is a double

Parameters:

key - The key to get the value from

Returns:

Returns a boolean

isFloat

public boolean isFloat(java.lang.String key)

Returns whether the value assigned to the key is a float

Parameters:

key - The key to get the value from

Returns:

Returns a boolean

isLong

public boolean isLong(java.lang.String key)

Returns whether the value assigned to the key is a long

Parameters:

key - The key to get the value from

Returns:

Returns a boolean

isBoolean

public boolean isBoolean(java.lang.String key)

Returns whether the value assigned to the key is a boolean

Parameters:

key - The key to get the value from

Returns:

Returns a boolean

isByte

public boolean isByte(java.lang.String key)

Returns whether the value assigned to the key is a byte

Parameters:

key - The key to get the value from

Returns:

Returns a boolean

isShort

public boolean isShort(java.lang.String key)

Returns whether the value assigned to the key is a short

Parameters:

key - The key to get the value from

Returns:

Returns a boolean