org.junit.gen5.engine

Class FilterResult

java.lang.Object

org.junit.gen5.engine.FilterResult

@API(value=Experimental)
public class FilterResult
extends java.lang.Object

The result of evaluating a Filter.

Since:

5.0

Method Summary

Modifier and Type	Method and Description
boolean	excluded()
static FilterResult	excluded(java.lang.String reason) Factory for creating excluded results.
java.util.Optional<java.lang.String>	getReason()
boolean	included()
static FilterResult	included(java.lang.String reason) Factory for creating included results.
static FilterResult	includedIf(boolean included) Factory for creating filter results based on the condition given.
static FilterResult	includedIf(boolean included, java.util.function.Supplier<java.lang.String> inclusionReasonSupplier, java.util.function.Supplier<java.lang.String> exclusionReasonSupplier) Factory for creating filter results based on the condition given.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

included

public static FilterResult included(java.lang.String reason)

Factory for creating included results.

Parameters:

reason - the reason why the result was included

Returns:

an included FilterResult with the given reason

excluded

public static FilterResult excluded(java.lang.String reason)

Factory for creating excluded results.

Parameters:

reason - the reason why the result was excluded

Returns:

a excluded FilterResult with the given reason

includedIf

public static FilterResult includedIf(boolean included)

Factory for creating filter results based on the condition given.

Parameters:

included - whether or not the returned FilterResult should be included

Returns:

a valid FilterResult for the given condition

includedIf

public static FilterResult includedIf(boolean included,
                                      java.util.function.Supplier<java.lang.String> inclusionReasonSupplier,
                                      java.util.function.Supplier<java.lang.String> exclusionReasonSupplier)

Factory for creating filter results based on the condition given.

Parameters:

included - whether or not the returned FilterResult should be included

inclusionReasonSupplier - supplier for the reason in case of inclusion

exclusionReasonSupplier - supplier for the reason in case of exclusion

Returns:

a valid FilterResult for the given condition

included

public boolean included()

Returns:

true if the filtered object should be included in the test plan

excluded

public boolean excluded()

Returns:

true if the filtered object should be excluded from the test plan

getReason

public java.util.Optional<java.lang.String> getReason()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object