io.servicetalk.concurrent.api

Class ExecutorRule<E extends Executor>

java.lang.Object

org.junit.rules.ExternalResource

io.servicetalk.concurrent.api.ExecutorRule<E>

Type Parameters:

E - The type of Executor.

All Implemented Interfaces:

org.junit.rules.TestRule

public final class ExecutorRule<E extends Executor>
extends org.junit.rules.ExternalResource

An ExternalResource wrapper for an Executor.

Method Summary

Modifier and Type	Method and Description
protected void	after()
protected void	before()
E	executor() Returns Executor created on the last call to before().
static ExecutorRule<Executor>	newRule() Create an ExecutorRule with a default executor.
static ExecutorRule<Executor>	withExecutor(java.util.function.Supplier<Executor> executorSupplier) Create an ExecutorRule with the specified executor.
static ExecutorRule<Executor>	withNamePrefix(java.lang.String namePrefix) Create an ExecutorRule with a default executor, configured to prefix thread names with namePrefix.
static ExecutorRule<TestExecutor>	withTestExecutor() Create an ExecutorRule with a TestExecutor.

Methods inherited from class org.junit.rules.ExternalResource

apply

Methods inherited from class java.lang.Object

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

Method Detail

newRule

public static ExecutorRule<Executor> newRule()

Create an ExecutorRule with a default executor.

Returns:

a new ExecutorRule.

withTestExecutor

public static ExecutorRule<TestExecutor> withTestExecutor()

Create an ExecutorRule with a TestExecutor.

executor() will return the TestExecutor to allow controlling the executor in tests.

Returns:

a new ExecutorRule.

withExecutor

public static ExecutorRule<Executor> withExecutor(java.util.function.Supplier<Executor> executorSupplier)

Create an ExecutorRule with the specified executor.

Parameters:

executorSupplier - The Executor Supplier to use.

Returns:

a new ExecutorRule.

withNamePrefix

public static ExecutorRule<Executor> withNamePrefix(java.lang.String namePrefix)

Create an ExecutorRule with a default executor, configured to prefix thread names with namePrefix.

Parameters:

namePrefix - the name to prefix thread names with.

Returns:

a new ExecutorRule.

executor

public E executor()

Returns Executor created on the last call to before().

Returns:

Executor created on the last call to before(). null if before() has not been called yet.

before

protected void before()

Overrides:

before in class org.junit.rules.ExternalResource

after

protected void after()

Overrides:

after in class org.junit.rules.ExternalResource