Class RPPluginConfig
- All Implemented Interfaces:
PluginConfig
,Serializable
- See Also:
-
Field Summary
FieldsFields inherited from class com.biglybt.pifimpl.remote.RPObject
__delegate, _dispatcher, _object_id, next_key, object_registry, object_registry_reverse
Fields inherited from interface com.biglybt.pif.PluginConfig
CORE_PARAM_BOOLEAN_AUTO_SPEED_ON, CORE_PARAM_BOOLEAN_AUTO_SPEED_SEEDING_ON, CORE_PARAM_BOOLEAN_FRIENDLY_HASH_CHECKING, CORE_PARAM_BOOLEAN_MAX_ACTIVE_SEEDING, CORE_PARAM_BOOLEAN_MAX_UPLOAD_SPEED_SEEDING, CORE_PARAM_BOOLEAN_NEW_SEEDS_START_AT_TOP, CORE_PARAM_BOOLEAN_NEW_TORRENTS_START_AS_STOPPED, CORE_PARAM_BOOLEAN_SOCKS_PROXY_NO_INWARD_CONNECTION, CORE_PARAM_INT_INCOMING_TCP_PORT, CORE_PARAM_INT_INCOMING_UDP_PORT, CORE_PARAM_INT_MAX_ACTIVE, CORE_PARAM_INT_MAX_ACTIVE_SEEDING, CORE_PARAM_INT_MAX_CONNECTIONS_GLOBAL, CORE_PARAM_INT_MAX_CONNECTIONS_PER_TORRENT, CORE_PARAM_INT_MAX_DOWNLOAD_SPEED_KBYTES_PER_SEC, CORE_PARAM_INT_MAX_DOWNLOADS, CORE_PARAM_INT_MAX_UPLOAD_SPEED_KBYTES_PER_SEC, CORE_PARAM_INT_MAX_UPLOAD_SPEED_SEEDING_KBYTES_PER_SEC, CORE_PARAM_INT_MAX_UPLOADS, CORE_PARAM_INT_MAX_UPLOADS_SEEDING, CORE_PARAM_STRING_DEFAULT_SAVE_PATH, CORE_PARAM_STRING_LOCAL_BIND_IP, GUI_PARAM_INT_SWT_REFRESH_IN_MS
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected void
_setDelegate
(Object _delegate) void
_setRemote
(RPRequestDispatcher _dispatcher) void
static PluginConfig
create
(PluginConfig _delegate) Enable the plugin to store configuration parameters into a separate external configuration file.boolean
Returns the value of a core boolean parameter.byte[]
Returns the value of a core byte array parameter.int[]
Returns the value of a core color parameter.float
Returns the value of a core float parameter.int
Returns the value of a core int parameter.long
Returns the value of a core long parameter.Returns the value of a core string parameter.getParameter
(String key) boolean
Returns the value of a plugin boolean parameter.boolean
getPluginBooleanParameter
(String key, boolean defaultValue) Returns the value of a plugin boolean parameter.byte[]
Returns the value of a plugin byte array parameter.byte[]
getPluginByteParameter
(String key, byte[] defaultValue) Returns the value of a plugin byte array parameter.int[]
Returns the value of a plugin color parameter.int[]
getPluginColorParameter
(String key, int[] default_value) Returns the value of a plugin color parameter.Returns the PluginConfigSource object used for this plugin configuration (or null if an external configuration object isn't used).float
Returns the value of a plugin float parameter.float
getPluginFloatParameter
(String key, float default_value) Returns the value of a plugin float parameter.int
Returns the value of a plugin int parameter.int
getPluginIntParameter
(String key, int defaultValue) Returns the value of a plugin int parameter.getPluginListParameter
(String key, List default_value) Returns the value of a plugin list parameter.long
Returns the value of a plugin long parameter.long
getPluginLongParameter
(String key, long default_value) Returns the value of a plugin long parameter.getPluginMapParameter
(String key, Map default_value) Returns the value of a plugin map parameter.getPluginParameter
(String key) String[]
Returns the value of a plugin string-list parameter.Returns the value of a plugin string parameter.getPluginStringParameter
(String key, String defaultValue) Returns the value of a plugin string parameter.getPluginUserFile
(String name) Returns a file that can be used by the plugin to save user-specific state.boolean
Returns the value of a core boolean parameter.boolean
getUnsafeBooleanParameter
(String key, boolean default_value) Returns the value of a core boolean parameter.byte[]
Returns the value of a core byte array parameter.byte[]
getUnsafeByteParameter
(String key, byte[] default_value) Returns the value of a core byte array parameter.int[]
Returns the value of a core color parameter.int[]
getUnsafeColorParameter
(String key, int[] default_value) Returns the value of a core color parameter.float
Returns the value of a core float parameter.float
getUnsafeFloatParameter
(String key, float default_value) Returns the value of a core float parameter.int
Returns the value of a core int parameter.int
getUnsafeIntParameter
(String key, int default_value) Returns the value of a core int parameter.long
Returns the value of a core long parameter.long
getUnsafeLongParameter
(String key, long default_value) Returns the value of a core long parameter.Returns a mapinvalid input: '<'String,Object> giving parameter names -> parameter values.Returns the value of a core string parameter.getUnsafeStringParameter
(String key, String default_value) Returns the value of a core string parameter.boolean
Returns true if a core parameter with the given name exists.boolean
Returns true if a plugin parameter with the given name exists.boolean
void
boolean
Removes the plugin color parameter with the given name.boolean
Removes the plugin parameter with the given name.void
save()
make sure you save it after making changes!void
setCoreBooleanParameter
(String key, boolean value) Sets the value of a core boolean parameter.void
setCoreByteParameter
(String key, byte[] value) Sets the value of a core byte array parameter.void
setCoreColorParameter
(String key, int[] value) Sets the value of a core byte array parameter.void
setCoreColorParameter
(String key, int[] value, boolean override) Sets the value of a core byte array parameter.void
setCoreFloatParameter
(String key, float value) Sets the value of a core float parameter.void
setCoreIntParameter
(String key, int value) Sets the value of a core int parameter.void
setCoreLongParameter
(String key, long value) Sets the value of a core long parameter.void
setCoreStringParameter
(String key, String value) Sets the value of a core string parameter.void
setPluginColorParameter
(String key, int[] value) Sets the value of a plugin color parameter.void
setPluginColorParameter
(String key, int[] value, boolean override) Sets the value of a plugin color parameter.void
void
Sets the plugin configuration source object to use for storing parameters for this plugin config object.void
setPluginListParameter
(String key, List value) Sets the value of a plugin list parameter.void
setPluginMapParameter
(String key, Map value) Sets the value of a plugin map parameter.void
setPluginParameter
(String key, boolean value) Sets the value of a plugin boolean parameter.void
setPluginParameter
(String key, byte[] value) Sets the value of a plugin byte array parameter.void
setPluginParameter
(String key, float value) Sets the value of a plugin float parameter.void
setPluginParameter
(String key, int value) Sets the value of a plugin int parameter.void
setPluginParameter
(String key, int value, boolean global) Sets the value of a plugin int parameter.void
setPluginParameter
(String key, long value) Sets the value of a plugin long parameter.void
setPluginParameter
(String key, String value) Sets the value of a plugin string parameter.void
setPluginStringListParameter
(String key, String[] value) Sets the value of a plugin string-list parameter.void
setUnsafeBooleanParameter
(String key, boolean value) Sets the value of a core boolean parameter.void
setUnsafeByteParameter
(String key, byte[] value) Sets the value of a core byte array parameter.void
setUnsafeColorParameter
(String key, int[] default_value) Returns the value of a core color parameter.void
setUnsafeColorParameter
(String key, int[] default_value, boolean override) Returns the value of a core color parameter.void
setUnsafeFloatParameter
(String key, float value) Sets the value of a core float parameter.void
setUnsafeIntParameter
(String key, int value) Sets the value of a core int parameter.void
setUnsafeLongParameter
(String key, long value) Sets the value of a core long parameter.void
setUnsafeStringParameter
(String key, String value) Sets the value of a core string parameter.Methods inherited from class com.biglybt.pifimpl.remote.RPObject
_fixupLocal, _getDelegate, _getName, _getOID, _lookupLocal, _lookupLocal, _refresh, getDispatcher, notSupported, notSupported
-
Field Details
-
delegate
-
property_cache
-
cached_property_names
-
cached_property_values
-
-
Constructor Details
-
RPPluginConfig
-
-
Method Details
-
create
-
_setDelegate
- Overrides:
_setDelegate
in classRPObject
-
_setLocal
- Overrides:
_setLocal
in classRPObject
- Throws:
RPException
-
_setRemote
- Overrides:
_setRemote
in classRPObject
-
_process
-
isNewInstall
public boolean isNewInstall()- Specified by:
isNewInstall
in interfacePluginConfig
-
getPluginConfigKeyPrefix
- Specified by:
getPluginConfigKeyPrefix
in interfacePluginConfig
- Returns:
- the prefix used when storing configuration values in the config file for this plugin's config parameters
-
getPluginListParameter
Description copied from interface:PluginConfig
Returns the value of a plugin list parameter. The contents of the list must conform to bencodable rules (e.g. Map, Long, byte[], List)- Specified by:
getPluginListParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
-
setPluginListParameter
Description copied from interface:PluginConfig
Sets the value of a plugin list parameter. The contents of the list must conform to bencodable rules (e.g. Map, Long, byte[], List)- Specified by:
setPluginListParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.value
- The new value for the parameter.
-
getPluginMapParameter
Description copied from interface:PluginConfig
Returns the value of a plugin map parameter. The contents of the map must conform to bencodable rules (e.g. Map, Long, byte[], List)- Specified by:
getPluginMapParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
-
setPluginMapParameter
Description copied from interface:PluginConfig
Sets the value of a plugin map parameter. The contents of the map must conform to bencodable rules (e.g. Map, Long, byte[], List)- Specified by:
setPluginMapParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.value
- The new value for the parameter.
-
getPluginIntParameter
Description copied from interface:PluginConfig
Returns the value of a plugin int parameter.- Specified by:
getPluginIntParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
-
getPluginIntParameter
Description copied from interface:PluginConfig
Returns the value of a plugin int parameter.- Specified by:
getPluginIntParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.defaultValue
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
-
getPluginStringParameter
Description copied from interface:PluginConfig
Returns the value of a plugin string parameter.- Specified by:
getPluginStringParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
-
getPluginStringParameter
Description copied from interface:PluginConfig
Returns the value of a plugin string parameter.- Specified by:
getPluginStringParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.defaultValue
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
-
getPluginBooleanParameter
Description copied from interface:PluginConfig
Returns the value of a plugin boolean parameter.- Specified by:
getPluginBooleanParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
-
getPluginByteParameter
Description copied from interface:PluginConfig
Returns the value of a plugin byte array parameter.- Specified by:
getPluginByteParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.defaultValue
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
-
getPluginBooleanParameter
Description copied from interface:PluginConfig
Returns the value of a plugin boolean parameter.- Specified by:
getPluginBooleanParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.defaultValue
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
-
setPluginParameter
Description copied from interface:PluginConfig
Sets the value of a plugin int parameter.- Specified by:
setPluginParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.value
- The new value for the parameter.
-
setPluginParameter
Description copied from interface:PluginConfig
Sets the value of a plugin int parameter.- Specified by:
setPluginParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.value
- The new value for the parameter.global
- Whether or not this parameter should be made externally accessible.
-
setPluginParameter
Description copied from interface:PluginConfig
Sets the value of a plugin string parameter.- Specified by:
setPluginParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.value
- The new value for the parameter.
-
setPluginParameter
Description copied from interface:PluginConfig
Sets the value of a plugin boolean parameter.- Specified by:
setPluginParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.value
- The new value for the parameter.
-
setPluginParameter
Description copied from interface:PluginConfig
Sets the value of a plugin byte array parameter.- Specified by:
setPluginParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.value
- The new value for the parameter.
-
getParameter
- Specified by:
getParameter
in interfacePluginConfig
-
getPluginParameter
- Specified by:
getPluginParameter
in interfacePluginConfig
-
getUnsafeBooleanParameter
Description copied from interface:PluginConfig
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.- Specified by:
getUnsafeBooleanParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
-
setUnsafeBooleanParameter
Description copied from interface:PluginConfig
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.- Specified by:
setUnsafeBooleanParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.
-
getUnsafeIntParameter
Description copied from interface:PluginConfig
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.- Specified by:
getUnsafeIntParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
-
setUnsafeIntParameter
Description copied from interface:PluginConfig
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.- Specified by:
setUnsafeIntParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.
-
getUnsafeLongParameter
Description copied from interface:PluginConfig
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.- Specified by:
getUnsafeLongParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
-
setUnsafeLongParameter
Description copied from interface:PluginConfig
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.- Specified by:
setUnsafeLongParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.
-
getUnsafeFloatParameter
Description copied from interface:PluginConfig
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.- Specified by:
getUnsafeFloatParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
-
setUnsafeFloatParameter
Description copied from interface:PluginConfig
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.- Specified by:
setUnsafeFloatParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.
-
getUnsafeStringParameter
Description copied from interface:PluginConfig
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.- Specified by:
getUnsafeStringParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
-
setUnsafeStringParameter
Description copied from interface:PluginConfig
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.- Specified by:
setUnsafeStringParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.
-
getUnsafeParameterList
Description copied from interface:PluginConfig
Returns a mapinvalid input: '<'String,Object> giving 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- Specified by:
getUnsafeParameterList
in interfacePluginConfig
-
save
Description copied from interface:PluginConfig
make sure you save it after making changes!- Specified by:
save
in interfacePluginConfig
- Throws:
PluginException
-
getPluginUserFile
Description copied from interface:PluginConfig
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.
- Specified by:
getPluginUserFile
in interfacePluginConfig
- Parameters:
name
-- Returns:
-
addListener
- Specified by:
addListener
in interfacePluginConfig
-
removeListener
- Specified by:
removeListener
in interfacePluginConfig
-
setPluginConfigKeyPrefix
- Specified by:
setPluginConfigKeyPrefix
in interfacePluginConfig
- Parameters:
_key
-
-
hasParameter
Description copied from interface:PluginConfig
Returns true if a core parameter with the given name exists.- Specified by:
hasParameter
in interfacePluginConfig
-
hasPluginParameter
Description copied from interface:PluginConfig
Returns true if a plugin parameter with the given name exists.- Specified by:
hasPluginParameter
in interfacePluginConfig
-
removePluginParameter
Description copied from interface:PluginConfig
Removes the plugin parameter with the given name.- Specified by:
removePluginParameter
in interfacePluginConfig
- Parameters:
x
- Name of the parameter.- Returns:
- true if the parameter was found and removed.
-
removePluginColorParameter
Description copied from interface:PluginConfig
Removes the plugin color parameter with the given name.- Specified by:
removePluginColorParameter
in interfacePluginConfig
- Parameters:
x
- Name of the parameter.- Returns:
- true if the parameter was found and removed.
-
getPluginByteParameter
Description copied from interface:PluginConfig
Returns the value of a plugin byte array parameter.- Specified by:
getPluginByteParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
-
getPluginFloatParameter
Description copied from interface:PluginConfig
Returns the value of a plugin float parameter.- Specified by:
getPluginFloatParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
-
getPluginFloatParameter
Description copied from interface:PluginConfig
Returns the value of a plugin float parameter.- Specified by:
getPluginFloatParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
-
getPluginLongParameter
Description copied from interface:PluginConfig
Returns the value of a plugin long parameter.- Specified by:
getPluginLongParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
-
getPluginLongParameter
Description copied from interface:PluginConfig
Returns the value of a plugin long parameter.- Specified by:
getPluginLongParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
-
setPluginParameter
Description copied from interface:PluginConfig
Sets the value of a plugin float parameter.- Specified by:
setPluginParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.value
- The new value for the parameter.
-
setPluginParameter
Description copied from interface:PluginConfig
Sets the value of a plugin long parameter.- Specified by:
setPluginParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.value
- The new value for the parameter.
-
getUnsafeBooleanParameter
Description copied from interface:PluginConfig
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.- Specified by:
getUnsafeBooleanParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
-
getUnsafeByteParameter
Description copied from interface:PluginConfig
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.- Specified by:
getUnsafeByteParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
-
getUnsafeByteParameter
Description copied from interface:PluginConfig
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.- Specified by:
getUnsafeByteParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
-
getUnsafeFloatParameter
Description copied from interface:PluginConfig
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.- Specified by:
getUnsafeFloatParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
-
getUnsafeIntParameter
Description copied from interface:PluginConfig
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.- Specified by:
getUnsafeIntParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
-
getUnsafeLongParameter
Description copied from interface:PluginConfig
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.- Specified by:
getUnsafeLongParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
-
getUnsafeStringParameter
Description copied from interface:PluginConfig
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.- Specified by:
getUnsafeStringParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
-
setUnsafeByteParameter
Description copied from interface:PluginConfig
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.- Specified by:
setUnsafeByteParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.
-
getCoreBooleanParameter
Description copied from interface:PluginConfig
Returns the value of a core boolean parameter.- Specified by:
getCoreBooleanParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
-
getCoreByteParameter
Description copied from interface:PluginConfig
Returns the value of a core byte array parameter.- Specified by:
getCoreByteParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
-
getCoreFloatParameter
Description copied from interface:PluginConfig
Returns the value of a core float parameter.- Specified by:
getCoreFloatParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
-
getCoreIntParameter
Description copied from interface:PluginConfig
Returns the value of a core int parameter.- Specified by:
getCoreIntParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
-
getCoreStringParameter
Description copied from interface:PluginConfig
Returns the value of a core string parameter.- Specified by:
getCoreStringParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
-
getCoreLongParameter
Description copied from interface:PluginConfig
Returns the value of a core long parameter.- Specified by:
getCoreLongParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
-
setCoreBooleanParameter
Description copied from interface:PluginConfig
Sets the value of a core boolean parameter.- Specified by:
setCoreBooleanParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.
-
setCoreByteParameter
Description copied from interface:PluginConfig
Sets the value of a core byte array parameter.- Specified by:
setCoreByteParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.
-
setCoreFloatParameter
Description copied from interface:PluginConfig
Sets the value of a core float parameter.- Specified by:
setCoreFloatParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.
-
setCoreIntParameter
Description copied from interface:PluginConfig
Sets the value of a core int parameter.- Specified by:
setCoreIntParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.
-
setCoreLongParameter
Description copied from interface:PluginConfig
Sets the value of a core long parameter.- Specified by:
setCoreLongParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.
-
setCoreStringParameter
Description copied from interface:PluginConfig
Sets the value of a core string parameter.- Specified by:
setCoreStringParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.
-
getCoreColorParameter
Description copied from interface:PluginConfig
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.
- Specified by:
getCoreColorParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
-
setCoreColorParameter
Description copied from interface:PluginConfig
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.
- Specified by:
setCoreColorParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name, which must be one defined from the above core constants.value
- The new value for the parameter.
-
setCoreColorParameter
Description copied from interface:PluginConfig
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.
- Specified by:
setCoreColorParameter
in interfacePluginConfig
- 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.
-
getPluginColorParameter
Description copied from interface:PluginConfig
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.
- Specified by:
getPluginColorParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
-
getPluginColorParameter
Description copied from interface:PluginConfig
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.
- Specified by:
getPluginColorParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
-
setPluginColorParameter
Description copied from interface:PluginConfig
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.
- Specified by:
setPluginColorParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.value
- The new value for the parameter.
-
setPluginColorParameter
Description copied from interface:PluginConfig
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.
- Specified by:
setPluginColorParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.value
- The new value for the parameter.override
- true if the value is overridden from the default.
-
getUnsafeColorParameter
Description copied from interface:PluginConfig
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.
- Specified by:
getUnsafeColorParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
-
getUnsafeColorParameter
Description copied from interface:PluginConfig
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.
- Specified by:
getUnsafeColorParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.- Returns:
- The value of the parameter.
-
setUnsafeColorParameter
Description copied from interface:PluginConfig
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.
- Specified by:
setUnsafeColorParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.default_value
- The new value for the parameter.
-
setUnsafeColorParameter
Description copied from interface:PluginConfig
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.
- Specified by:
setUnsafeColorParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.default_value
- The default value to return if one is not defined.override
- true if the value is overridden from the default.
-
getPluginConfigSource
Description copied from interface:PluginConfig
Returns the PluginConfigSource object used for this plugin configuration (or null if an external configuration object isn't used).- Specified by:
getPluginConfigSource
in interfacePluginConfig
- Returns:
- The PluginConfigSource object.
-
setPluginConfigSource
Description copied from interface:PluginConfig
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
PluginConfig.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.- Specified by:
setPluginConfigSource
in interfacePluginConfig
- Parameters:
source
- The PluginConfigSource object to use.
-
enableExternalConfigSource
Description copied from interface:PluginConfig
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
invalid reference
registerParameter
- Specified by:
enableExternalConfigSource
in interfacePluginConfig
- Returns:
- The PluginConfigSource object representing the external configuration file.
-
setPluginStringListParameter
Description copied from interface:PluginConfig
Sets the value of a plugin string-list parameter.- Specified by:
setPluginStringListParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.value
- The new value of the parameter.
-
getPluginStringListParameter
Description copied from interface:PluginConfig
Returns the value of a plugin string-list parameter. If no value is set, an empty string array will be returned.- Specified by:
getPluginStringListParameter
in interfacePluginConfig
- Parameters:
key
- The parameter name.- Returns:
- The value of the parameter.
-