com.paypal.selion.configuration

Class LocalConfig

java.lang.Object

com.paypal.selion.configuration.LocalConfig

@ThreadSafe
public class LocalConfig
extends Object

A local configuration object that contains SeLion configuration property values (i.e. "property bag") of Config.ConfigProperty. Local configuration is really composed of the global SeLionConfig values as well as property value "updates" made for each local configuration instance. Local configuration property values over-ride the corresponding global SeLionConfig property value. A local configuration supports configuration via parameters that are in the testng "test" tag scope over-riding parameters values in suite scope.

 Map<ConfigProperty, String> localValues = new HashMap<ConfigProperty, String>();
 LocalConfig localConfig = new LocalConfig(localValues);
 

See Config.ConfigProperty for the configuration properties that are supported and their initial default values. Some configuration properties are global only in scope and cannot be specified in a local configuration. These properties must be specified globally using Config.

Constructor Summary

Constructors

Constructor and Description
LocalConfig() Constructs a new instance of this class.
LocalConfig(Config.ConfigProperty configProperty, String value) Constructs a new instance of this class with the specified initial value.
LocalConfig(Map<Config.ConfigProperty,String> initialValues) Constructs a new instance of this class from the specified initial values.

Method Summary

Modifier and Type	Method and Description
boolean	getBooleanConfigProperty(Config.ConfigProperty configProperty)
String	getConfigProperty(Config.ConfigProperty configProperty) Get the configuration property value for configProperty.
int	getIntConfigProperty(Config.ConfigProperty configProperty)
List<Object>	getListConfigProperty(Config.ConfigProperty configProperty)
Map<String,String>	getLocalConfigValues() Returns only the local configuration values associated with the Local Config.
boolean	isLocalValuePresent(Config.ConfigProperty configProperty) Answer if local configuration contains a value for specified property.
void	printConfigValues(String testName) Prints the configuration values associated with the LocalConfig.
void	setConfigProperty(Config.ConfigProperty configProperty, Object configPropertyValue) Sets the SeLion configuration property value.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalConfig

public LocalConfig()

Constructs a new instance of this class.

LocalConfig

public LocalConfig(Config.ConfigProperty configProperty,
                   String value)

Constructs a new instance of this class with the specified initial value.

Parameters:

configProperty - Config.ConfigProperty The ConfigProperty to set in the local configuration.

value - String The configuration property value to set.

LocalConfig

public LocalConfig(Map<Config.ConfigProperty,String> initialValues)

Constructs a new instance of this class from the specified initial values.

Parameters:

initialValues - Map The initial MAP of ConfigProperty values used to create the local configuration.

Method Detail

getConfigProperty

public String getConfigProperty(Config.ConfigProperty configProperty)

Get the configuration property value for configProperty.

Parameters:

configProperty - The configuration property value to get

Returns:

The configuration property value or null if property does not exit.

getListConfigProperty

public List<Object> getListConfigProperty(Config.ConfigProperty configProperty)

getIntConfigProperty

public int getIntConfigProperty(Config.ConfigProperty configProperty)

getBooleanConfigProperty

public boolean getBooleanConfigProperty(Config.ConfigProperty configProperty)

setConfigProperty

public void setConfigProperty(Config.ConfigProperty configProperty,
                              Object configPropertyValue)

Sets the SeLion configuration property value.

Parameters:

configProperty - The configuration property to set.

configPropertyValue - The configuration property value to set.

printConfigValues

public void printConfigValues(String testName)

Prints the configuration values associated with the LocalConfig. Used for logging/debug.

Parameters:

testName - The <test> to which this configuration pertains to.

getLocalConfigValues

public Map<String,String> getLocalConfigValues()

Returns only the local configuration values associated with the Local Config. Used for logging/reporting.

Returns:

The local configuration property name/values as map.

isLocalValuePresent

public boolean isLocalValuePresent(Config.ConfigProperty configProperty)

Answer if local configuration contains a value for specified property.

Returns:

True if local configuration has value for configProperty.