Package com.biglybt.core.config
Class COConfigurationManager
- java.lang.Object
-
- com.biglybt.core.config.COConfigurationManager
-
public class COConfigurationManager extends java.lang.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 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
static int
MAX_DATA_SOCKS_PROXIES
private static boolean
pre_initialised
-
Constructor Summary
Constructors Constructor Description COConfigurationManager()
-
Method Summary
All Methods Static Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static void
addAndFireListener(COConfigurationListener listener)
static void
addAndFireParameterListener(java.lang.String parameter, ParameterListener listener)
static void
addAndFireParameterListeners(java.lang.String[] parameters, ParameterListener listener)
static void
addListener(COConfigurationListener listener)
static void
addParameterListener(java.lang.String[] ids, ParameterListener listener)
static void
addParameterListener(java.lang.String parameter, ParameterListener listener)
static void
addResetToDefaultsListener(COConfigurationManager.ResetToDefaultsListener l)
static void
addWeakParameterListener(ParameterListener listener, boolean fireImmediately, java.lang.String... parameter)
static boolean
doesParameterDefaultExist(java.lang.String parameter)
checks if a default is defined for the named parameterstatic boolean
doesParameterNonDefaultExist(java.lang.String parameter)
checks if the user has explicitly set a value for the named parameterstatic void
dumpConfigChanges(IndentWriter writer)
static java.util.Set<java.lang.String>
getAllowedParameters()
static boolean
getBooleanParameter(java.lang.String _name)
static boolean
getBooleanParameter(java.lang.String _name, boolean _default)
Deprecated.You should set ConfigurationDefaults, and usegetBooleanParameter(String)
static byte[]
getByteParameter(java.lang.String _name)
static byte[]
getByteParameter(java.lang.String _name, byte[] _default)
static java.lang.Object
getDefault(java.lang.String parameter)
static java.util.Set<java.lang.String>
getDefinedParameters()
static java.lang.String
getDirectoryParameter(java.lang.String _name)
static float
getFloatParameter(java.lang.String _name)
static float
getFloatParameter(java.lang.String _name, float _def)
static int
getIntParameter(java.lang.String _name)
static int
getIntParameter(java.lang.String _name, int _default)
Only use this for internal values, NOT for ones that the user can sensibly change.static java.util.List
getListParameter(java.lang.String parameter, java.util.List def)
Retrieves a List from config.static long
getLongParameter(java.lang.String _name)
static long
getLongParameter(java.lang.String _name, long _def)
Only use this for internal values, NOT for ones that the user can sensibly change.static java.util.Map
getMapParameter(java.lang.String parameter, java.util.Map def)
static java.lang.Object
getParameter(java.lang.String name)
raw parameter accessstatic int[]
getRGBParameter(java.lang.String parameter)
static java.util.List<java.lang.String>
getStringListParameter(java.lang.String parameter)
Retrieves a List of String from config.static java.lang.String
getStringParameter(java.lang.String _name)
static java.lang.String
getStringParameter(java.lang.String _name, java.lang.String _default)
static boolean
hasParameter(java.lang.String parameter, boolean explicit)
Returns true if a parameter with the given name exists.static ConfigurationManager
initialise()
static ConfigurationManager
initialiseFromMap(java.util.Map data)
static boolean
isNewInstall()
static void
preInitialise()
static void
registerExportedParameter(java.lang.String name, java.lang.String key)
static void
registerExternalDefaults(java.util.Map addmap)
static void
removeListener(COConfigurationListener listener)
static boolean
removeParameter(java.lang.String parameter)
Remove the given configuration parameter completely.static void
removeParameterListener(java.lang.String parameter, ParameterListener listener)
static void
removeParameterListeners(java.lang.String[] parameters, ParameterListener listener)
static boolean
removeRGBParameter(java.lang.String parameter)
static void
removeWeakParameterListener(ParameterListener listener, java.lang.String... parameter)
static void
resetToDefaults()
static void
save()
static void
setBooleanDefault(java.lang.String parameter, boolean _default)
static void
setByteDefault(java.lang.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 persistedstatic void
setFloatDefault(java.lang.String parameter, float _default)
static void
setIntDefault(java.lang.String parameter, int _default)
static void
setLongDefault(java.lang.String parameter, long _default)
static boolean
setParameter(java.lang.String parameter, boolean value)
static boolean
setParameter(java.lang.String parameter, byte[] value)
static boolean
setParameter(java.lang.String parameter, float value)
static boolean
setParameter(java.lang.String parameter, int value)
static boolean
setParameter(java.lang.String parameter, long value)
static boolean
setParameter(java.lang.String parameter, java.lang.String value)
static boolean
setParameter(java.lang.String parameter, java.util.List value)
static boolean
setParameter(java.lang.String parameter, java.util.Map value)
static void
setRGBDefault(java.lang.String parameter, int red, int green, int blue)
static boolean
setRGBParameter(java.lang.String parameter, int[] rgb, java.lang.Boolean override)
static boolean
setRGBParameter(java.lang.String parameter, int red, int green, int blue, java.lang.Boolean override)
static void
setStringDefault(java.lang.String parameter, java.lang.String _default)
static boolean
verifyParameter(java.lang.String parameter, java.lang.String value)
-
-
-
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
-
MAX_DATA_SOCKS_PROXIES
public static final int MAX_DATA_SOCKS_PROXIES
- See Also:
- Constant Field Values
-
pre_initialised
private static boolean pre_initialised
-
-
Method Detail
-
preInitialise
public static void preInitialise()
-
initialise
public static ConfigurationManager initialise()
-
initialiseFromMap
public static ConfigurationManager initialiseFromMap(java.util.Map data)
-
isNewInstall
public static boolean isNewInstall()
-
getStringParameter
public static java.lang.String getStringParameter(java.lang.String _name)
-
getStringParameter
public static java.lang.String getStringParameter(java.lang.String _name, java.lang.String _default)
-
setParameter
public static boolean setParameter(java.lang.String parameter, java.lang.String value)
-
verifyParameter
public static boolean verifyParameter(java.lang.String parameter, java.lang.String value)
-
getBooleanParameter
public static boolean getBooleanParameter(java.lang.String _name)
-
getBooleanParameter
public static boolean getBooleanParameter(java.lang.String _name, boolean _default)
Deprecated.You should set ConfigurationDefaults, and usegetBooleanParameter(String)
-
setParameter
public static boolean setParameter(java.lang.String parameter, boolean value)
-
getIntParameter
public static int getIntParameter(java.lang.String _name)
-
getIntParameter
public static int getIntParameter(java.lang.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(java.lang.String parameter, int value)
-
setParameter
public static boolean setParameter(java.lang.String parameter, long value)
-
getLongParameter
public static long getLongParameter(java.lang.String _name)
-
getLongParameter
public static long getLongParameter(java.lang.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(java.lang.String _name)
-
getByteParameter
public static byte[] getByteParameter(java.lang.String _name, byte[] _default)
-
setParameter
public static boolean setParameter(java.lang.String parameter, byte[] value)
-
getDirectoryParameter
public static java.lang.String getDirectoryParameter(java.lang.String _name) throws java.io.IOException
- Throws:
java.io.IOException
-
setRGBParameter
public static boolean setRGBParameter(java.lang.String parameter, int red, int green, int blue, java.lang.Boolean override)
-
setRGBDefault
public static void setRGBDefault(java.lang.String parameter, int red, int green, int blue)
-
setRGBParameter
public static boolean setRGBParameter(java.lang.String parameter, int[] rgb, java.lang.Boolean override)
-
getRGBParameter
public static int[] getRGBParameter(java.lang.String parameter)
-
getFloatParameter
public static float getFloatParameter(java.lang.String _name)
-
getFloatParameter
public static float getFloatParameter(java.lang.String _name, float _def)
-
setParameter
public static boolean setParameter(java.lang.String parameter, float value)
-
getStringListParameter
public static java.util.List<java.lang.String> getStringListParameter(java.lang.String parameter)
Retrieves a List of String from config. Compared togetListParameter(String, List)
, this method handles decoding the Strings from byte arrays.
-
setParameter
public static boolean setParameter(java.lang.String parameter, java.util.List value)
-
getListParameter
public static java.util.List getListParameter(java.lang.String parameter, java.util.List def)
Retrieves a List from config. Not that Strings will be in byte[] format (you can usegetStringListParameter(String)
if you want String)
-
setParameter
public static boolean setParameter(java.lang.String parameter, java.util.Map value)
-
getMapParameter
public static java.util.Map getMapParameter(java.lang.String parameter, java.util.Map def)
-
hasParameter
public static boolean hasParameter(java.lang.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)
-
addWeakParameterListener
public static void addWeakParameterListener(ParameterListener listener, boolean fireImmediately, java.lang.String... parameter)
-
removeWeakParameterListener
public static void removeWeakParameterListener(ParameterListener listener, java.lang.String... parameter)
-
addParameterListener
public static void addParameterListener(java.lang.String parameter, ParameterListener listener)
-
addParameterListener
public static void addParameterListener(java.lang.String[] ids, ParameterListener listener)
- Parameters:
strings
-parameterListener
-- Since:
- 3.0.1.5
-
addAndFireParameterListener
public static void addAndFireParameterListener(java.lang.String parameter, ParameterListener listener)
-
addAndFireParameterListeners
public static void addAndFireParameterListeners(java.lang.String[] parameters, ParameterListener listener)
-
removeParameterListener
public static void removeParameterListener(java.lang.String parameter, ParameterListener listener)
-
removeParameterListeners
public static void removeParameterListeners(java.lang.String[] parameters, ParameterListener listener)
-
removeListener
public static void removeListener(COConfigurationListener listener)
-
getAllowedParameters
public static java.util.Set<java.lang.String> getAllowedParameters()
-
getDefinedParameters
public static java.util.Set<java.lang.String> getDefinedParameters()
-
getParameter
public static java.lang.Object getParameter(java.lang.String name)
raw parameter access- Parameters:
name
-- Returns:
-
doesParameterDefaultExist
public static boolean doesParameterDefaultExist(java.lang.String parameter)
checks if a default is defined for the named parameter- Parameters:
parameter
-- Returns:
-
doesParameterNonDefaultExist
public static boolean doesParameterNonDefaultExist(java.lang.String parameter)
checks if the user has explicitly set a value for the named parameter- Parameters:
parameter
-- Returns:
-
registerExternalDefaults
public static void registerExternalDefaults(java.util.Map addmap)
-
setBooleanDefault
public static void setBooleanDefault(java.lang.String parameter, boolean _default)
-
setFloatDefault
public static void setFloatDefault(java.lang.String parameter, float _default)
-
setIntDefault
public static void setIntDefault(java.lang.String parameter, int _default)
-
setLongDefault
public static void setLongDefault(java.lang.String parameter, long _default)
-
setStringDefault
public static void setStringDefault(java.lang.String parameter, java.lang.String _default)
-
setByteDefault
public static void setByteDefault(java.lang.String parameter, byte[] _default)
-
getDefault
public static java.lang.Object getDefault(java.lang.String parameter)
-
removeParameter
public static boolean removeParameter(java.lang.String parameter)
Remove the given configuration parameter completely.
If parameter had a value,ParameterListener
s will be fired.- Parameters:
parameter
- to remove- Returns:
- true if found and removed, false if not
-
removeRGBParameter
public static boolean removeRGBParameter(java.lang.String parameter)
-
registerExportedParameter
public static void registerExportedParameter(java.lang.String name, java.lang.String key)
-
resetToDefaults
public static void resetToDefaults()
-
addResetToDefaultsListener
public static void addResetToDefaultsListener(COConfigurationManager.ResetToDefaultsListener l)
-
dumpConfigChanges
public static void dumpConfigChanges(IndentWriter writer)
-
-