Class COConfigurationManager

java.lang.Object

com.biglybt.core.config.COConfigurationManager

public class COConfigurationManager
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	COConfigurationManager.ParameterVerifier
static interface	COConfigurationManager.ResetToDefaultsListener

Field Summary

Fields

Modifier and Type	Field	Description
static final int	CONFIG_CACHE_SIZE_MAX_MB
static final int	CONFIG_DEFAULT_MAX_CONNECTIONS_GLOBAL
static final int	CONFIG_DEFAULT_MAX_CONNECTIONS_PER_TORRENT
static final long	CONFIG_DEFAULT_MAX_DOWNLOAD_SPEED
static final long	CONFIG_DEFAULT_MIN_MAX_UPLOAD_SPEED
static final boolean	ENABLE_MULTIPLE_UDP_PORTS
static final int	MAX_DATA_SOCKS_PROXIES
private static boolean	pre_initialised
private static boolean	pre_initialising

Constructor Summary

Constructors

Constructor	Description
COConfigurationManager()

Method Summary

Modifier and Type	Method	Description
static void	addAndFireListener(COConfigurationListener listener)
static void	addAndFireParameterListener(String parameter, ParameterListener listener)
static void	addAndFireParameterListeners(String[] parameters, ParameterListener listener)
static void	addAndFireWeakParameterListener(String parameter, ParameterListener listener)
static void	addAndFireWeakParameterListeners(String[] parameters, ParameterListener listener)
static void	addListener(COConfigurationListener listener)
static void	addParameterListener(String[] ids, ParameterListener listener)
static void	addParameterListener(String parameter, ParameterListener listener)
static void	addResetToDefaultsListener(COConfigurationManager.ResetToDefaultsListener l)
static void	addWeakParameterListener(ParameterListener listener, boolean fireImmediately, String... parameter)
static boolean	doesParameterDefaultExist(String parameter)	checks if a default is defined for the named parameter
static boolean	doesParameterNonDefaultExist(String parameter)	checks if the user has explicitly set a value for the named parameter
static void	dumpConfigChanges(IndentWriter writer)
static Set<String>	getAllowedParameters()
static boolean	getBooleanParameter(String _name)
static boolean	getBooleanParameter(String _name, boolean _default)	Deprecated. You should set ConfigurationDefaults, and use getBooleanParameter(String)
static byte[]	getByteParameter(String _name)
static byte[]	getByteParameter(String _name, byte[] _default)
static Object	getDefault(String parameter)
static Set<String>	getDefinedParameters()
static String	getDirectoryParameter(String _name)
static float	getFloatParameter(String _name)
static float	getFloatParameter(String _name, float _def)
static int	getIntParameter(String _name)
static int	getIntParameter(String _name, int _default)	Only use this for internal values, NOT for ones that the user can sensibly change.
static List	getListParameter(String parameter, List def)	Retrieves a List from config.
static long	getLongParameter(String _name)
static long	getLongParameter(String _name, long _def)	Only use this for internal values, NOT for ones that the user can sensibly change.
static Map	getMapParameter(String parameter, Map def)
static Object	getParameter(String name)	raw parameter access
static int[]	getRGBParameter(String parameter)
static List<String>	getStringListParameter(String parameter)	Retrieves a List of String from config.
static String	getStringParameter(String _name)
static String	getStringParameter(String _name, String _default)
static boolean	hasParameter(String parameter, boolean explicit)	Returns true if a parameter with the given name exists.
static ConfigurationManager	initialise()
static ConfigurationManager	initialiseFromMap(Map data)
static boolean	isNewInstall()
static void	preInitialise()
static void	registerExportedParameter(String name, String key)
static void	registerExternalDefaults(Map addmap)
static void	removeListener(COConfigurationListener listener)
static boolean	removeParameter(String parameter)	Remove the given configuration parameter completely.
static void	removeParameterListener(String parameter, ParameterListener listener)
static void	removeParameterListeners(String[] parameters, ParameterListener listener)
static boolean	removeRGBParameter(String parameter)
static void	removeWeakParameterListener(ParameterListener listener, String... parameter)
static void	removeWeakParameterListener(String parameter, ParameterListener listener)
static void	removeWeakParameterListeners(String[] parameters, ParameterListener listener)
static void	resetToDefaults()
static void	save()
static void	setBooleanDefault(String parameter, boolean _default)
static void	setByteDefault(String parameter, byte[] _default)
static void	setDirty()	Mark as needing a save but not immediately - use when potentially needing a large number of saves that aren't absolutely required to be immediately persisted
static void	setFloatDefault(String parameter, float _default)
static void	setIntDefault(String parameter, int _default)
static void	setLongDefault(String parameter, long _default)
static boolean	setParameter(String parameter, boolean value)
static boolean	setParameter(String parameter, byte[] value)
static boolean	setParameter(String parameter, float value)
static boolean	setParameter(String parameter, int value)
static boolean	setParameter(String parameter, long value)
static boolean	setParameter(String parameter, String value)
static boolean	setParameter(String parameter, List value)
static boolean	setParameter(String parameter, Map value)
static void	setRGBDefault(String parameter, int red, int green, int blue)
static boolean	setRGBParameter(String parameter, int[] rgb, Boolean override)
static boolean	setRGBParameter(String parameter, int red, int green, int blue, Boolean override)
static void	setStringDefault(String parameter, String _default)
static boolean	verifyParameter(String parameter, String value)

Methods inherited from class Object

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

Field Details

CONFIG_DEFAULT_MIN_MAX_UPLOAD_SPEED

public static final long CONFIG_DEFAULT_MIN_MAX_UPLOAD_SPEED

See Also:

• Constant Field Values

CONFIG_DEFAULT_MAX_DOWNLOAD_SPEED

public static final long CONFIG_DEFAULT_MAX_DOWNLOAD_SPEED

See Also:

• Constant Field Values

CONFIG_DEFAULT_MAX_CONNECTIONS_PER_TORRENT

public static final int CONFIG_DEFAULT_MAX_CONNECTIONS_PER_TORRENT

See Also:

• Constant Field Values

CONFIG_DEFAULT_MAX_CONNECTIONS_GLOBAL

public static final int CONFIG_DEFAULT_MAX_CONNECTIONS_GLOBAL

See Also:

• Constant Field Values

CONFIG_CACHE_SIZE_MAX_MB

public static final int CONFIG_CACHE_SIZE_MAX_MB

ENABLE_MULTIPLE_UDP_PORTS

public static final boolean ENABLE_MULTIPLE_UDP_PORTS

See Also:

• Constant Field Values

MAX_DATA_SOCKS_PROXIES

public static final int MAX_DATA_SOCKS_PROXIES

See Also:

• Constant Field Values

pre_initialised

private static boolean pre_initialised

pre_initialising

private static boolean pre_initialising

Constructor Details

COConfigurationManager

public COConfigurationManager()

Method Details

preInitialise

public static void preInitialise()

initialise

public static ConfigurationManager initialise()

initialiseFromMap

public static ConfigurationManager initialiseFromMap(Map data)

isNewInstall

public static boolean isNewInstall()

getStringParameter

public static String getStringParameter(String _name)

getStringParameter

public static String getStringParameter(String _name,
 String _default)

setParameter

public static boolean setParameter(String parameter,
 String value)

verifyParameter

public static boolean verifyParameter(String parameter,
 String value)

getBooleanParameter

public static boolean getBooleanParameter(String _name)

getBooleanParameter

public static boolean getBooleanParameter(String _name,
 boolean _default)

Deprecated.

You should set ConfigurationDefaults, and use getBooleanParameter(String)

setParameter

public static boolean setParameter(String parameter,
 boolean value)

getIntParameter

public static int getIntParameter(String _name)

getIntParameter

public static int getIntParameter(String _name,
 int _default)

Only use this for internal values, NOT for ones that the user can sensibly change. In this case add the key to the configuration defaults and use the above method

Parameters:

_name -

_def -

Returns:

setParameter

public static boolean setParameter(String parameter,
 int value)

setParameter

public static boolean setParameter(String parameter,
 long value)

getLongParameter

public static long getLongParameter(String _name)

getLongParameter

public static long getLongParameter(String _name,
 long _def)

Only use this for internal values, NOT for ones that the user can sensibly change. In this case add the key to the configuration defaults and use the above method

Parameters:

_name -

_def -

Returns:

getByteParameter

public static byte[] getByteParameter(String _name)

getByteParameter

public static byte[] getByteParameter(String _name,
 byte[] _default)

setParameter

public static boolean setParameter(String parameter,
 byte[] value)

getDirectoryParameter

public static String getDirectoryParameter(String _name)
                                    throws IOException

Throws:

IOException

setRGBParameter

public static boolean setRGBParameter(String parameter,
 int red,
 int green,
 int blue,
 Boolean override)

setRGBDefault

public static void setRGBDefault(String parameter,
 int red,
 int green,
 int blue)

setRGBParameter

public static boolean setRGBParameter(String parameter,
 int[] rgb,
 Boolean override)

getRGBParameter

public static int[] getRGBParameter(String parameter)

getFloatParameter

public static float getFloatParameter(String _name)

getFloatParameter

public static float getFloatParameter(String _name,
 float _def)

setParameter

public static boolean setParameter(String parameter,
 float value)

getStringListParameter

public static List<String> getStringListParameter(String parameter)

Retrieves a List of String from config.

Compared to getListParameter(String, List), this method handles decoding the Strings from byte arrays.

setParameter

public static boolean setParameter(String parameter,
 List value)

getListParameter

public static List getListParameter(String parameter,
 List def)

Retrieves a List from config. Not that Strings will be in byte[] format (you can use getStringListParameter(String) if you want String)

setParameter

public static boolean setParameter(String parameter,
 Map value)

getMapParameter

public static Map getMapParameter(String parameter,
 Map def)

hasParameter

public static boolean hasParameter(String parameter,
 boolean explicit)

Returns true if a parameter with the given name exists.

Parameters:

explicit - If true, we only check for a value which is definitely stored explicitly, false means that we'll also check against configuration defaults too.

key - The name of the parameter to check.

save

public static void save()

setDirty

public static void setDirty()

Mark as needing a save but not immediately - use when potentially needing a large number of saves that aren't absolutely required to be immediately persisted

addListener

public static void addListener(COConfigurationListener listener)

addAndFireListener

public static void addAndFireListener(COConfigurationListener listener)

addWeakParameterListener

public static void addWeakParameterListener(ParameterListener listener,
 boolean fireImmediately,
 String... parameter)

removeWeakParameterListener

public static void removeWeakParameterListener(ParameterListener listener,
 String... parameter)

addParameterListener

public static void addParameterListener(String parameter,
 ParameterListener listener)

addParameterListener

public static void addParameterListener(String[] ids,
 ParameterListener listener)

Parameters:

strings -

parameterListener -

Since:

3.0.1.5

addAndFireParameterListener

public static void addAndFireParameterListener(String parameter,
 ParameterListener listener)

addAndFireParameterListeners

public static void addAndFireParameterListeners(String[] parameters,
 ParameterListener listener)

removeParameterListener

public static void removeParameterListener(String parameter,
 ParameterListener listener)

removeParameterListeners

public static void removeParameterListeners(String[] parameters,
 ParameterListener listener)

addAndFireWeakParameterListener

public static void addAndFireWeakParameterListener(String parameter,
 ParameterListener listener)

addAndFireWeakParameterListeners

public static void addAndFireWeakParameterListeners(String[] parameters,
 ParameterListener listener)

removeWeakParameterListener

public static void removeWeakParameterListener(String parameter,
 ParameterListener listener)

removeWeakParameterListeners

public static void removeWeakParameterListeners(String[] parameters,
 ParameterListener listener)

removeListener

public static void removeListener(COConfigurationListener listener)

getAllowedParameters

public static Set<String> getAllowedParameters()

getDefinedParameters

public static Set<String> getDefinedParameters()

getParameter

public static Object getParameter(String name)

raw parameter access

Parameters:

name -

Returns:

doesParameterDefaultExist

public static boolean doesParameterDefaultExist(String parameter)

checks if a default is defined for the named parameter

Parameters:

parameter -

Returns:

doesParameterNonDefaultExist

public static boolean doesParameterNonDefaultExist(String parameter)

checks if the user has explicitly set a value for the named parameter

Parameters:

parameter -

Returns:

registerExternalDefaults

public static void registerExternalDefaults(Map addmap)

setBooleanDefault

public static void setBooleanDefault(String parameter,
 boolean _default)

setFloatDefault

public static void setFloatDefault(String parameter,
 float _default)

setIntDefault

public static void setIntDefault(String parameter,
 int _default)

setLongDefault

public static void setLongDefault(String parameter,
 long _default)

setStringDefault

public static void setStringDefault(String parameter,
 String _default)

setByteDefault

public static void setByteDefault(String parameter,
 byte[] _default)

getDefault

public static Object getDefault(String parameter)

removeParameter

public static boolean removeParameter(String parameter)

Remove the given configuration parameter completely.
If parameter had a value, ParameterListeners will be fired.

Parameters:

parameter - to remove

Returns:

true if found and removed, false if not

removeRGBParameter

public static boolean removeRGBParameter(String parameter)

registerExportedParameter

public static void registerExportedParameter(String name,
 String key)

resetToDefaults

public static void resetToDefaults()

addResetToDefaultsListener

public static void addResetToDefaultsListener(COConfigurationManager.ResetToDefaultsListener l)

dumpConfigChanges

public static void dumpConfigChanges(IndentWriter writer)