net.thucydides.core.util

Interface EnvironmentVariables

All Known Implementing Classes:

MockEnvironmentVariables, SystemEnvironmentVariables

public interface EnvironmentVariables

Return system environment variable values.

Method Summary

Modifier and Type	Method and Description
default List<String>	activeEnvironments()
Map<String,String>	asMap()
boolean	aValueIsDefinedFor(Enum<?> property)
boolean	aValueIsDefinedFor(String property)
void	clearProperty(String name)
EnvironmentVariables	copy()
default com.typesafe.config.Config	getConfig(String prefix)
List<String>	getKeys()
Properties	getProperties()
Properties	getPropertiesWithPrefix(String prefix)
String	getProperty(Enum<?> property)
String	getProperty(Enum<?> property, String defaultValue)
String	getProperty(String name)
String	getProperty(String name, String defaultValue)
Boolean	getPropertyAsBoolean(Enum<?> property, boolean defaultValue)
Boolean	getPropertyAsBoolean(String name, boolean defaultValue)
Integer	getPropertyAsInteger(Enum<?> property, Integer defaultValue)
Integer	getPropertyAsInteger(String name, Integer defaultValue)
String	getValue(Enum<?> property)
String	getValue(Enum<?> property, String defaultValue)
String	getValue(String name)
String	getValue(String name, String defaultValue)
boolean	hasPath(String path)
String	injectSystemPropertiesInto(String value)
Optional<String>	optionalProperty(String name) Returns an optional system property.
void	reset()
void	setConfig(com.typesafe.config.Config typesafeConfig)
void	setProperties(Map<String,String> properties)
void	setProperty(String name, String value)
Map<String,String>	simpleSystemPropertiesAsMap()

Method Detail

getValue

String getValue(String name)

getValue

String getValue(Enum<?> property)

getValue

String getValue(String name,
                String defaultValue)

getValue

String getValue(Enum<?> property,
                String defaultValue)

getPropertyAsInteger

Integer getPropertyAsInteger(String name,
                             Integer defaultValue)

getPropertyAsInteger

Integer getPropertyAsInteger(Enum<?> property,
                             Integer defaultValue)

getPropertyAsBoolean

Boolean getPropertyAsBoolean(String name,
                             boolean defaultValue)

getPropertyAsBoolean

Boolean getPropertyAsBoolean(Enum<?> property,
                             boolean defaultValue)

getProperty

String getProperty(String name)

optionalProperty

Optional<String> optionalProperty(String name)

Returns an optional system property. The property may be defined in the project's serenity.properties or serenity.conf file, or be provided as a a system property. This is designed particularly for user-provided properties, to make it easier to store test confiuration properties in a single file.

Sample usage: ``` EnvironmentVariables environmentVariables;

String environment = environmentVariables.optionalProperty("env").orElse("DEV") ```

getProperty

String getProperty(Enum<?> property)

getProperty

String getProperty(String name,
                   String defaultValue)

getProperty

String getProperty(Enum<?> property,
                   String defaultValue)

setProperty

void setProperty(String name,
                 String value)

setProperties

void setProperties(Map<String,String> properties)

clearProperty

void clearProperty(String name)

copy

EnvironmentVariables copy()

getKeys

List<String> getKeys()

getProperties

Properties getProperties()

getPropertiesWithPrefix

Properties getPropertiesWithPrefix(String prefix)

aValueIsDefinedFor

boolean aValueIsDefinedFor(Enum<?> property)

aValueIsDefinedFor

boolean aValueIsDefinedFor(String property)

hasPath

boolean hasPath(String path)

injectSystemPropertiesInto

String injectSystemPropertiesInto(String value)

asMap

Map<String,String> asMap()

simpleSystemPropertiesAsMap

Map<String,String> simpleSystemPropertiesAsMap()

reset

void reset()

setConfig

void setConfig(com.typesafe.config.Config typesafeConfig)

getConfig

default com.typesafe.config.Config getConfig(String prefix)

activeEnvironments

default List<String> activeEnvironments()