Class LauncherExecutionRequestBuilder

java.lang.Object

org.junit.platform.launcher.core.LauncherExecutionRequestBuilder

@API(status=MAINTAINED,
     since="6.0")
public final class LauncherExecutionRequestBuilder
extends Object

The LauncherExecutionRequestBuilder provides a light-weight DSL for generating a LauncherExecutionRequest.

Example

import static org.junit.platform.engine.discovery.DiscoverySelectors.selectPackage;
import static org.junit.platform.launcher.core.LauncherDiscoveryRequestBuilder.discoveryRequest;
import static org.junit.platform.launcher.core.LauncherExecutionRequestBuilder.executionRequest;

import org.junit.platform.engine.CancellationToken;
import org.junit.platform.launcher.LauncherDiscoveryRequest;
import org.junit.platform.launcher.LauncherExecutionRequest;
import org.junit.platform.launcher.TestExecutionListener;

TestExecutionListener listener = ...
CancellationToken cancellationToken = CancellationToken.create();

LauncherDiscoveryRequest discoveryRequest = discoveryRequest()
   .selectors(selectPackage("org.example.user"))
   .build();

LauncherExecutionRequest executionRequest = executionRequest(discoveryRequest)
   .listeners(listener)
   .cancellationToken(cancellationToken)
   .build();

Since:

6.0

See Also:

• LauncherExecutionRequest
• LauncherDiscoveryRequestBuilder

Method Summary

Modifier and Type	Method	Description
LauncherExecutionRequest	build()	Build the LauncherExecutionRequest that has been configured via this builder.
LauncherExecutionRequestBuilder	cancellationToken(CancellationToken cancellationToken)	Set the cancellation token for the request.
static LauncherExecutionRequestBuilder	executionRequest(LauncherDiscoveryRequest discoveryRequest)	Create a new LauncherExecutionRequestBuilder from the supplied LauncherDiscoveryRequest.
static LauncherExecutionRequestBuilder	executionRequest(TestPlan testPlan)	Create a new LauncherExecutionRequestBuilder from the supplied TestPlan.
LauncherExecutionRequestBuilder	listeners(TestExecutionListener... listeners)	Add all supplied execution listeners to the request.
static LauncherExecutionRequestBuilder	request(LauncherDiscoveryRequest discoveryRequest)	Create a new LauncherExecutionRequestBuilder from the supplied LauncherDiscoveryRequest.
static LauncherExecutionRequestBuilder	request(TestPlan testPlan)	Create a new LauncherExecutionRequestBuilder from the supplied TestPlan.

Methods inherited from class Object

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

Method Details

request

public static LauncherExecutionRequestBuilder request(LauncherDiscoveryRequest discoveryRequest)

Create a new LauncherExecutionRequestBuilder from the supplied LauncherDiscoveryRequest.

Returns:

a new builder

See Also:

• executionRequest(LauncherDiscoveryRequest)

executionRequest

public static LauncherExecutionRequestBuilder executionRequest(LauncherDiscoveryRequest discoveryRequest)

Create a new LauncherExecutionRequestBuilder from the supplied LauncherDiscoveryRequest.

This method is an alias for request(LauncherDiscoveryRequest) and is intended to be used when statically imported — for example, via: import static org.junit.platform.launcher.core.LauncherExecutionRequestBuilder.executionRequest;

Returns:

a new builder

See Also:

• request(LauncherDiscoveryRequest)

request

public static LauncherExecutionRequestBuilder request(TestPlan testPlan)

Create a new LauncherExecutionRequestBuilder from the supplied TestPlan.

Returns:

a new builder

See Also:

• executionRequest(TestPlan)

executionRequest

public static LauncherExecutionRequestBuilder executionRequest(TestPlan testPlan)

Create a new LauncherExecutionRequestBuilder from the supplied TestPlan.

This method is an alias for request(TestPlan) and is intended to be used when statically imported — for example, via: import static org.junit.platform.launcher.core.LauncherExecutionRequestBuilder.executionRequest;

Returns:

a new builder

See Also:

• request(TestPlan)

listeners

public LauncherExecutionRequestBuilder listeners(TestExecutionListener... listeners)

Add all supplied execution listeners to the request.

Parameters:

listeners - the TestExecutionListener to add; never null

Returns:

this builder for method chaining

See Also:

• TestExecutionListener

cancellationToken

public LauncherExecutionRequestBuilder cancellationToken(CancellationToken cancellationToken)

Set the cancellation token for the request.

Parameters:

cancellationToken - the CancellationToken to use; never null.

Returns:

this builder for method chaining

See Also:

• CancellationToken

build

public LauncherExecutionRequest build()

Build the LauncherExecutionRequest that has been configured via this builder.