Package ece.ing3.java.projet.configuration

Class Configuration

java.lang.Object

ece.ing3.java.projet.configuration.Configuration

public class Configuration
extends Object

Configuration helper.

Offers a convenient way to get and set configuration parameters.

Author:

Virgile, Nicolas, Louis-Félix

Constructor Summary

Constructors

Constructor	Description
Configuration()

Method Summary

Modifier and Type	Method	Description
static Preferences	get()	Returns the underlying Preferences instance.
static String	getString(String key)	Get a configuration String value by key.
static String	getString(String key, String defaultValue)	Get a configuration String value by key.
static Path	getUserDataPath()	Gets the application's data storage path for the current user.
static void	init()	Loads the configuration.
static void	save()	Saves the configuration.
static void	set(String key, String value)	Sets a configuration value.

Methods inherited from class java.lang.Object

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

Constructor Details

Configuration

public Configuration()

Method Details

init

public static void init()

Loads the configuration.

get

public static Preferences get()

Returns the underlying Preferences instance.

Returns:

Preferences instance

save

public static void save()
                 throws BackingStoreException

Saves the configuration.

Throws:

BackingStoreException - Error while saving.

getString

public static String getString(String key)

Get a configuration String value by key.

Parameters:

key - Configuration key

Returns:

Value

getString

public static String getString(String key,
 String defaultValue)

Get a configuration String value by key.

Parameters:

key - Configuration key

defaultValue - Default value

Returns:

Value

set

public static void set(String key,
 String value)

Sets a configuration value.

Parameters:

key - Configuration key

value - Value

getUserDataPath

public static Path getUserDataPath()

Gets the application's data storage path for the current user.

Returns:

Application data storage path or null on error