Class FilterResult

java.lang.Object

org.junit.platform.engine.FilterResult

@API(status=STABLE,
     since="1.0")
public class FilterResult
extends Object

The result of applying a Filter.

Since:

1.0

Method Summary

Modifier and Type	Method	Description
boolean	excluded()	Returns true if the filtered object should be excluded.
static FilterResult	excluded(@Nullable String reason)	Factory for creating excluded results.
Optional<String>	getReason()	Get the reason why the filtered object should be included or excluded, if available.
boolean	included()	Returns true if the filtered object should be included.
static FilterResult	included(@Nullable 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, Supplier<@Nullable String> inclusionReasonSupplier, Supplier<@Nullable String> exclusionReasonSupplier)	Factory for creating filter results based on the condition given.
String	toString()

Methods inherited from class Object

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

Method Details

included

public static FilterResult included(@Nullable String reason)

Factory for creating included results.

Parameters:

reason - the reason why the filtered object was included

Returns:

an included FilterResult with the given reason

excluded

public static FilterResult excluded(@Nullable String reason)

Factory for creating excluded results.

Parameters:

reason - the reason why the filtered object was excluded

Returns:

an 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 the filtered object should be included

Returns:

a valid FilterResult for the given condition

includedIf

public static FilterResult includedIf(boolean included,
 Supplier<@Nullable String> inclusionReasonSupplier,
 Supplier<@Nullable String> exclusionReasonSupplier)

Factory for creating filter results based on the condition given.

Parameters:

included - whether the filtered object 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.

Returns:

true if the filtered object should be included

excluded

public boolean excluded()

Returns true if the filtered object should be excluded.

Returns:

true if the filtered object should be excluded

getReason

public Optional<String> getReason()

Get the reason why the filtered object should be included or excluded, if available.

toString

public String toString()

Overrides:

toString in class Object