Interface DiscoveryIssue

All Known Implementing Classes:

DefaultDiscoveryIssue

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

DiscoveryIssue represents an issue that was encountered during test discovery by a TestEngine.

Since:

1.13

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	DiscoveryIssue.Builder	Builder for creating a DiscoveryIssue.
static enum	DiscoveryIssue.Severity	The severity of a DiscoveryIssue.

Method Summary

Modifier and Type	Method	Description
static DiscoveryIssue.Builder	builder(DiscoveryIssue.Severity severity, String message)	Create a new DiscoveryIssue.Builder for creating a DiscoveryIssue with the supplied DiscoveryIssue.Severity and message.
Optional<Throwable>	cause()	Returns the cause of this issue.
static DiscoveryIssue	create(DiscoveryIssue.Severity severity, String message)	Create a new DiscoveryIssue with the supplied DiscoveryIssue.Severity and message.
String	message()	Returns the message of this issue.
DiscoveryIssue.Severity	severity()	Returns the severity of this issue.
Optional<TestSource>	source()	Returns the source of this issue.
default DiscoveryIssue	withMessage(UnaryOperator<String> messageModifier)	Create a copy of this issue with the modified message produced by the supplied operator.

Method Details

create

static DiscoveryIssue create(DiscoveryIssue.Severity severity,
 String message)

Create a new DiscoveryIssue with the supplied DiscoveryIssue.Severity and message.

Parameters:

severity - the severity of the issue; never null

message - the message of the issue; never blank

See Also:

• builder(Severity, String)

builder

static DiscoveryIssue.Builder builder(DiscoveryIssue.Severity severity,
 String message)

Create a new DiscoveryIssue.Builder for creating a DiscoveryIssue with the supplied DiscoveryIssue.Severity and message.

Parameters:

severity - the severity of the issue; never null

message - the message of the issue; never blank

See Also:

• DiscoveryIssue.Builder
• create(Severity, String)

severity

DiscoveryIssue.Severity severity()

Returns the severity of this issue.

Returns:

the severity of this issue

message

String message()

Returns the message of this issue.

Returns:

the message of this issue

source

Optional<TestSource> source()

Returns the source of this issue.

Returns:

the source of this issue

cause

Optional<Throwable> cause()

Returns the cause of this issue.

Returns:

the cause of this issue

withMessage

default DiscoveryIssue withMessage(UnaryOperator<String> messageModifier)

Create a copy of this issue with the modified message produced by the supplied operator.