Module org.junit.platform.engine

Package org.junit.platform.engine.support.discovery

Interface DiscoveryIssueReporter

@API(status=MAINTAINED,
     since="1.13.3")
public interface DiscoveryIssueReporter

DiscoveryIssueReporter defines the API for reporting DiscoveryIssues.

This interface is not intended to be implemented by clients.

Since:

1.13

See Also:

• SelectorResolver.Context

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DiscoveryIssueReporter.Condition<T>	A Condition is a union of Predicate and Consumer.

Method Summary

Modifier and Type	Method	Description
static DiscoveryIssueReporter	collecting(Collection<? super DiscoveryIssue> collection)	Create a new DiscoveryIssueReporter that adds reported issues to the supplied collection.
static DiscoveryIssueReporter	consuming(Consumer<? super DiscoveryIssue> consumer)	Create a new DiscoveryIssueReporter that adds reported issues to the supplied consumer.
default <T> DiscoveryIssueReporter.Condition<T>	createReportingCondition(Predicate<T> predicate, Function<T,DiscoveryIssue> issueCreator)	Create a DiscoveryIssueReporter.Condition that reports a DiscoveryIssue when the supplied Predicate is not met.
static DiscoveryIssueReporter	deduplicating(DiscoveryIssueReporter delegate)	Create a new DiscoveryIssueReporter that avoids reporting duplicate issues.
static DiscoveryIssueReporter	forwarding(EngineDiscoveryListener engineDiscoveryListener, UniqueId engineId)	Create a new DiscoveryIssueReporter that reports issues to the supplied EngineDiscoveryListener for the specified engine.
void	reportIssue(DiscoveryIssue issue)	Report the supplied DiscoveryIssue.
default void	reportIssue(DiscoveryIssue.Builder builder)	Build the supplied Builder and report the resulting DiscoveryIssue.

Method Details

forwarding

static DiscoveryIssueReporter forwarding(EngineDiscoveryListener engineDiscoveryListener,
 UniqueId engineId)

Create a new DiscoveryIssueReporter that reports issues to the supplied EngineDiscoveryListener for the specified engine.

Parameters:

engineDiscoveryListener - the listener to report issues to; never null

engineId - the unique identifier of the engine; never null

collecting

static DiscoveryIssueReporter collecting(Collection<? super DiscoveryIssue> collection)

Create a new DiscoveryIssueReporter that adds reported issues to the supplied collection.

Parameters:

collection - the collection to add issues to; never null

consuming

static DiscoveryIssueReporter consuming(Consumer<? super DiscoveryIssue> consumer)

Create a new DiscoveryIssueReporter that adds reported issues to the supplied consumer.

Parameters:

consumer - the consumer to report issues to; never null

deduplicating

static DiscoveryIssueReporter deduplicating(DiscoveryIssueReporter delegate)

Create a new DiscoveryIssueReporter that avoids reporting duplicate issues.

The implementation returned by this method is not thread-safe.

Parameters:

delegate - the delegate to forward issues to; never null

reportIssue

default void reportIssue(DiscoveryIssue.Builder builder)

Build the supplied Builder and report the resulting DiscoveryIssue.

reportIssue

void reportIssue(DiscoveryIssue issue)

Report the supplied DiscoveryIssue.

createReportingCondition

default <T> DiscoveryIssueReporter.Condition<T> createReportingCondition(Predicate<T> predicate,
 Function<T,DiscoveryIssue> issueCreator)

Create a DiscoveryIssueReporter.Condition that reports a DiscoveryIssue when the supplied Predicate is not met.

Parameters:

predicate - the predicate to test; never null

issueCreator - the function to create the issue with; never null

Returns:

a new Condition; never null