JUnit 6.0.1 · org.junit.platform.launcher.core.LauncherExecutionRequestBuilder

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();

Modifier and Type	Field and Description
private @Nullable CancellationToken	cancellationToken
private final @Nullable LauncherDiscoveryRequest	discoveryRequest
private final Collection<TestExecutionListener>	executionListeners
private final @Nullable TestPlan	testPlan

Access	Constructor and Description
private	LauncherExecutionRequestBuilder(@Nullable LauncherDiscoveryRequest discoveryRequest, @Nullable TestPlan testPlan)

Method Summary

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

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

cancellationToken	back to summary
private @Nullable CancellationToken cancellationToken

discoveryRequest	back to summary
private final @Nullable LauncherDiscoveryRequest discoveryRequest

executionListeners	back to summary
private final Collection<TestExecutionListener> executionListeners

testPlan	back to summary
private final @Nullable TestPlan testPlan

Constructor Detail

LauncherExecutionRequestBuilder	back to summary
private LauncherExecutionRequestBuilder(@Nullable LauncherDiscoveryRequest discoveryRequest, @Nullable TestPlan testPlan)

Method Detail

build	back to summary
public LauncherExecutionRequest build() Build the `LauncherExecutionRequest` that has been configured via this builder.

cancellationToken back to summary

cancellationToken	back to summary
public LauncherExecutionRequestBuilder cancellationToken(CancellationToken cancellationToken) Set the cancellation token for the request. Parameters cancellationToken:CancellationToken the `CancellationToken` to use; never `null`. Returns:LauncherExecutionRequestBuilder this builder for method chaining See Also `CancellationToken`

public LauncherExecutionRequestBuilder cancellationToken(CancellationToken cancellationToken)

Set the cancellation token for the request.

Parameters

cancellationToken:CancellationToken: the CancellationToken to use; never null.

Returns:LauncherExecutionRequestBuilder

this builder for method chaining

See Also

CancellationToken

executionRequest back to summary

executionRequest	back to summary
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:LauncherExecutionRequestBuilder a new builder See Also `request(LauncherDiscoveryRequest)`

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:LauncherExecutionRequestBuilder: a new builder
See Also: request(LauncherDiscoveryRequest)

executionRequest back to summary

executionRequest	back to summary
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:LauncherExecutionRequestBuilder a new builder See Also `request(TestPlan)`

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:LauncherExecutionRequestBuilder: a new builder
See Also: request(TestPlan)

listeners back to summary

listeners	back to summary
public LauncherExecutionRequestBuilder listeners(TestExecutionListener... listeners) Add all supplied execution listeners to the request. Parameters listeners:TestExecutionListener[] the `TestExecutionListener` to add; never `null` Returns:LauncherExecutionRequestBuilder this builder for method chaining See Also `TestExecutionListener`

public LauncherExecutionRequestBuilder listeners(TestExecutionListener... listeners)

Add all supplied execution listeners to the request.

Parameters

listeners:TestExecutionListener[]: the TestExecutionListener to add; never null

Returns:LauncherExecutionRequestBuilder

this builder for method chaining

See Also

TestExecutionListener

request back to summary

request	back to summary
public static LauncherExecutionRequestBuilder request(LauncherDiscoveryRequest discoveryRequest) Create a new `LauncherExecutionRequestBuilder` from the supplied `LauncherDiscoveryRequest`. Returns:LauncherExecutionRequestBuilder a new builder See Also `executionRequest(LauncherDiscoveryRequest)`

public static LauncherExecutionRequestBuilder request(LauncherDiscoveryRequest discoveryRequest)

Create a new LauncherExecutionRequestBuilder from the supplied LauncherDiscoveryRequest.

Returns:LauncherExecutionRequestBuilder: a new builder
See Also: executionRequest(LauncherDiscoveryRequest)

request back to summary

request	back to summary
public static LauncherExecutionRequestBuilder request(TestPlan testPlan) Create a new `LauncherExecutionRequestBuilder` from the supplied `TestPlan`. Returns:LauncherExecutionRequestBuilder a new builder See Also `executionRequest(TestPlan)`

public static LauncherExecutionRequestBuilder request(TestPlan testPlan)

Create a new LauncherExecutionRequestBuilder from the supplied TestPlan.

Returns:LauncherExecutionRequestBuilder: a new builder
See Also: executionRequest(TestPlan)

public final Class LauncherExecutionRequestBuilder

Example

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail