org.parosproxy.paros.common

Class AbstractParam

java.lang.Object

org.parosproxy.paros.common.AbstractParam

All Implemented Interfaces:

Cloneable

Direct Known Subclasses:

AlertParam, AntiCsrfParam, BreakpointsParam, CallbackParam, ConnectionParam, DatabaseParam, DynSSLParam, ExtensionParam, GlobalExcludeURLParam, HttpSessionsParam, KeyboardParam, OptionsParam, OptionsParamApi, OptionsParamCertificate, OptionsParamCheckForUpdates, OptionsParamMisc, OptionsParamView, PassiveScanParam, ProxiesParam, ProxyParam, RuleConfigParam, ScannerParam, ScriptParam, SearchParam, SpiderParam, StatsParam, VersionedAbstractParam

public abstract class AbstractParam
extends Object
implements Cloneable

Constructor Summary

Constructors

Constructor and Description
AbstractParam()

Method Summary

Modifier and Type	Method and Description
AbstractParam	clone()
protected boolean	getBoolean(String key, boolean defaultValue) Gets the boolean with the given configuration key.
org.apache.commons.configuration.FileConfiguration	getConfig() Gets the configuration file, previously loaded.
protected int	getInt(String key, int defaultValue) Gets the int with the given configuration key.
protected Integer	getInteger(String key, Integer defaultValue) Gets the Integer with the given configuration key.
protected String	getString(String key, String defaultValue) Gets the String with the given configuration key.
void	load(org.apache.commons.configuration.FileConfiguration config) Loads the configurations from the given configuration file.
void	load(String filePath) Loads the configurations from the file located at the given path.
void	load(String filePath, ControlOverrides overrides) Loads the configurations from the file located at the given path and using the given overrides
protected static void	logConversionException(String key, org.apache.commons.configuration.ConversionException e) Logs the given ConversionException, that occurred while reading the configuration with the given key.
protected abstract void	parse() Parses the configurations.
void	reset() Will be called to reset the options to factory defaults.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractParam

public AbstractParam()

Method Detail

load

public void load(org.apache.commons.configuration.FileConfiguration config)

Loads the configurations from the given configuration file.

Parameters:

config - the configuration file

load

public void load(String filePath)

Loads the configurations from the file located at the given path.

Parameters:

filePath - the path to the configuration file, might be relative.

load

public void load(String filePath,
                 ControlOverrides overrides)

Loads the configurations from the file located at the given path and using the given overrides

Parameters:

filePath - the path to the configuration file, might be relative.

overrides - the configuration overrides, might be null.

getConfig

public org.apache.commons.configuration.FileConfiguration getConfig()

Gets the configuration file, previously loaded.

Returns:

the configurations file

clone

public AbstractParam clone()

Overrides:

clone in class Object

parse

protected abstract void parse()

Parses the configurations.

Called each time the configurations are loaded.

See Also:

getConfig()

reset

public void reset()

Will be called to reset the options to factory defaults. Most classes will not need to do anything, but those that do can override this method.

getString

protected String getString(String key,
                           String defaultValue)

Gets the String with the given configuration key.

The default value is returned if the key doesn't exist or it's not a String.

Parameters:

key - the configuration key.

defaultValue - the default value, if the key doesn't exist or it's not a String.

Returns:

the value of the configuration, or default value.

Since:

2.7.0

logConversionException

protected static void logConversionException(String key,
                                             org.apache.commons.configuration.ConversionException e)

Logs the given ConversionException, that occurred while reading the configuration with the given key.

Parameters:

key - the configuration key.

e - the ConversionException.

Since:

2.7.0

getBoolean

protected boolean getBoolean(String key,
                             boolean defaultValue)

Gets the boolean with the given configuration key.

The default value is returned if the key doesn't exist or it's not a boolean.

Parameters:

key - the configuration key.

defaultValue - the default value, if the key doesn't exist or it's not a boolean.

Returns:

the value of the configuration, or default value.

Since:

2.7.0

getInt

protected int getInt(String key,
                     int defaultValue)

Gets the int with the given configuration key.

The default value is returned if the key doesn't exist or it's not a int.

Parameters:

key - the configuration key.

defaultValue - the default value, if the key doesn't exist or it's not an int.

Returns:

the value of the configuration, or default value.

Since:

2.7.0

getInteger

protected Integer getInteger(String key,
                             Integer defaultValue)

Gets the Integer with the given configuration key.

The default value is returned if the key doesn't exist or it's not a Integer.

Parameters:

key - the configuration key.

defaultValue - the default value, if the key doesn't exist or it's not an Integer.

Returns:

the value of the configuration, or default value.

Since:

2.7.0