org.gudy.azureus2.core3.config
Class COConfigurationManager

java.lang.Object
  org.gudy.azureus2.core3.config.COConfigurationManager

public class COConfigurationManager
extends Object

Nested Class Summary

static interface	COConfigurationManager.ParameterVerifier
static interface	COConfigurationManager.ResetToDefaultsListener

Field Summary

static int	CONFIG_CACHE_SIZE_MAX_MB
static int	CONFIG_DEFAULT_MAX_CONNECTIONS_GLOBAL
static int	CONFIG_DEFAULT_MAX_CONNECTIONS_PER_TORRENT
static int	CONFIG_DEFAULT_MAX_DOWNLOAD_SPEED
static int	CONFIG_DEFAULT_MIN_MAX_UPLOAD_SPEED
static boolean	ENABLE_MULTIPLE_UDP_PORTS

Constructor Summary

COConfigurationManager()

Method Summary

static void	addAndFireListener(COConfigurationListener listener)
static void	addAndFireParameterListener(String parameter, ParameterListener listener)
static void	addAndFireParameterListeners(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 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)
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 StringList	getStringListParameter(String parameter)
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)
static void	removeParameterListener(String parameter, ParameterListener listener)
static boolean	removeRGBParameter(String parameter)
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, List value)
static boolean	setParameter(String parameter, long value)
static boolean	setParameter(String parameter, Map value)
static boolean	setParameter(String parameter, String value)
static boolean	setParameter(String parameter, StringList value)
static boolean	setRGBParameter(String parameter, int[] rgb, boolean override)
static boolean	setRGBParameter(String parameter, int red, int green, int blue)
static void	setStringDefault(String parameter, String _default)
static boolean	verifyParameter(String parameter, String value)

Methods inherited from class java.lang.Object

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

Field Detail

CONFIG_DEFAULT_MIN_MAX_UPLOAD_SPEED

public static final int CONFIG_DEFAULT_MIN_MAX_UPLOAD_SPEED

See Also:

Constant Field Values

CONFIG_DEFAULT_MAX_DOWNLOAD_SPEED

public static final int 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

Constructor Detail

COConfigurationManager

public COConfigurationManager()

Method Detail

preInitialise

public static void preInitialise()

initialise

public static ConfigurationManager initialise()

initialiseFromMap

public static ConfigurationManager initialiseFromMap(Map data)

isNewInstall

public static final 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)

setRGBParameter

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

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)

setParameter

public static boolean setParameter(String parameter,
                                   StringList value)

getStringListParameter

public static StringList getStringListParameter(String parameter)

setParameter

public static boolean setParameter(String parameter,
                                   List value)

getListParameter

public static List getListParameter(String parameter,
                                    List def)

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:

key - The name of the parameter to check.

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.

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)

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)

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)

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)