Package 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 Description
    java.util.Map<java.lang.String,​java.lang.String> asMap()  
    boolean aValueIsDefinedFor​(java.lang.Enum<?> property)  
    boolean aValueIsDefinedFor​(java.lang.String property)  
    void clearProperty​(java.lang.String name)  
    EnvironmentVariables copy()  
    java.util.List<java.lang.String> getKeys()  
    java.util.Properties getProperties()  
    java.util.Properties getPropertiesWithPrefix​(java.lang.String prefix)  
    java.lang.String getProperty​(java.lang.Enum<?> property)  
    java.lang.String getProperty​(java.lang.Enum<?> property, java.lang.String defaultValue)  
    java.lang.String getProperty​(java.lang.String name)  
    java.lang.String getProperty​(java.lang.String name, java.lang.String defaultValue)  
    java.lang.Boolean getPropertyAsBoolean​(java.lang.Enum<?> property, boolean defaultValue)  
    java.lang.Boolean getPropertyAsBoolean​(java.lang.String name, boolean defaultValue)  
    java.lang.Integer getPropertyAsInteger​(java.lang.Enum<?> property, java.lang.Integer defaultValue)  
    java.lang.Integer getPropertyAsInteger​(java.lang.String name, java.lang.Integer defaultValue)  
    java.lang.String getValue​(java.lang.Enum<?> property)  
    java.lang.String getValue​(java.lang.Enum<?> property, java.lang.String defaultValue)  
    java.lang.String getValue​(java.lang.String name)  
    java.lang.String getValue​(java.lang.String name, java.lang.String defaultValue)  
    java.lang.String injectSystemPropertiesInto​(java.lang.String value)  
    java.util.Optional<java.lang.String> optionalProperty​(java.lang.String name)
    Returns an optional system property.
    void setProperties​(java.util.Map<java.lang.String,​java.lang.String> properties)  
    void setProperty​(java.lang.String name, java.lang.String value)  
    java.util.Map<java.lang.String,​java.lang.String> simpleSystemPropertiesAsMap()  

  • Method Details

    • getValue

      java.lang.String getValue​(java.lang.String name)

    • getValue

      java.lang.String getValue​(java.lang.Enum<?> property)

    • getValue

      java.lang.String getValue​(java.lang.String name, java.lang.String defaultValue)

    • getValue

      java.lang.String getValue​(java.lang.Enum<?> property, java.lang.String defaultValue)

    • getPropertyAsInteger

      java.lang.Integer getPropertyAsInteger​(java.lang.String name, java.lang.Integer defaultValue)

    • getPropertyAsInteger

      java.lang.Integer getPropertyAsInteger​(java.lang.Enum<?> property, java.lang.Integer defaultValue)

    • getPropertyAsBoolean

      java.lang.Boolean getPropertyAsBoolean​(java.lang.String name, boolean defaultValue)

    • getPropertyAsBoolean

      java.lang.Boolean getPropertyAsBoolean​(java.lang.Enum<?> property, boolean defaultValue)

    • getProperty

      java.lang.String getProperty​(java.lang.String name)

    • optionalProperty

      java.util.Optional<java.lang.String> optionalProperty​(java.lang.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

      java.lang.String getProperty​(java.lang.Enum<?> property)

    • getProperty

      java.lang.String getProperty​(java.lang.String name, java.lang.String defaultValue)

    • getProperty

      java.lang.String getProperty​(java.lang.Enum<?> property, java.lang.String defaultValue)

    • setProperty

      void setProperty​(java.lang.String name, java.lang.String value)

    • setProperties

      void setProperties​(java.util.Map<java.lang.String,​java.lang.String> properties)

    • clearProperty

      void clearProperty​(java.lang.String name)

    • copy

      EnvironmentVariables copy()

    • getKeys

      java.util.List<java.lang.String> getKeys()

    • getProperties

      java.util.Properties getProperties()

    • getPropertiesWithPrefix

      java.util.Properties getPropertiesWithPrefix​(java.lang.String prefix)

    • aValueIsDefinedFor

      boolean aValueIsDefinedFor​(java.lang.Enum<?> property)

    • aValueIsDefinedFor

      boolean aValueIsDefinedFor​(java.lang.String property)

    • injectSystemPropertiesInto

      java.lang.String injectSystemPropertiesInto​(java.lang.String value)

    • asMap

      java.util.Map<java.lang.String,​java.lang.String> asMap()

    • simpleSystemPropertiesAsMap

      java.util.Map<java.lang.String,​java.lang.String> simpleSystemPropertiesAsMap()