Package com.biglybt.core.config
Class COConfigurationManager
java.lang.Object
com.biglybt.core.config.COConfigurationManager
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
static interface
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
static final int
static final int
static final int
static final int
static final boolean
static final int
private static boolean
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic 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
static void
addWeakParameterListener
(ParameterListener listener, boolean fireImmediately, String... parameter) static boolean
doesParameterDefaultExist
(String parameter) checks if a default is defined for the named parameterstatic boolean
doesParameterNonDefaultExist
(String parameter) checks if the user has explicitly set a value for the named parameterstatic void
dumpConfigChanges
(IndentWriter writer) static boolean
getBooleanParameter
(String _name) static boolean
getBooleanParameter
(String _name, boolean _default) Deprecated.static byte[]
getByteParameter
(String _name) static byte[]
getByteParameter
(String _name, byte[] _default) static Object
getDefault
(String parameter) 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 accessstatic int[]
getRGBParameter
(String parameter) 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
static ConfigurationManager
initialiseFromMap
(Map data) static boolean
static void
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
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 persistedstatic 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)
-
Field Details
-
CONFIG_DEFAULT_MIN_MAX_UPLOAD_SPEED
public static final int CONFIG_DEFAULT_MIN_MAX_UPLOAD_SPEED- See Also:
-
CONFIG_DEFAULT_MAX_DOWNLOAD_SPEED
public static final int CONFIG_DEFAULT_MAX_DOWNLOAD_SPEED- See Also:
-
CONFIG_DEFAULT_MAX_CONNECTIONS_PER_TORRENT
public static final int CONFIG_DEFAULT_MAX_CONNECTIONS_PER_TORRENT- See Also:
-
CONFIG_DEFAULT_MAX_CONNECTIONS_GLOBAL
public static final int CONFIG_DEFAULT_MAX_CONNECTIONS_GLOBAL- See Also:
-
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:
-
MAX_DATA_SOCKS_PROXIES
public static final int MAX_DATA_SOCKS_PROXIES- See Also:
-
pre_initialised
private static boolean pre_initialised
-
-
Constructor Details
-
COConfigurationManager
public COConfigurationManager()
-
-
Method Details
-
preInitialise
public static void preInitialise() -
initialise
-
initialiseFromMap
-
isNewInstall
public static boolean isNewInstall() -
getStringParameter
-
getStringParameter
-
setParameter
-
verifyParameter
-
getBooleanParameter
-
getBooleanParameter
Deprecated.You should set ConfigurationDefaults, and usegetBooleanParameter(String)
-
setParameter
-
getIntParameter
-
getIntParameter
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
-
setParameter
-
getLongParameter
-
getLongParameter
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
-
getByteParameter
-
setParameter
-
getDirectoryParameter
- Throws:
IOException
-
setRGBParameter
-
setRGBDefault
-
setRGBParameter
-
getRGBParameter
-
getFloatParameter
-
getFloatParameter
-
setParameter
-
getStringListParameter
Retrieves a List of String from config. Compared togetListParameter(String, List)
, this method handles decoding the Strings from byte arrays. -
setParameter
-
getListParameter
Retrieves a List from config. Not that Strings will be in byte[] format (you can usegetStringListParameter(String)
if you want String) -
setParameter
-
getMapParameter
-
hasParameter
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
-
addAndFireListener
-
addWeakParameterListener
public static void addWeakParameterListener(ParameterListener listener, boolean fireImmediately, String... parameter) -
removeWeakParameterListener
-
addParameterListener
-
addParameterListener
- Parameters:
strings
-parameterListener
-- Since:
- 3.0.1.5
-
addAndFireParameterListener
-
addAndFireParameterListeners
-
removeParameterListener
-
removeParameterListeners
-
addAndFireWeakParameterListener
-
addAndFireWeakParameterListeners
public static void addAndFireWeakParameterListeners(String[] parameters, ParameterListener listener) -
removeWeakParameterListener
-
removeWeakParameterListeners
-
removeListener
-
getAllowedParameters
-
getDefinedParameters
-
getParameter
raw parameter access- Parameters:
name
-- Returns:
-
doesParameterDefaultExist
checks if a default is defined for the named parameter- Parameters:
parameter
-- Returns:
-
doesParameterNonDefaultExist
checks if the user has explicitly set a value for the named parameter- Parameters:
parameter
-- Returns:
-
registerExternalDefaults
-
setBooleanDefault
-
setFloatDefault
-
setIntDefault
-
setLongDefault
-
setStringDefault
-
setByteDefault
-
getDefault
-
removeParameter
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
-
registerExportedParameter
-
resetToDefaults
public static void resetToDefaults() -
addResetToDefaultsListener
-
dumpConfigChanges
-
getBooleanParameter(String)