File Doc Category Size Date Package
PluginConfig.java API Doc Azureus 3.0.3.4 26011 Wed Feb 07 12:00:42 GMT 2007 org.gudy.azureus2.plugins

PluginConfig

public interface PluginConfig

author: Olivier

Fields Summary
public static final String
CORE_PARAM_INT_MAX_UPLOAD_SPEED_KBYTES_PER_SEC
public static final String
CORE_PARAM_INT_MAX_UPLOAD_SPEED_SEEDING_KBYTES_PER_SEC
public static final String
CORE_PARAM_INT_MAX_DOWNLOAD_SPEED_KBYTES_PER_SEC
public static final String
CORE_PARAM_INT_MAX_CONNECTIONS_PER_TORRENT
public static final String
CORE_PARAM_INT_MAX_CONNECTIONS_GLOBAL
public static final String
CORE_PARAM_INT_MAX_DOWNLOADS
public static final String
CORE_PARAM_INT_MAX_ACTIVE
public static final String
CORE_PARAM_INT_MAX_ACTIVE_SEEDING
public static final String
CORE_PARAM_INT_MAX_UPLOADS
public static final String
CORE_PARAM_INT_MAX_UPLOADS_SEEDING
public static final String
CORE_PARAM_BOOLEAN_AUTO_SPEED_ON
public static final String
CORE_PARAM_BOOLEAN_MAX_UPLOAD_SPEED_SEEDING
public static final String
CORE_PARAM_BOOLEAN_MAX_ACTIVE_SEEDING
public static final String
CORE_PARAM_BOOLEAN_SOCKS_PROXY_NO_INWARD_CONNECTION
public static final String
CORE_PARAM_BOOLEAN_NEW_SEEDS_START_AT_TOP
public static final String
CORE_PARAM_STRING_LOCAL_BIND_IP
public static final String
CORE_PARAM_BOOLEAN_FRIENDLY_HASH_CHECKING
Constructors Summary
Methods Summary
public void addListener(PluginConfigListener l)
public boolean getBooleanParameter(java.lang.String key)
Returns the value of a core boolean parameter.
param
key The parameter name.
return
The value of the parameter.
since
2.0.4.2
public boolean getBooleanParameter(java.lang.String key, boolean default_value)
Returns the value of a core boolean parameter.
param
key The parameter name.
param
default_value The default value to return if one is not defined.
return
The value of the parameter.
since
2.0.6.0
public byte[] getByteParameter(java.lang.String key)
Returns the value of a core byte array parameter.
param
key The parameter name.
return
The value of the parameter.
since
3.0.0.7
public byte[] getByteParameter(java.lang.String key, byte[] default_value)
Returns the value of a core byte array parameter.
param
key The parameter name.
param
default_value The default value to return if one is not defined.
return
The value of the parameter.
since
2.1.0.2
public float getFloatParameter(java.lang.String key)
Returns the value of a core float parameter.
param
key The parameter name.
return
The value of the parameter.
since
2.1.0.0
public float getFloatParameter(java.lang.String key, float default_value)
Returns the value of a core float parameter.
param
key The parameter name.
param
default_value The default value to return if one is not defined.
return
The value of the parameter.
since
3.0.0.7
public int getIntParameter(java.lang.String key)
Returns the value of a core int parameter.
param
key The parameter name.
return
The value of the parameter.
since
2.0.4.2
public int getIntParameter(java.lang.String key, int default_value)
Returns the value of a core int parameter.
param
key The parameter name.
param
default_value The default value to return if one is not defined.
return
The value of the parameter.
since
2.0.7.0
public long getLongParameter(java.lang.String key, long default_value)
Returns the value of a core long parameter.
param
key The parameter name.
param
default_value The default value to return if one is not defined.
return
The value of the parameter.
since
3.0.0.7
public long getLongParameter(java.lang.String key)
Returns the value of a core long parameter.
param
key The parameter name.
return
The value of the parameter.
since
3.0.0.7
public ConfigParameter getParameter(java.lang.String key)
public boolean getPluginBooleanParameter(java.lang.String key)
Returns the value of a plugin boolean parameter.
param
key The parameter name.
return
The value of the parameter.
since
2.0.4.2
public boolean getPluginBooleanParameter(java.lang.String key, boolean default_value)
Returns the value of a plugin boolean parameter.
param
key The parameter name.
param
default_value The default value to return if one is not defined.
return
The value of the parameter.
since
2.0.4.2
public byte[] getPluginByteParameter(java.lang.String key)
Returns the value of a plugin byte array parameter.
param
key The parameter name.
return
The value of the parameter.
since
3.0.0.7
public byte[] getPluginByteParameter(java.lang.String key, byte[] default_value)
Returns the value of a plugin byte array parameter.
param
key The parameter name.
param
default_value The default value to return if one is not defined.
return
The value of the parameter.
since
2.2.0.3
public java.lang.String getPluginConfigKeyPrefix()
return
the prefix used when storing configuration values in the config file for this plugin's config parameters
since
2.1.0.0
public float getPluginFloatParameter(java.lang.String key)
Returns the value of a plugin float parameter.
param
key The parameter name.
return
The value of the parameter.
since
3.0.0.7
public float getPluginFloatParameter(java.lang.String key, float default_value)
Returns the value of a plugin float parameter.
param
key The parameter name.
param
default_value The default value to return if one is not defined.
return
The value of the parameter.
since
3.0.0.7
public int getPluginIntParameter(java.lang.String key)
Returns the value of a plugin int parameter.
param
key The parameter name.
return
The value of the parameter.
since
2.0.4.2
public int getPluginIntParameter(java.lang.String key, int default_value)
Returns the value of a plugin int parameter.
param
key The parameter name.
param
default_value The default value to return if one is not defined.
return
The value of the parameter.
since
2.0.4.2
public 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)
param
key The parameter name.
param
default_value The default value to return if one is not defined.
return
The value of the parameter.
since
2.3.0.1
public long getPluginLongParameter(java.lang.String key)
Returns the value of a plugin long parameter.
param
key The parameter name.
return
The value of the parameter.
since
3.0.0.7
public long getPluginLongParameter(java.lang.String key, long default_value)
Returns the value of a plugin long parameter.
param
key The parameter name.
param
default_value The default value to return if one is not defined.
return
The value of the parameter.
since
3.0.0.7
public 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)
param
key The parameter name.
param
default_value The default value to return if one is not defined.
return
The value of the parameter.
since
2.3.0.1
public ConfigParameter getPluginParameter(java.lang.String key)
public java.lang.String getPluginStringParameter(java.lang.String key)
Returns the value of a plugin string parameter.
param
key The parameter name.
return
The value of the parameter.
since
2.0.4.2
public java.lang.String getPluginStringParameter(java.lang.String key, java.lang.String default_value)
Returns the value of a plugin string parameter.
param
key The parameter name.
param
default_value The default value to return if one is not defined.
return
The value of the parameter.
since
2.0.4.2
public 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 "azureus-user-dir"/plugins//name
param
name
return
public java.lang.String getStringParameter(java.lang.String key)
Returns the value of a core string parameter.
param
key The parameter name.
return
The value of the parameter.
since
2.0.4.2
public java.lang.String getStringParameter(java.lang.String key, java.lang.String default_value)
Returns the value of a core string parameter.
param
key The parameter name.
param
default_value The default value to return if one is not defined.
return
The value of the parameter.
since
2.1.0.0
public 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.
param
key The parameter name.
param
default_value The default value to return if one is not defined.
return
The value of the parameter.
since
3.0.0.7
public 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.
param
key The parameter name.
param
default_value The default value to return if one is not defined.
return
The value of the parameter.
since
3.0.0.5
public 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.
param
key The parameter name.
return
The value of the parameter.
since
3.0.0.7
public 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.
param
key The parameter name.
param
default_value The default value to return if one is not defined.
return
The value of the parameter.
since
3.0.0.7
public 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.
param
key The parameter name.
return
The value of the parameter.
since
3.0.0.7
public 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.
param
key The parameter name.
param
default_value The default value to return if one is not defined.
return
The value of the parameter.
since
3.0.0.5
public 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.
param
key The parameter name.
return
The value of the parameter.
since
3.0.0.7
public 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.
param
key The parameter name.
param
default_value The default value to return if one is not defined.
return
The value of the parameter.
since
3.0.0.5
public 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.
param
key The parameter name.
return
The value of the parameter.
since
3.0.0.7
public 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.
param
key The parameter name.
param
default_value The default value to return if one is not defined.
return
The value of the parameter.
since
3.0.0.5
public java.util.Map getUnsafeParameterList()
Returns a map 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
since
2.5.0.3
public 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.
param
key The parameter name.
return
The value of the parameter.
since
3.0.0.7
public 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.
param
key The parameter name.
param
default_value The default value to return if one is not defined.
return
The value of the parameter.
since
3.0.0.5
public boolean hasParameter(java.lang.String param_name)
Returns true if a core parameter with the given name exists.
param
key The name of the parameter to check.
since
2.5.0.2
public boolean hasPluginParameter(java.lang.String param_name)
Returns true if a plugin parameter with the given name exists.
param
key The name of the parameter to check.
since
2.5.0.2
public boolean isNewInstall()
public boolean removePluginParameter(java.lang.String key)
Removes the plugin parameter with the given name.
param
key Name of the parameter.
return
true if the parameter was found and removed.
public void save()
make sure you save it after making changes!
since
2.0.8.0
public void setBooleanParameter(java.lang.String key, boolean value)
Sets the value of a core boolean parameter.
param
key The parameter name, which must be one defined from the above core constants.
param
value The new value for the parameter.
public void setByteParameter(java.lang.String key, byte[] value)
Sets the value of a core byte array parameter.
param
key The parameter name, which must be one defined from the above core constants.
param
value The new value for the parameter.
since
3.0.0.7
public void setFloatParameter(java.lang.String key, float value)
Sets the value of a core float parameter.
param
key The parameter name, which must be one defined from the above core constants.
param
value The new value for the parameter.
since
3.0.0.7
public void setIntParameter(java.lang.String key, int value)
Sets the value of a core int parameter.
param
key The parameter name, which must be one defined from the above core constants.
param
value The new value for the parameter.
since
2.0.8.0
public void setLongParameter(java.lang.String key, long value)
Sets the value of a core long parameter.
param
key The parameter name, which must be one defined from the above core constants.
param
value The new value for the parameter.
since
3.0.0.7
public void setPluginConfigKeyPrefix(java.lang.String _key)
param
_key
since
2.5.0.1
public 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)
param
key The parameter name.
param
value The new value for the parameter.
since
2.3.0.1
public 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)
param
key The parameter name.
param
value The new value for the parameter.
since
2.3.0.1
public void setPluginParameter(java.lang.String key, boolean value)
Sets the value of a plugin boolean parameter.
param
key The parameter name.
param
value The new value for the parameter.
since
2.0.4.2
public void setPluginParameter(java.lang.String key, byte[] value)
Sets the value of a plugin byte array parameter.
param
key The parameter name.
param
value The new value for the parameter.
since
2.1.0.2
public void setPluginParameter(java.lang.String key, float value)
Sets the value of a plugin float parameter.
param
key The parameter name.
param
value The new value for the parameter.
since
3.0.0.7
public void setPluginParameter(java.lang.String key, int value)
Sets the value of a plugin int parameter.
param
key The parameter name.
param
value The new value for the parameter.
since
2.0.4.2
public void setPluginParameter(java.lang.String key, int value, boolean global)
Sets the value of a plugin int parameter.
param
key The parameter name.
param
value The new value for the parameter.
param
global Whether or not this parameter should be made externally accessible.
since
2.5.0.1
public void setPluginParameter(java.lang.String key, long value)
Sets the value of a plugin long parameter.
param
key The parameter name.
param
value The new value for the parameter.
since
3.0.0.7
public void setPluginParameter(java.lang.String key, java.lang.String value)
Sets the value of a plugin string parameter.
param
key The parameter name.
param
value The new value for the parameter.
since
2.0.4.2
public void setStringParameter(java.lang.String key, java.lang.String value)
Sets the value of a core string parameter.
param
key The parameter name, which must be one defined from the above core constants.
param
value The new value for the parameter.
since
3.0.0.7
public 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.
param
key The parameter name, which must be one defined from the above core constants.
param
value The new value for the parameter.
since
3.0.0.5
public 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.
param
key The parameter name, which must be one defined from the above core constants.
param
value The new value for the parameter.
since
3.0.0.7
public 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.
param
key The parameter name, which must be one defined from the above core constants.
param
value The new value for the parameter.
since
3.0.0.5
public 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.
param
key The parameter name, which must be one defined from the above core constants.
param
value The new value for the parameter.
since
3.0.0.5
public 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.
param
key The parameter name, which must be one defined from the above core constants.
param
value The new value for the parameter.
since
3.0.0.5
public 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.
param
key The parameter name, which must be one defined from the above core constants.
param
value The new value for the parameter.
since
3.0.0.5