Interface PluginConfig
-
- All Known Implementing Classes:
PluginConfigImpl
,RPPluginConfig
public interface PluginConfig
This class provides a way for a plugin to get and set configuration settings - both for the plugin itself and for core settings as well.This class interface contains four different variations of get and set parameter methods:
- getCore
<type>
Parameter - getUnsafe
<type>
Parameter - getPlugin
<type>
Parameter
Attempting to set or get parameters not mentioned here should raise an error. The "Unsafe" set of methods allow you to modify configuration settings which are stored directly inside the client. These settings may change (without warning) between versions, so there is no guarantee that plugins that use these values will behave properly in different versions of the client. The "Plugin" set of methods are used to store and retrieve data intended exclusively for the use of the plugin itself which is what you will be using most of the time.
-
-
Field Summary
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addListener(PluginConfigListener l)
PluginConfigSource
enableExternalConfigSource()
Enable the plugin to store configuration parameters into a separate external configuration file.boolean
getCoreBooleanParameter(java.lang.String key)
Returns the value of a core boolean parameter.byte[]
getCoreByteParameter(java.lang.String key)
Returns the value of a core byte array parameter.int[]
getCoreColorParameter(java.lang.String key)
Returns the value of a core color parameter.float
getCoreFloatParameter(java.lang.String key)
Returns the value of a core float parameter.int
getCoreIntParameter(java.lang.String key)
Returns the value of a core int parameter.long
getCoreLongParameter(java.lang.String key)
Returns the value of a core long parameter.java.lang.String
getCoreStringParameter(java.lang.String key)
Returns the value of a core string parameter.ConfigParameter
getParameter(java.lang.String key)
boolean
getPluginBooleanParameter(java.lang.String key)
Returns the value of a plugin boolean parameter.boolean
getPluginBooleanParameter(java.lang.String key, boolean default_value)
Returns the value of a plugin boolean parameter.byte[]
getPluginByteParameter(java.lang.String key)
Returns the value of a plugin byte array parameter.byte[]
getPluginByteParameter(java.lang.String key, byte[] default_value)
Returns the value of a plugin byte array parameter.int[]
getPluginColorParameter(java.lang.String key)
Returns the value of a plugin color parameter.int[]
getPluginColorParameter(java.lang.String key, int[] default_value)
Returns the value of a plugin color parameter.java.lang.String
getPluginConfigKeyPrefix()
PluginConfigSource
getPluginConfigSource()
Returns the PluginConfigSource object used for this plugin configuration (or null if an external configuration object isn't used).float
getPluginFloatParameter(java.lang.String key)
Returns the value of a plugin float parameter.float
getPluginFloatParameter(java.lang.String key, float default_value)
Returns the value of a plugin float parameter.int
getPluginIntParameter(java.lang.String key)
Returns the value of a plugin int parameter.int
getPluginIntParameter(java.lang.String key, int default_value)
Returns the value of a plugin int parameter.java.util.List
getPluginListParameter(java.lang.String key, java.util.List default_value)
Returns the value of a plugin list parameter.long
getPluginLongParameter(java.lang.String key)
Returns the value of a plugin long parameter.long
getPluginLongParameter(java.lang.String key, long default_value)
Returns the value of a plugin long parameter.java.util.Map
getPluginMapParameter(java.lang.String key, java.util.Map default_value)
Returns the value of a plugin map parameter.ConfigParameter
getPluginParameter(java.lang.String key)
java.lang.String[]
getPluginStringListParameter(java.lang.String key)
Returns the value of a plugin string-list parameter.java.lang.String
getPluginStringParameter(java.lang.String key)
Returns the value of a plugin string parameter.java.lang.String
getPluginStringParameter(java.lang.String key, java.lang.String default_value)
Returns the value of a plugin string parameter.java.io.File
getPluginUserFile(java.lang.String name)
Returns a file that can be used by the plugin to save user-specific state.boolean
getUnsafeBooleanParameter(java.lang.String key)
Returns the value of a core boolean parameter.boolean
getUnsafeBooleanParameter(java.lang.String key, boolean default_value)
Returns the value of a core boolean parameter.byte[]
getUnsafeByteParameter(java.lang.String key)
Returns the value of a core byte array parameter.byte[]
getUnsafeByteParameter(java.lang.String key, byte[] default_value)
Returns the value of a core byte array parameter.int[]
getUnsafeColorParameter(java.lang.String key)
Returns the value of a core color parameter.int[]
getUnsafeColorParameter(java.lang.String key, int[] default_value)
Returns the value of a core color parameter.float
getUnsafeFloatParameter(java.lang.String key)
Returns the value of a core float parameter.float
getUnsafeFloatParameter(java.lang.String key, float default_value)
Returns the value of a core float parameter.int
getUnsafeIntParameter(java.lang.String key)
Returns the value of a core int parameter.int
getUnsafeIntParameter(java.lang.String key, int default_value)
Returns the value of a core int parameter.long
getUnsafeLongParameter(java.lang.String key)
Returns the value of a core long parameter.long
getUnsafeLongParameter(java.lang.String key, long default_value)
Returns the value of a core long parameter.java.util.Map
getUnsafeParameterList()
Returns a mapgiving parameter names -> parameter values. java.lang.String
getUnsafeStringParameter(java.lang.String key)
Returns the value of a core string parameter.java.lang.String
getUnsafeStringParameter(java.lang.String key, java.lang.String default_value)
Returns the value of a core string parameter.boolean
hasParameter(java.lang.String param_name)
Returns true if a core parameter with the given name exists.boolean
hasPluginParameter(java.lang.String param_name)
Returns true if a plugin parameter with the given name exists.boolean
isNewInstall()
void
removeListener(PluginConfigListener l)
boolean
removePluginColorParameter(java.lang.String key)
Removes the plugin color parameter with the given name.boolean
removePluginParameter(java.lang.String key)
Removes the plugin parameter with the given name.void
save()
make sure you save it after making changes!void
setCoreBooleanParameter(java.lang.String key, boolean value)
Sets the value of a core boolean parameter.void
setCoreByteParameter(java.lang.String key, byte[] value)
Sets the value of a core byte array parameter.void
setCoreColorParameter(java.lang.String key, int[] value)
Sets the value of a core byte array parameter.void
setCoreColorParameter(java.lang.String key, int[] value, boolean override)
Sets the value of a core byte array parameter.void
setCoreFloatParameter(java.lang.String key, float value)
Sets the value of a core float parameter.void
setCoreIntParameter(java.lang.String key, int value)
Sets the value of a core int parameter.void
setCoreLongParameter(java.lang.String key, long value)
Sets the value of a core long parameter.void
setCoreStringParameter(java.lang.String key, java.lang.String value)
Sets the value of a core string parameter.void
setPluginColorParameter(java.lang.String key, int[] value)
Sets the value of a plugin color parameter.void
setPluginColorParameter(java.lang.String key, int[] value, boolean override)
Sets the value of a plugin color parameter.void
setPluginConfigKeyPrefix(java.lang.String _key)
void
setPluginConfigSource(PluginConfigSource source)
Sets the plugin configuration source object to use for storing parameters for this plugin config object.void
setPluginListParameter(java.lang.String key, java.util.List value)
Sets the value of a plugin list parameter.void
setPluginMapParameter(java.lang.String key, java.util.Map value)
Sets the value of a plugin map parameter.void
setPluginParameter(java.lang.String key, boolean value)
Sets the value of a plugin boolean parameter.void
setPluginParameter(java.lang.String key, byte[] value)
Sets the value of a plugin byte array parameter.void
setPluginParameter(java.lang.String key, float value)
Sets the value of a plugin float parameter.void
setPluginParameter(java.lang.String key, int value)
Sets the value of a plugin int parameter.void
setPluginParameter(java.lang.String key, int value, boolean global)
Sets the value of a plugin int parameter.void
setPluginParameter(java.lang.String key, long value)
Sets the value of a plugin long parameter.void
setPluginParameter(java.lang.String key, java.lang.String value)
Sets the value of a plugin string parameter.void
setPluginStringListParameter(java.lang.String key, java.lang.String[] value)
Sets the value of a plugin string-list parameter.void
setUnsafeBooleanParameter(java.lang.String key, boolean value)
Sets the value of a core boolean parameter.void
setUnsafeByteParameter(java.lang.String key, byte[] value)
Sets the value of a core byte array parameter.void
setUnsafeColorParameter(java.lang.String key, int[] value)
Returns the value of a core color parameter.void
setUnsafeColorParameter(java.lang.String key, int[] value, boolean override)
Returns the value of a core color parameter.void
setUnsafeFloatParameter(java.lang.String key, float value)
Sets the value of a core float parameter.void
setUnsafeIntParameter(java.lang.String key, int value)
Sets the value of a core int parameter.void
setUnsafeLongParameter(java.lang.String key, long value)
Sets the value of a core long parameter.void
setUnsafeStringParameter(java.lang.String key, java.lang.String value)
Sets the value of a core string parameter.
-
-
-
Field Detail
-
CORE_PARAM_INT_MAX_UPLOAD_SPEED_KBYTES_PER_SEC
static final java.lang.String CORE_PARAM_INT_MAX_UPLOAD_SPEED_KBYTES_PER_SEC
- See Also:
- Constant Field Values
-
CORE_PARAM_INT_MAX_UPLOAD_SPEED_SEEDING_KBYTES_PER_SEC
static final java.lang.String CORE_PARAM_INT_MAX_UPLOAD_SPEED_SEEDING_KBYTES_PER_SEC
- See Also:
- Constant Field Values
-
CORE_PARAM_INT_MAX_DOWNLOAD_SPEED_KBYTES_PER_SEC
static final java.lang.String CORE_PARAM_INT_MAX_DOWNLOAD_SPEED_KBYTES_PER_SEC
- See Also:
- Constant Field Values
-
CORE_PARAM_INT_MAX_CONNECTIONS_PER_TORRENT
static final java.lang.String CORE_PARAM_INT_MAX_CONNECTIONS_PER_TORRENT
- See Also:
- Constant Field Values
-
CORE_PARAM_INT_MAX_CONNECTIONS_GLOBAL
static final java.lang.String CORE_PARAM_INT_MAX_CONNECTIONS_GLOBAL
- See Also:
- Constant Field Values
-
CORE_PARAM_INT_MAX_DOWNLOADS
static final java.lang.String CORE_PARAM_INT_MAX_DOWNLOADS
- See Also:
- Constant Field Values
-
CORE_PARAM_INT_MAX_ACTIVE
static final java.lang.String CORE_PARAM_INT_MAX_ACTIVE
- See Also:
- Constant Field Values
-
CORE_PARAM_INT_MAX_ACTIVE_SEEDING
static final java.lang.String CORE_PARAM_INT_MAX_ACTIVE_SEEDING
- See Also:
- Constant Field Values
-
CORE_PARAM_INT_MAX_UPLOADS
static final java.lang.String CORE_PARAM_INT_MAX_UPLOADS
- See Also:
- Constant Field Values
-
CORE_PARAM_INT_MAX_UPLOADS_SEEDING
static final java.lang.String CORE_PARAM_INT_MAX_UPLOADS_SEEDING
- See Also:
- Constant Field Values
-
CORE_PARAM_BOOLEAN_AUTO_SPEED_ON
static final java.lang.String CORE_PARAM_BOOLEAN_AUTO_SPEED_ON
- See Also:
- Constant Field Values
-
CORE_PARAM_BOOLEAN_AUTO_SPEED_SEEDING_ON
static final java.lang.String CORE_PARAM_BOOLEAN_AUTO_SPEED_SEEDING_ON
- See Also:
- Constant Field Values
-
CORE_PARAM_BOOLEAN_MAX_UPLOAD_SPEED_SEEDING
static final java.lang.String CORE_PARAM_BOOLEAN_MAX_UPLOAD_SPEED_SEEDING
- See Also:
- Constant Field Values
-
CORE_PARAM_BOOLEAN_MAX_ACTIVE_SEEDING
static final java.lang.String CORE_PARAM_BOOLEAN_MAX_ACTIVE_SEEDING
- See Also:
- Constant Field Values
-
CORE_PARAM_BOOLEAN_SOCKS_PROXY_NO_INWARD_CONNECTION
static final java.lang.String CORE_PARAM_BOOLEAN_SOCKS_PROXY_NO_INWARD_CONNECTION
- See Also:
- Constant Field Values
-
CORE_PARAM_BOOLEAN_NEW_SEEDS_START_AT_TOP
static final java.lang.String CORE_PARAM_BOOLEAN_NEW_SEEDS_START_AT_TOP
- See Also:
- Constant Field Values
-
CORE_PARAM_STRING_LOCAL_BIND_IP
static final java.lang.String CORE_PARAM_STRING_LOCAL_BIND_IP
Semicolon seperated list containing: IP
NetworkInterface
name (ex. eth10)
NetworkInterface name with IP index in square brackets (ex. eth6[0])- Since:
- 2.3.0.5
- See Also:
- Constant Field Values
-
CORE_PARAM_BOOLEAN_FRIENDLY_HASH_CHECKING
static final java.lang.String CORE_PARAM_BOOLEAN_FRIENDLY_HASH_CHECKING
Deprecated.2.0.0.1 (removed from core)- See Also:
- Constant Field Values
-
GUI_PARAM_INT_SWT_REFRESH_IN_MS
static final java.lang.String GUI_PARAM_INT_SWT_REFRESH_IN_MS
- Since:
- 3.0.4.3
- See Also:
- Constant Field Values
-
CORE_PARAM_BOOLEAN_NEW_TORRENTS_START_AS_STOPPED
static final java.lang.String CORE_PARAM_BOOLEAN_NEW_TORRENTS_START_AS_STOPPED
- Since:
- 3.0.4.3
- See Also:
- Constant Field Values
-
CORE_PARAM_INT_INCOMING_TCP_PORT
static final java.lang.String CORE_PARAM_INT_INCOMING_TCP_PORT
- Since:
- 3.0.5.3
- See Also:
- Constant Field Values
-
CORE_PARAM_INT_INCOMING_UDP_PORT
static final java.lang.String CORE_PARAM_INT_INCOMING_UDP_PORT
- Since:
- 3.0.5.3
- See Also:
- Constant Field Values
-
CORE_PARAM_STRING_DEFAULT_SAVE_PATH
static final java.lang.String CORE_PARAM_STRING_DEFAULT_SAVE_PATH
- Since:
- 3.1.1.1
- See Also:
- Constant Field Values
-
-
Method Detail
-
getCoreBooleanParameter
boolean getCoreBooleanParameter(java.lang.String key)
Returns the value of a core boolean parameter.- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
- Since:
- 3.0.4.3
-
getCoreByteParameter
byte[] getCoreByteParameter(java.lang.String key)
Returns the value of a core byte array parameter.- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
- Since:
- 3.0.4.3
-
getCoreColorParameter
int[] getCoreColorParameter(java.lang.String key)
Returns the value of a core color parameter.It will return null if no color parameter is stored, or an integer array of size 4 representing the red, green and blue values, and a flag indicating if the color is an override of the default or not (0 indicates no override, 1 means it is overridden).
In many cases, the override flag can just be ignored.
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
- Since:
- 3.0.5.3
-
getCoreFloatParameter
float getCoreFloatParameter(java.lang.String key)
Returns the value of a core float parameter.- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
- Since:
- 3.0.4.3
-
getCoreIntParameter
int getCoreIntParameter(java.lang.String key)
Returns the value of a core int parameter.- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
- Since:
- 3.0.4.3
-
getCoreLongParameter
long getCoreLongParameter(java.lang.String key)
Returns the value of a core long parameter.- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
- Since:
- 3.0.4.3
-
getCoreStringParameter
java.lang.String getCoreStringParameter(java.lang.String key)
Returns the value of a core string parameter.- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
- Since:
- 3.0.4.3
-
setCoreBooleanParameter
void setCoreBooleanParameter(java.lang.String key, boolean value)
Sets the value of a core boolean parameter.- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.- Since:
- 3.0.4.2
-
setCoreByteParameter
void setCoreByteParameter(java.lang.String key, byte[] value)
Sets the value of a core byte array parameter.- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.- Since:
- 3.0.4.2
-
setCoreColorParameter
void setCoreColorParameter(java.lang.String key, int[] value)
Sets the value of a core byte array parameter.The value should be an integer array of size 3 representing the red, green and blue values - or null to disable it.
- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.- Since:
- 3.0.5.3
-
setCoreColorParameter
void setCoreColorParameter(java.lang.String key, int[] value, boolean override)
Sets the value of a core byte array parameter.The value should be an integer array of size 3 representing the red, green and blue values - or null to disable it.
The override flag is used to indicate if the value being set is overriding the default value. This is mainly used for interface purposes.
- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.override
- true if the value is overridden from the default.- Since:
- 3.0.5.3
-
setCoreFloatParameter
void setCoreFloatParameter(java.lang.String key, float value)
Sets the value of a core float parameter.- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.- Since:
- 3.0.4.2
-
setCoreIntParameter
void setCoreIntParameter(java.lang.String key, int value)
Sets the value of a core int parameter.- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.- Since:
- 3.0.4.2
-
setCoreLongParameter
void setCoreLongParameter(java.lang.String key, long value)
Sets the value of a core long parameter.- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.- Since:
- 3.0.4.2
-
setCoreStringParameter
void setCoreStringParameter(java.lang.String key, java.lang.String value)
Sets the value of a core string parameter.- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.- Since:
- 3.0.4.2
-
getPluginBooleanParameter
boolean getPluginBooleanParameter(java.lang.String key)
Returns the value of a plugin boolean parameter.- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
- Since:
- 2.0.4.2
-
getPluginBooleanParameter
boolean getPluginBooleanParameter(java.lang.String key, boolean default_value)
Returns the value of a plugin boolean parameter.- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
- Since:
- 2.0.4.2
-
getPluginByteParameter
byte[] getPluginByteParameter(java.lang.String key)
Returns the value of a plugin byte array parameter.- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
- Since:
- 3.0.0.7
-
getPluginByteParameter
byte[] getPluginByteParameter(java.lang.String key, byte[] default_value)
Returns the value of a plugin byte array parameter.- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
- Since:
- 2.2.0.3
-
getPluginColorParameter
int[] getPluginColorParameter(java.lang.String key)
Returns the value of a plugin color parameter.It will return null if no color parameter is stored, or an integer array of size 4 representing the red, green and blue values, and a flag indicating if the color is an override of the default or not (0 indicates no override, 1 means it is overridden).
In many cases, the override flag can just be ignored.
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
- Since:
- 3.0.5.3
-
getPluginColorParameter
int[] getPluginColorParameter(java.lang.String key, int[] default_value)
Returns the value of a plugin color parameter.It will return null if no color parameter is stored, or an integer array of size 4 representing the red, green and blue values, and a flag indicating if the color is an override of the default or not (0 indicates no override, 1 means it is overridden).
In many cases, the override flag can just be ignored.
- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
- Since:
- 3.0.5.3
-
getPluginFloatParameter
float getPluginFloatParameter(java.lang.String key)
Returns the value of a plugin float parameter.- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
- Since:
- 3.0.0.7
-
getPluginFloatParameter
float getPluginFloatParameter(java.lang.String key, float default_value)
Returns the value of a plugin float parameter.- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
- Since:
- 3.0.0.7
-
getPluginIntParameter
int getPluginIntParameter(java.lang.String key)
Returns the value of a plugin int parameter.- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
- Since:
- 2.0.4.2
-
getPluginIntParameter
int getPluginIntParameter(java.lang.String key, int default_value)
Returns the value of a plugin int parameter.- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
- Since:
- 2.0.4.2
-
getPluginListParameter
java.util.List getPluginListParameter(java.lang.String key, java.util.List default_value)
Returns the value of a plugin list parameter. The contents of the list must conform to bencodable rules (e.g. Map, Long, byte[], List)- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
- Since:
- 2.3.0.1
-
getPluginLongParameter
long getPluginLongParameter(java.lang.String key)
Returns the value of a plugin long parameter.- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
- Since:
- 3.0.0.7
-
getPluginLongParameter
long getPluginLongParameter(java.lang.String key, long default_value)
Returns the value of a plugin long parameter.- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
- Since:
- 3.0.0.7
-
getPluginMapParameter
java.util.Map getPluginMapParameter(java.lang.String key, java.util.Map default_value)
Returns the value of a plugin map parameter. The contents of the map must conform to bencodable rules (e.g. Map, Long, byte[], List)- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
- Since:
- 2.3.0.1
-
getPluginStringParameter
java.lang.String getPluginStringParameter(java.lang.String key)
Returns the value of a plugin string parameter.- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
- Since:
- 2.0.4.2
-
getPluginStringParameter
java.lang.String getPluginStringParameter(java.lang.String key, java.lang.String default_value)
Returns the value of a plugin string parameter.- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
- Since:
- 2.0.4.2
-
getPluginStringListParameter
java.lang.String[] getPluginStringListParameter(java.lang.String key)
Returns the value of a plugin string-list parameter. If no value is set, an empty string array will be returned.- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
- Since:
- 3.0.5.3
-
setPluginParameter
void setPluginParameter(java.lang.String key, boolean value)
Sets the value of a plugin boolean parameter.- Parameters:
key
- The parameter name.value
- The new value for the parameter.- Since:
- 2.0.4.2
-
setPluginParameter
void setPluginParameter(java.lang.String key, byte[] value)
Sets the value of a plugin byte array parameter.- Parameters:
key
- The parameter name.value
- The new value for the parameter.- Since:
- 2.1.0.2
-
setPluginParameter
void setPluginParameter(java.lang.String key, float value)
Sets the value of a plugin float parameter.- Parameters:
key
- The parameter name.value
- The new value for the parameter.- Since:
- 3.0.0.7
-
setPluginParameter
void setPluginParameter(java.lang.String key, int value)
Sets the value of a plugin int parameter.- Parameters:
key
- The parameter name.value
- The new value for the parameter.- Since:
- 2.0.4.2
-
setPluginParameter
void setPluginParameter(java.lang.String key, int value, boolean global)
Sets the value of a plugin int parameter.- Parameters:
key
- The parameter name.value
- The new value for the parameter.global
- Whether or not this parameter should be made externally accessible.- Since:
- 2.5.0.1
-
setPluginParameter
void setPluginParameter(java.lang.String key, long value)
Sets the value of a plugin long parameter.- Parameters:
key
- The parameter name.value
- The new value for the parameter.- Since:
- 3.0.0.7
-
setPluginParameter
void setPluginParameter(java.lang.String key, java.lang.String value)
Sets the value of a plugin string parameter.- Parameters:
key
- The parameter name.value
- The new value for the parameter.- Since:
- 2.0.4.2
-
setPluginStringListParameter
void setPluginStringListParameter(java.lang.String key, java.lang.String[] value)
Sets the value of a plugin string-list parameter.- Parameters:
key
- The parameter name.value
- The new value of the parameter.- Since:
- 3.0.5.3
-
setPluginColorParameter
void setPluginColorParameter(java.lang.String key, int[] value)
Sets the value of a plugin color parameter.The value should be an integer array of size 3 representing the red, green and blue values - or null to disable it.
- Parameters:
key
- The parameter name.value
- The new value for the parameter.- Since:
- 3.0.5.3
-
setPluginColorParameter
void setPluginColorParameter(java.lang.String key, int[] value, boolean override)
Sets the value of a plugin color parameter.The value should be an integer array of size 3 representing the red, green and blue values - or null to disable it.
The override flag is used to indicate if the value being set is overriding the default value. This is mainly used for interface purposes.
- Parameters:
key
- The parameter name.value
- The new value for the parameter.override
- true if the value is overridden from the default.- Since:
- 3.0.5.3
-
setPluginListParameter
void setPluginListParameter(java.lang.String key, java.util.List value)
Sets the value of a plugin list parameter. The contents of the list must conform to bencodable rules (e.g. Map, Long, byte[], List)- Parameters:
key
- The parameter name.value
- The new value for the parameter.- Since:
- 2.3.0.1
-
setPluginMapParameter
void setPluginMapParameter(java.lang.String key, java.util.Map value)
Sets the value of a plugin map parameter. The contents of the map must conform to bencodable rules (e.g. Map, Long, byte[], List)- Parameters:
key
- The parameter name.value
- The new value for the parameter.- Since:
- 2.3.0.1
-
getUnsafeBooleanParameter
boolean getUnsafeBooleanParameter(java.lang.String key)
Returns the value of a core boolean parameter. Note: the semantics of this method will not be guaranteed - core parameter names may change in the future, and this method will not do any parameter name mapping for you, so take care when using this method.- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
- Since:
- 3.0.0.7
-
getUnsafeBooleanParameter
boolean getUnsafeBooleanParameter(java.lang.String key, boolean default_value)
Returns the value of a core boolean parameter. Note: the semantics of this method will not be guaranteed - core parameter names may change in the future, and this method will not do any parameter name mapping for you, so take care when using this method.- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
- Since:
- 3.0.0.5
-
getUnsafeByteParameter
byte[] getUnsafeByteParameter(java.lang.String key)
Returns the value of a core byte array parameter. Note: the semantics of this method will not be guaranteed - core parameter names may change in the future, and this method will not do any parameter name mapping for you, so take care when using this method.- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
- Since:
- 3.0.0.7
-
getUnsafeByteParameter
byte[] getUnsafeByteParameter(java.lang.String key, byte[] default_value)
Returns the value of a core byte array parameter. Note: the semantics of this method will not be guaranteed - core parameter names may change in the future, and this method will not do any parameter name mapping for you, so take care when using this method.- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
- Since:
- 3.0.0.7
-
getUnsafeColorParameter
int[] getUnsafeColorParameter(java.lang.String key)
Returns the value of a core color parameter. Note: the semantics of this method will not be guaranteed - core parameter names may change in the future, and this method will not do any parameter name mapping for you, so take care when using this method.It will return null if no color parameter is stored, or an integer array of size 4 representing the red, green and blue values, and a flag indicating if the color is an override of the default or not (0 indicates no override, 1 means it is overridden).
In many cases, the override flag can just be ignored.
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
- Since:
- 3.0.5.3
-
getUnsafeColorParameter
int[] getUnsafeColorParameter(java.lang.String key, int[] default_value)
Returns the value of a core color parameter. Note: the semantics of this method will not be guaranteed - core parameter names may change in the future, and this method will not do any parameter name mapping for you, so take care when using this method.It will return null if no color parameter is stored, or an integer array of size 4 representing the red, green and blue values, and a flag indicating if the color is an override of the default or not (0 indicates no override, 1 means it is overridden).
In many cases, the override flag can just be ignored.
- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
- Since:
- 3.0.5.3
-
getUnsafeFloatParameter
float getUnsafeFloatParameter(java.lang.String key)
Returns the value of a core float parameter. Note: the semantics of this method will not be guaranteed - core parameter names may change in the future, and this method will not do any parameter name mapping for you, so take care when using this method.- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
- Since:
- 3.0.0.7
-
getUnsafeFloatParameter
float getUnsafeFloatParameter(java.lang.String key, float default_value)
Returns the value of a core float parameter. Note: the semantics of this method will not be guaranteed - core parameter names may change in the future, and this method will not do any parameter name mapping for you, so take care when using this method.- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
- Since:
- 3.0.0.5
-
getUnsafeIntParameter
int getUnsafeIntParameter(java.lang.String key)
Returns the value of a core int parameter. Note: the semantics of this method will not be guaranteed - core parameter names may change in the future, and this method will not do any parameter name mapping for you, so take care when using this method.- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
- Since:
- 3.0.0.7
-
getUnsafeIntParameter
int getUnsafeIntParameter(java.lang.String key, int default_value)
Returns the value of a core int parameter. Note: the semantics of this method will not be guaranteed - core parameter names may change in the future, and this method will not do any parameter name mapping for you, so take care when using this method.- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
- Since:
- 3.0.0.5
-
getUnsafeLongParameter
long getUnsafeLongParameter(java.lang.String key)
Returns the value of a core long parameter. Note: the semantics of this method will not be guaranteed - core parameter names may change in the future, and this method will not do any parameter name mapping for you, so take care when using this method.- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
- Since:
- 3.0.0.7
-
getUnsafeLongParameter
long getUnsafeLongParameter(java.lang.String key, long default_value)
Returns the value of a core long parameter. Note: the semantics of this method will not be guaranteed - core parameter names may change in the future, and this method will not do any parameter name mapping for you, so take care when using this method.- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
- Since:
- 3.0.0.5
-
getUnsafeStringParameter
java.lang.String getUnsafeStringParameter(java.lang.String key)
Returns the value of a core string parameter. Note: the semantics of this method will not be guaranteed - core parameter names may change in the future, and this method will not do any parameter name mapping for you, so take care when using this method.- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
- Since:
- 3.0.0.7
-
getUnsafeStringParameter
java.lang.String getUnsafeStringParameter(java.lang.String key, java.lang.String default_value)
Returns the value of a core string parameter. Note: the semantics of this method will not be guaranteed - core parameter names may change in the future, and this method will not do any parameter name mapping for you, so take care when using this method.- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
- Since:
- 3.0.0.5
-
setUnsafeBooleanParameter
void setUnsafeBooleanParameter(java.lang.String key, boolean value)
Sets the value of a core boolean parameter. Note: the semantics of this method will not be guaranteed - core parameter names may change in the future, and this method will not do any parameter name mapping for you, so take care when using this method.- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.- Since:
- 3.0.0.5
-
setUnsafeByteParameter
void setUnsafeByteParameter(java.lang.String key, byte[] value)
Sets the value of a core byte array parameter. Note: the semantics of this method will not be guaranteed - core parameter names may change in the future, and this method will not do any parameter name mapping for you, so take care when using this method.- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.- Since:
- 3.0.0.7
-
setUnsafeColorParameter
void setUnsafeColorParameter(java.lang.String key, int[] value)
Returns the value of a core color parameter. Note: the semantics of this method will not be guaranteed - core parameter names may change in the future, and this method will not do any parameter name mapping for you, so take care when using this method.The value should be an integer array of size 3 representing the red, green and blue values - or null to disable it.
- Parameters:
key
- The parameter name.value
- The new value for the parameter.- Since:
- 3.0.5.3
-
setUnsafeColorParameter
void setUnsafeColorParameter(java.lang.String key, int[] value, boolean override)
Returns the value of a core color parameter. Note: the semantics of this method will not be guaranteed - core parameter names may change in the future, and this method will not do any parameter name mapping for you, so take care when using this method.The value should be an integer array of size 3 representing the red, green and blue values - or null to disable it.
The override flag is used to indicate if the value being set is overriding the default value. This is mainly used for interface purposes.
- Parameters:
key
- The parameter name.value
- The default value to return if one is not defined.override
- true if the value is overridden from the default.- Since:
- 3.0.5.3
-
setUnsafeFloatParameter
void setUnsafeFloatParameter(java.lang.String key, float value)
Sets the value of a core float parameter. Note: the semantics of this method will not be guaranteed - core parameter names may change in the future, and this method will not do any parameter name mapping for you, so take care when using this method.- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.- Since:
- 3.0.0.5
-
setUnsafeIntParameter
void setUnsafeIntParameter(java.lang.String key, int value)
Sets the value of a core int parameter. Note: the semantics of this method will not be guaranteed - core parameter names may change in the future, and this method will not do any parameter name mapping for you, so take care when using this method.- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.- Since:
- 3.0.0.5
-
setUnsafeLongParameter
void setUnsafeLongParameter(java.lang.String key, long value)
Sets the value of a core long parameter. Note: the semantics of this method will not be guaranteed - core parameter names may change in the future, and this method will not do any parameter name mapping for you, so take care when using this method.- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.- Since:
- 3.0.0.5
-
setUnsafeStringParameter
void setUnsafeStringParameter(java.lang.String key, java.lang.String value)
Sets the value of a core string parameter. Note: the semantics of this method will not be guaranteed - core parameter names may change in the future, and this method will not do any parameter name mapping for you, so take care when using this method.- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.- Since:
- 3.0.0.5
-
removePluginParameter
boolean removePluginParameter(java.lang.String key)
Removes the plugin parameter with the given name.- Parameters:
key
- Name of the parameter.- Returns:
- true if the parameter was found and removed.
-
removePluginColorParameter
boolean removePluginColorParameter(java.lang.String key)
Removes the plugin color parameter with the given name.- Parameters:
key
- Name of the parameter.- Returns:
- true if the parameter was found and removed.
- Since:
- 3.0.5.3
-
getPluginConfigKeyPrefix
java.lang.String getPluginConfigKeyPrefix()
- Returns:
- the prefix used when storing configuration values in the config file for this plugin's config parameters
- Since:
- 2.1.0.0
-
getParameter
ConfigParameter getParameter(java.lang.String key)
-
getPluginParameter
ConfigParameter getPluginParameter(java.lang.String key)
-
isNewInstall
boolean isNewInstall()
-
getUnsafeParameterList
java.util.Map getUnsafeParameterList()
Returns a mapgiving parameter names -> parameter values. Value can be Long or String as the type is actually not known by the core (might fix one day). Therefore, float values are actually represented by their String format: boolean - Long 0 or 1 int - Long.intValue float - String value String - String Unsafe methods - existence/semantics of parameters not guaranteed to be maintained across versions If something changes and breaks your plugin, don't come complaining to me - Since:
- 2.5.0.3
-
save
void save() throws PluginException
make sure you save it after making changes!- Throws:
PluginException
- Since:
- 2.0.8.0
-
getPluginUserFile
java.io.File getPluginUserFile(java.lang.String name)
Returns a file that can be used by the plugin to save user-specific state.This will be client-user-dir/plugins/plugin-name/name.
- Parameters:
name
-- Returns:
-
hasParameter
boolean hasParameter(java.lang.String param_name)
Returns true if a core parameter with the given name exists.- Parameters:
key
- The name of the parameter to check.- Since:
- 2.5.0.2
-
hasPluginParameter
boolean hasPluginParameter(java.lang.String param_name)
Returns true if a plugin parameter with the given name exists.- Parameters:
key
- The name of the parameter to check.- Since:
- 2.5.0.2
-
addListener
void addListener(PluginConfigListener l)
-
removeListener
void removeListener(PluginConfigListener l)
-
setPluginConfigKeyPrefix
void setPluginConfigKeyPrefix(java.lang.String _key)
- Parameters:
_key
-- Since:
- 2.5.0.1
-
enableExternalConfigSource
PluginConfigSource enableExternalConfigSource()
Enable the plugin to store configuration parameters into a separate external configuration file. Note: once this method is called, you need to invokePluginConfigSource.initialize()
for the external configuration file to be properly integrated with the client.When a plugin is first initialised, it should call this method as soon as possible during the initialization stage. This then configures the PluginConfig object to store any parameter values into an external configuration file (rather than storing it directly with the main configuration file used by the client).
When this method is invoked, it will return an object which allows the filename to be chosen - it allows a limited amount of manipulation of the configuration file. This method only needs to be invoked once.
All methods which get and set plugin parameters on this object will store data in the external configuration file. The use of classes like
BasicPluginConfigModel
will automatically integrate parameters to the external configuration source.However, if you use any other mechanism to store parameter data, you may need to call the
registerParameter
to integrate the parameter properly.- Returns:
- The PluginConfigSource object representing the external configuration file.
- Since:
- 3.0.5.3
-
getPluginConfigSource
PluginConfigSource getPluginConfigSource()
Returns the PluginConfigSource object used for this plugin configuration (or null if an external configuration object isn't used).- Returns:
- The PluginConfigSource object.
- Since:
- 3.0.5.3
-
setPluginConfigSource
void setPluginConfigSource(PluginConfigSource source)
Sets the plugin configuration source object to use for storing parameters for this plugin config object.This method should only be used as an alternative to
enableExternalConfigSource()
. You will only need to use this method if you use thegetLocalPluginInterface
method to store data in a separate namespace, but want to use the same configuration file to store data in.- Parameters:
source
- The PluginConfigSource object to use.- Since:
- 3.0.5.3
-
-