JUnit 6.0.1 · org.junit.platform.testkit.engine.Event

Modifier and Type	Field and Description
private final @Nullable Object	payload
private final TestDescriptor	testDescriptor
private final Instant	timestamp
private final EventType	type

Access	Constructor and Description
private	Event(EventType the type of the event; never `null` type, TestDescriptor the `TestDescriptor` associated with the event; never `null` testDescriptor, @Nullable Object the generic payload associated with the event; may be `null` payload) Construct an `Event` with the supplied arguments.

Method Summary

Modifier and Type	Method and Description
public static <T> Predicate<Event>	Returns: the resulting `Predicate` byPayload(Class<T> the required payload type payloadType, Predicate<? super T> a `Predicate` to match against payloads payloadPredicate) Create a `Predicate` for events whose payload types match the supplied `payloadType` and whose payloads match the supplied `payloadPredicate`.
public static Predicate<Event>	Returns: the resulting `Predicate` byTestDescriptor(Predicate<? super TestDescriptor> a `Predicate` to match against test descriptors testDescriptorPredicate) Create a `Predicate` for events whose `TestDescriptors` match the supplied `testDescriptorPredicate`.
public static Predicate<Event>	Returns: the resulting `Predicate` byType(EventType the type to match against type) Create a `Predicate` for events whose event types match the supplied `type`.
public static Event	Returns: the newly created `Event` dynamicTestRegistered(TestDescriptor the `TestDescriptor` associated with the event; never `null` testDescriptor) Create an `Event` for the dynamic registration of the supplied `TestDescriptor`.
public static Event	Returns: the newly created `Event` executionFinished(TestDescriptor the `TestDescriptor` associated with the event; never `null` testDescriptor, TestExecutionResult the `TestExecutionResult` for the supplied `TestDescriptor`; never `null` result) Create a finished `Event` for the supplied `TestDescriptor` and `TestExecutionResult`.
public static Event	Returns: the newly created `Event` executionSkipped(TestDescriptor the `TestDescriptor` associated with the event; never `null` testDescriptor, @Nullable String the reason the execution was skipped; may be `null` reason) Create a skipped `Event` for the supplied `TestDescriptor` and `reason`.
public static Event	Returns: the newly created `Event` executionStarted(TestDescriptor the `TestDescriptor` associated with the event; never `null` testDescriptor) Create a started `Event` for the supplied `TestDescriptor`.
public static Event	Returns: the newly created `Event` fileEntryPublished(TestDescriptor the `TestDescriptor` associated with the event; never `null` testDescriptor, FileEntry the `FileEntry` that was published; never `null` file) Create an `Event` for a published file for the supplied `TestDescriptor` and `FileEntry`.
public Optional<Object>	Returns: an `Optional` containing the payload; never `null` but potentially empty getPayload() Get the payload, if available.
public <T> Optional<T>	Returns: an `Optional` containing the payload; never `null` but potentially empty getPayload(Class<T> the expected payload type; never `null` payloadType) Get the payload of the expected type, if available.
public <T> T	Returns: the payload getRequiredPayload(Class<T> the required payload type; never `null` payloadType) Get the payload of the required type.
public TestDescriptor	Returns: the `TestDescriptor`; never `null` getTestDescriptor() Get the `TestDescriptor` associated with this `Event`.
public Instant	Returns: the `Instant` when this `Event` occurred; never `null` getTimestamp() Get the `Instant` when this `Event` occurred.
public EventType	Returns: the event type; never `null` getType() Get the type of this `Event`.
public static Event	Returns: the newly created `Event` reportingEntryPublished(TestDescriptor the `TestDescriptor` associated with the event; never `null` testDescriptor, ReportEntry the `ReportEntry` that was published; never `null` entry) Create an `Event` for a reporting entry published for the supplied `TestDescriptor` and `ReportEntry`.
public String	toString() Overrides java.lang.Object.toString. Returns a string representation of the object.

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

payload	back to summary
private final @Nullable Object payload

testDescriptor	back to summary
private final TestDescriptor testDescriptor

timestamp	back to summary
private final Instant timestamp

type	back to summary
private final EventType type

Event	back to summary
private Event(EventType type, TestDescriptor testDescriptor, @Nullable Object payload) Construct an `Event` with the supplied arguments. Parameters type:EventType the type of the event; never `null` testDescriptor:TestDescriptor the `TestDescriptor` associated with the event; never `null` payload:@Nullable Object the generic payload associated with the event; may be `null`

Method Detail

byPayload back to summary

byPayload	back to summary
public static <T> Predicate<Event> byPayload(Class<T> payloadType, Predicate<? super T> payloadPredicate) Create a `Predicate` for events whose payload types match the supplied `payloadType` and whose payloads match the supplied `payloadPredicate`. Parameters payloadType:Class<T> the required payload type payloadPredicate:Predicate<? super T> a `Predicate` to match against payloads Returns:Predicate<Event> the resulting `Predicate`

public static <T> Predicate<Event> byPayload(Class<T> payloadType, Predicate<? super T> payloadPredicate)

Create a Predicate for events whose payload types match the supplied payloadType and whose payloads match the supplied payloadPredicate.

Parameters

payloadType:Class<T>: the required payload type
payloadPredicate:Predicate<? super T>: a Predicate to match against payloads

Returns:Predicate<Event>

the resulting Predicate

byTestDescriptor back to summary

byTestDescriptor	back to summary
public static Predicate<Event> byTestDescriptor(Predicate<? super TestDescriptor> testDescriptorPredicate) Create a `Predicate` for events whose `TestDescriptors` match the supplied `testDescriptorPredicate`. Parameters testDescriptorPredicate:Predicate<? super TestDescriptor> a `Predicate` to match against test descriptors Returns:Predicate<Event> the resulting `Predicate`

public static Predicate<Event> byTestDescriptor(Predicate<? super TestDescriptor> testDescriptorPredicate)

Create a Predicate for events whose TestDescriptors match the supplied testDescriptorPredicate.

Parameters

testDescriptorPredicate:Predicate<? super TestDescriptor>: a Predicate to match against test descriptors

Returns:Predicate<Event>

the resulting Predicate

byType back to summary

byType	back to summary
public static Predicate<Event> byType(EventType type) Create a `Predicate` for events whose event types match the supplied `type`. Parameters type:EventType the type to match against Returns:Predicate<Event> the resulting `Predicate`

public static Predicate<Event> byType(EventType type)

Create a Predicate for events whose event types match the supplied type.

Parameters

type:EventType: the type to match against

Returns:Predicate<Event>

the resulting Predicate

dynamicTestRegistered back to summary

dynamicTestRegistered	back to summary
public static Event dynamicTestRegistered(TestDescriptor testDescriptor) Create an `Event` for the dynamic registration of the supplied `TestDescriptor`. Parameters testDescriptor:TestDescriptor the `TestDescriptor` associated with the event; never `null` Returns:Event the newly created `Event` See Also `EventType#DYNAMIC_TEST_REGISTERED`

public static Event dynamicTestRegistered(TestDescriptor testDescriptor)

Create an Event for the dynamic registration of the supplied TestDescriptor.

Parameters

testDescriptor:TestDescriptor: the TestDescriptor associated with the event; never null

Returns:Event

the newly created Event

See Also

EventType#DYNAMIC_TEST_REGISTERED

executionFinished back to summary

executionFinished	back to summary
public static Event executionFinished(TestDescriptor testDescriptor, TestExecutionResult result) Create a finished `Event` for the supplied `TestDescriptor` and `TestExecutionResult`. Parameters testDescriptor:TestDescriptor the `TestDescriptor` associated with the event; never `null` result:TestExecutionResult the `TestExecutionResult` for the supplied `TestDescriptor`; never `null` Returns:Event the newly created `Event` See Also `EventType#FINISHED`

public static Event executionFinished(TestDescriptor testDescriptor, TestExecutionResult result)

Create a finished Event for the supplied TestDescriptor and TestExecutionResult.

Parameters

testDescriptor:TestDescriptor: the TestDescriptor associated with the event; never null
result:TestExecutionResult: the TestExecutionResult for the supplied TestDescriptor; never null

Returns:Event

the newly created Event

See Also

EventType#FINISHED

executionSkipped back to summary

executionSkipped	back to summary
public static Event executionSkipped(TestDescriptor testDescriptor, @Nullable String reason) Create a skipped `Event` for the supplied `TestDescriptor` and `reason`. Parameters testDescriptor:TestDescriptor the `TestDescriptor` associated with the event; never `null` reason:@Nullable String the reason the execution was skipped; may be `null` Returns:Event the newly created `Event` See Also `EventType#SKIPPED`

public static Event executionSkipped(TestDescriptor testDescriptor, @Nullable String reason)

Create a skipped Event for the supplied TestDescriptor and reason.

Parameters

testDescriptor:TestDescriptor: the TestDescriptor associated with the event; never null
reason:@Nullable String: the reason the execution was skipped; may be null

Returns:Event

the newly created Event

See Also

EventType#SKIPPED

executionStarted back to summary

executionStarted	back to summary
public static Event executionStarted(TestDescriptor testDescriptor) Create a started `Event` for the supplied `TestDescriptor`. Parameters testDescriptor:TestDescriptor the `TestDescriptor` associated with the event; never `null` Returns:Event the newly created `Event` See Also `EventType#STARTED`

public static Event executionStarted(TestDescriptor testDescriptor)

Create a started Event for the supplied TestDescriptor.

Parameters

testDescriptor:TestDescriptor: the TestDescriptor associated with the event; never null

Returns:Event

the newly created Event

See Also

EventType#STARTED

fileEntryPublished back to summary

fileEntryPublished	back to summary
public static Event fileEntryPublished(TestDescriptor testDescriptor, FileEntry file) Create an `Event` for a published file for the supplied `TestDescriptor` and `FileEntry`. Parameters testDescriptor:TestDescriptor the `TestDescriptor` associated with the event; never `null` file:FileEntry the `FileEntry` that was published; never `null` Returns:Event the newly created `Event` Annotations @API status:MAINTAINED since:1.13.3 Since 1.12 See Also `EventType#FILE_ENTRY_PUBLISHED`

public static Event fileEntryPublished(TestDescriptor testDescriptor, FileEntry file)

Create an Event for a published file for the supplied TestDescriptor and FileEntry.

Parameters

testDescriptor:TestDescriptor: the TestDescriptor associated with the event; never null
file:FileEntry: the FileEntry that was published; never null

Returns:Event

the newly created Event

Annotations

@API
status:MAINTAINED
since:1.13.3

Since

1.12

See Also

EventType#FILE_ENTRY_PUBLISHED

getPayload back to summary

getPayload	back to summary
public Optional<Object> getPayload() Get the payload, if available. Returns:Optional<Object> an `Optional` containing the payload; never `null` but potentially empty See Also `getPayload(Class)`, `getRequiredPayload(Class)`

public Optional<Object> getPayload()

Get the payload, if available.

Returns:Optional<Object>: an Optional containing the payload; never null but potentially empty
See Also: getPayload(Class), getRequiredPayload(Class)

getPayload back to summary

getPayload	back to summary
public <T> Optional<T> getPayload(Class<T> payloadType) Get the payload of the expected type, if available. This is a convenience method that automatically casts the payload to the expected type. If the payload is not present or is not of the expected type, this method will return `Optional#empty()`. Parameters payloadType:Class<T> the expected payload type; never `null` Returns:Optional<T> an `Optional` containing the payload; never `null` but potentially empty See Also `getPayload()`, `getRequiredPayload(Class)`

public <T> Optional<T> getPayload(Class<T> payloadType)

Get the payload of the expected type, if available.

This is a convenience method that automatically casts the payload to the expected type. If the payload is not present or is not of the expected type, this method will return Optional#empty().

Parameters

payloadType:Class<T>: the expected payload type; never null

Returns:Optional<T>

an Optional containing the payload; never null but potentially empty

getRequiredPayload back to summary

getRequiredPayload	back to summary
public <T> T getRequiredPayload(Class<T> payloadType) throws IllegalArgumentException Get the payload of the required type. This is a convenience method that automatically casts the payload to the required type. If the payload is not present or is not of the expected type, this method will throw an `IllegalArgumentException`. Parameters payloadType:Class<T> the required payload type; never `null` Returns:T the payload Exceptions IllegalArgumentException: if the payload is of a different type or is not present See Also `getPayload()`, `getPayload(Class)`

public <T> T getRequiredPayload(Class<T> payloadType) throws IllegalArgumentException

Get the payload of the required type.

This is a convenience method that automatically casts the payload to the required type. If the payload is not present or is not of the expected type, this method will throw an IllegalArgumentException.

Parameters

payloadType:Class<T>: the required payload type; never null

Returns:T

the payload

Exceptions

IllegalArgumentException:: if the payload is of a different type or is not present

See Also

getPayload(), getPayload(Class)

getTestDescriptor back to summary

getTestDescriptor	back to summary
public TestDescriptor getTestDescriptor() Get the `TestDescriptor` associated with this `Event`. Returns:TestDescriptor the `TestDescriptor`; never `null`

public TestDescriptor getTestDescriptor()

Get the TestDescriptor associated with this Event.

Returns:TestDescriptor: the TestDescriptor; never null

getTimestamp back to summary

getTimestamp	back to summary
public Instant getTimestamp() Get the `Instant` when this `Event` occurred. Returns:Instant the `Instant` when this `Event` occurred; never `null`

public Instant getTimestamp()

Get the Instant when this Event occurred.

Returns:Instant: the Instant when this Event occurred; never null

getType back to summary

getType	back to summary
public EventType getType() Get the type of this `Event`. Returns:EventType the event type; never `null` See Also `EventType`

public EventType getType()

Get the type of this Event.

Returns:EventType: the event type; never null
See Also: EventType

reportingEntryPublished back to summary

reportingEntryPublished	back to summary
public static Event reportingEntryPublished(TestDescriptor testDescriptor, ReportEntry entry) Create an `Event` for a reporting entry published for the supplied `TestDescriptor` and `ReportEntry`. Parameters testDescriptor:TestDescriptor the `TestDescriptor` associated with the event; never `null` entry:ReportEntry the `ReportEntry` that was published; never `null` Returns:Event the newly created `Event` See Also `EventType#REPORTING_ENTRY_PUBLISHED`

public static Event reportingEntryPublished(TestDescriptor testDescriptor, ReportEntry entry)

Create an Event for a reporting entry published for the supplied TestDescriptor and ReportEntry.

Parameters

testDescriptor:TestDescriptor: the TestDescriptor associated with the event; never null
entry:ReportEntry: the ReportEntry that was published; never null

Returns:Event

the newly created Event

See Also

EventType#REPORTING_ENTRY_PUBLISHED

toString back to summary

toString	back to summary
public String toString() Overrides java.lang.Object.toString. Doc from java.lang.Object.toString. Returns a string representation of the object. Satisfying this method's contract implies a non-`null` result must be returned. Annotations @Override

public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations

@Override

public Class Event

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail