org.junit.platform.engine.support.hierarchical

Interface Node<C extends EngineExecutionContext>

Type Parameters:

C - the type of EngineExecutionContext used by the HierarchicalTestEngine

All Known Implementing Classes:

ClassTestDescriptor, JupiterEngineDescriptor, JupiterTestDescriptor, MethodTestDescriptor, NestedClassTestDescriptor, TestFactoryTestDescriptor, TestTemplateInvocationTestDescriptor, TestTemplateTestDescriptor

@API(value=Experimental)
public interface Node<C extends EngineExecutionContext>

A node within the execution hierarchy.

Since:

1.0

See Also:

HierarchicalTestEngine

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Node.DynamicTestExecutor Executor for additional, dynamic test descriptors discovered during execution of a Node.
static class	Node.SkipResult The result of determining whether the execution of a given context should be skipped.

Method Summary

Modifier and Type	Method and Description
default void	after(C context) Execute the after behavior of this node.
default C	before(C context) Execute the before behavior of this node.
default C	execute(C context) Deprecated. Please use execute(EngineExecutionContext, DynamicTestExecutor) instead.
default C	execute(C context, Node.DynamicTestExecutor dynamicTestExecutor) Execute the behavior of this node.
default boolean	isLeaf() Determine if this Node is a leaf in the hierarchy.
default C	prepare(C context) Prepare the supplied context prior to execution.
default Node.SkipResult	shouldBeSkipped(C context) Determine if the execution of the supplied context should be skipped.

Method Detail

isLeaf

default boolean isLeaf()

Determine if this Node is a leaf in the hierarchy.

The default implementation returns false.

prepare

default C prepare(C context)
           throws Exception

Prepare the supplied context prior to execution.

The default implementation returns the supplied context unmodified.

Throws:

Exception

shouldBeSkipped

default Node.SkipResult shouldBeSkipped(C context)
                                 throws Exception

Determine if the execution of the supplied context should be skipped.

The default implementation returns Node.SkipResult.doNotSkip().

Throws:

Exception

before

default C before(C context)
          throws Exception

Execute the before behavior of this node.

This method will be called once before execution of this node.

Parameters:

context - the context to execute in

Returns:

the new context to be used for children of this node

Throws:

Exception

See Also:

execute(C, org.junit.platform.engine.support.hierarchical.Node.DynamicTestExecutor), after(C)

execute

default C execute(C context,
                  Node.DynamicTestExecutor dynamicTestExecutor)
           throws Exception

Execute the behavior of this node.

Containers typically do not implement this method since the HierarchicalTestEngine handles execution of their children.

The supplied dynamicTestExecutor may be used to submit additional dynamic tests for immediate execution.

Parameters:

context - the context to execute in

dynamicTestExecutor - the executor to submit dynamic tests to

Returns:

the new context to be used for children of this node and for the after behavior of the parent of this node, if any

Throws:

Exception

See Also:

before(C), after(C)

execute

@Deprecated
default C execute(C context)
                       throws Exception

Deprecated. Please use execute(EngineExecutionContext, DynamicTestExecutor) instead.

Execute the behavior of this node.

Containers typically do not implement this method since the HierarchicalTestEngine handles execution of their children.

Parameters:

context - the context to execute in

Returns:

the new context to be used for children of this node and for the after behavior of the parent of this node, if any

Throws:

Exception

See Also:

before(C), after(C)

after

default void after(C context)
            throws Exception

Execute the after behavior of this node.

This method will be called once after execution of this node.

Parameters:

context - the context to execute in

Throws:

Exception

See Also:

before(C), execute(C, org.junit.platform.engine.support.hierarchical.Node.DynamicTestExecutor)