Interface LauncherConfig


@API(status=STABLE,
     since="1.7")
public interface LauncherConfig
LauncherConfig defines the configuration API for creating Launcher instances via the LauncherFactory.

Example

 LauncherConfig launcherConfig = LauncherConfig.builder()
   .enableTestEngineAutoRegistration(false)
   .enableTestExecutionListenerAutoRegistration(false)
   .addTestEngines(new CustomTestEngine())
   .addTestExecutionListeners(new CustomTestExecutionListener())
   .build();

 Launcher launcher = LauncherFactory.create(launcherConfig);
 LauncherDiscoveryRequest discoveryRequest = ...
 launcher.execute(discoveryRequest);
 
Since:
1.3
See Also:
builder(), Launcher, LauncherFactory
  • Field Details

    • DEFAULT

      static final LauncherConfig DEFAULT
      The default LauncherConfig which uses automatic registration for test engines, supported listeners, and post-discovery filters.
  • Method Details

    • isTestEngineAutoRegistrationEnabled

      boolean isTestEngineAutoRegistrationEnabled()
      Determine if test engines should be discovered at runtime using the ServiceLoader mechanism and automatically registered.
      Returns:
      true if test engines should be automatically registered
    • isLauncherSessionListenerAutoRegistrationEnabled

      @API(status=EXPERIMENTAL, since="1.8") boolean isLauncherSessionListenerAutoRegistrationEnabled()
      Determine if launcher session listeners should be discovered at runtime using the ServiceLoader mechanism and automatically registered.
      Returns:
      true if launcher session listeners should be automatically registered
      Since:
      1.8
    • isLauncherDiscoveryListenerAutoRegistrationEnabled

      @API(status=EXPERIMENTAL, since="1.8") boolean isLauncherDiscoveryListenerAutoRegistrationEnabled()
      Determine if launcher discovery listeners should be discovered at runtime using the ServiceLoader mechanism and automatically registered.
      Returns:
      true if launcher discovery listeners should be automatically registered
      Since:
      1.8
    • isTestExecutionListenerAutoRegistrationEnabled

      boolean isTestExecutionListenerAutoRegistrationEnabled()
      Determine if test execution listeners should be discovered at runtime using the ServiceLoader mechanism and automatically registered.
      Returns:
      true if test execution listeners should be automatically registered
    • isPostDiscoveryFilterAutoRegistrationEnabled

      @API(status=EXPERIMENTAL, since="1.7") boolean isPostDiscoveryFilterAutoRegistrationEnabled()
      Determine if post discovery filters should be discovered at runtime using the ServiceLoader mechanism and automatically registered.
      Returns:
      true if post discovery filters should be automatically registered
      Since:
      1.7
    • getAdditionalTestEngines

      Collection<TestEngine> getAdditionalTestEngines()
      Get the collection of additional test engines that should be added to the Launcher.
      Returns:
      the collection of additional test engines; never null but potentially empty
    • getAdditionalLauncherSessionListeners

      @API(status=EXPERIMENTAL, since="1.8") Collection<LauncherSessionListener> getAdditionalLauncherSessionListeners()
      Get the collection of additional launcher session listeners that should be added to the Launcher.
      Returns:
      the collection of additional launcher session listeners; never null but potentially empty
      Since:
      1.8
    • getAdditionalLauncherDiscoveryListeners

      @API(status=EXPERIMENTAL, since="1.8") Collection<LauncherDiscoveryListener> getAdditionalLauncherDiscoveryListeners()
      Get the collection of additional launcher discovery listeners that should be added to the Launcher.
      Returns:
      the collection of additional launcher discovery listeners; never null but potentially empty
      Since:
      1.8
    • getAdditionalTestExecutionListeners

      Collection<TestExecutionListener> getAdditionalTestExecutionListeners()
      Get the collection of additional test execution listeners that should be added to the Launcher.
      Returns:
      the collection of additional test execution listeners; never null but potentially empty
    • getAdditionalPostDiscoveryFilters

      @API(status=EXPERIMENTAL, since="1.7") Collection<PostDiscoveryFilter> getAdditionalPostDiscoveryFilters()
      Get the collection of additional post discovery filters that should be added to the Launcher.
      Returns:
      the collection of additional post discovery filters; never null but potentially empty
      Since:
      1.7
    • builder

      static LauncherConfig.Builder builder()
      Returns:
      a new builder; never null