Package de.interactive_instruments.etf.client

Interface RunParameters

  • public interface RunParameters
    Parameters for a Test Run

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      RunParameters labelSuffix​(java.lang.String testRunLabelSuffix)
      The client creates its own label for the test run, which is composed of the prefix etf-client, a session ID and a counter for the test runs.
      java.util.Map<java.lang.String,​java.lang.String> map()
      Return the parameters as Map
      java.util.Set<java.lang.String> required()
      The names of the parameters that the client must set
      RunParameters setFrom​(java.lang.String... strings)
      Set the actual Parameters from a String array.
      RunParameters setFrom​(java.util.Collection<java.lang.String> keyValueCollection)
      Set the actual Parameters from a String collection.
      RunParameters setFrom​(java.util.Map<java.lang.String,​java.lang.String> map)
      Set the actual Parameters from a String Map.

    • Method Detail

      • setFrom

        RunParameters setFrom​(java.lang.String... strings)
        Set the actual Parameters from a String array. Values with an even index must reference the parameter name, the following odd index set the corresponding value.
        Parameters:
        strings - String array
        Returns:
        immutable RunParameters object
        Throws:
        java.lang.IllegalArgumentException - if the array has a odd number of values
        ReferenceError - if the referenced Parameter name is unknown

      • setFrom

        RunParameters setFrom​(java.util.Collection<java.lang.String> keyValueCollection)
        Set the actual Parameters from a String collection. Values with an even index must reference the parameter name, the following odd index set the corresponding value.
        Parameters:
        keyValueCollection - String collection
        Returns:
        immutable RunParameters object
        Throws:
        java.lang.IllegalArgumentException - if the array has a odd number of values
        ReferenceError - if the referenced Parameter name is unknown

      • setFrom

        RunParameters setFrom​(java.util.Map<java.lang.String,​java.lang.String> map)
        Set the actual Parameters from a String Map.
        Parameters:
        map - String Map
        Returns:
        immutable RunParameters object
        Throws:
        ReferenceError - if the referenced Parameter name is unknown

      • map

        java.util.Map<java.lang.String,​java.lang.String> map()
        Return the parameters as Map
        Returns:
        immutable String Map

      • required

        java.util.Set<java.lang.String> required()
        The names of the parameters that the client must set
        Returns:
        immutable String Set

      • labelSuffix

        RunParameters labelSuffix​(java.lang.String testRunLabelSuffix)
        The client creates its own label for the test run, which is composed of the prefix etf-client, a session ID and a counter for the test runs. Example: ETF-client 6bb13cdd-6e05-4731-95bf-ba93188b74f9 run 6 . A suffix can be appended to the generated label. A hyphen is automatically added when you set it. It must not be longer than 70 characters. Example: ETF-client 6bb13cdd-6e05-4731-95bf-ba93188b74f9 run 6 - My Test Run .
        Parameters:
        testRunLabelSuffix - the suffix that will be appended to the generated label.
        Returns:
        immutable RunParameters object
        Throws:
        java.lang.IllegalArgumentException - if the String is null/empty or longer than 75 characters