io.micronaut.scheduling.executor

Class UserExecutorConfiguration

java.lang.Object

io.micronaut.scheduling.executor.UserExecutorConfiguration

All Implemented Interfaces:

ExecutorConfiguration

@EachProperty(value="micronaut.executors")
public class UserExecutorConfiguration
extends java.lang.Object
implements ExecutorConfiguration

Allows configuration ExecutorService instances that are made available as beans.

Since:

1.0

Author:

Graeme Rocher

Field Summary

Fields

Modifier and Type	Field and Description
static int	AVAILABLE_PROCESSORS Number of available processors.
protected java.lang.String	name
protected java.lang.Integer	nThreads

Fields inherited from interface io.micronaut.scheduling.executor.ExecutorConfiguration

PREFIX, PREFIX_CONSUMER, PREFIX_IO, PREFIX_SCHEDULED

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	UserExecutorConfiguration(java.lang.String name, java.lang.Integer nThreads, ExecutorType type, java.lang.Integer parallelism, java.lang.Integer corePoolSize, java.lang.Class<? extends java.util.concurrent.ThreadFactory> threadFactoryClass) Default Constructor.

Method Summary

Modifier and Type	Method and Description
@Min(value=1L) java.lang.Integer	getCorePoolSize()
java.lang.String	getName()
@Min(value=1L) java.lang.Integer	getNumberOfThreads()
@Min(value=1L) java.lang.Integer	getParallelism()
java.util.Optional<java.lang.Class<? extends java.util.concurrent.ThreadFactory>>	getThreadFactoryClass()
ExecutorType	getType()
static UserExecutorConfiguration	of(ExecutorType type) Construct a UserExecutorConfiguration for the given ExecutorType.
static UserExecutorConfiguration	of(ExecutorType type, int num) Construct a UserExecutorConfiguration for the given ExecutorType.
static UserExecutorConfiguration	of(ExecutorType type, int num, java.lang.Class<? extends java.util.concurrent.ThreadFactory> threadFactoryClass) Construct a UserExecutorConfiguration for the given ExecutorType.
static UserExecutorConfiguration	of(java.lang.String name, ExecutorType type) Construct a UserExecutorConfiguration for the given ExecutorType.
void	setCorePoolSize(java.lang.Integer corePoolSize) Sets the core pool size for ExecutorType.SCHEDULED.
void	setName(java.lang.String name) Sets the executor name.
void	setNumberOfThreads(java.lang.Integer nThreads) Sets the number of threads for ExecutorType.FIXED.
void	setParallelism(java.lang.Integer parallelism) Sets the parallelism for ExecutorType.WORK_STEALING.
void	setThreadFactoryClass(java.lang.Class<? extends java.util.concurrent.ThreadFactory> threadFactoryClass) Sets the thread factory class.
void	setType(ExecutorType type) Sets the executor type.

Methods inherited from class java.lang.Object

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

Field Detail

AVAILABLE_PROCESSORS

public static final int AVAILABLE_PROCESSORS

Number of available processors.

name

protected java.lang.String name

nThreads

protected java.lang.Integer nThreads

Constructor Detail

UserExecutorConfiguration

@Inject
protected UserExecutorConfiguration(@Nullable @Parameter
                                            java.lang.String name,
                                            @Nullable
                                            java.lang.Integer nThreads,
                                            @Nullable
                                            ExecutorType type,
                                            @Nullable
                                            java.lang.Integer parallelism,
                                            @Nullable
                                            java.lang.Integer corePoolSize,
                                            @Nullable
                                            java.lang.Class<? extends java.util.concurrent.ThreadFactory> threadFactoryClass)

Default Constructor.

Parameters:

name - the name

nThreads - number of threads

type - the type

parallelism - the parallelism

corePoolSize - the core pool size

threadFactoryClass - the thread factory class

Method Detail

getName

@NonNull
public java.lang.String getName()

Specified by:

getName in interface ExecutorConfiguration

Returns:

The name of the component

getType

public ExecutorType getType()

Specified by:

getType in interface ExecutorConfiguration

Returns:

The ExecutorType

getParallelism

@Min(value=1L)
public @Min(value=1L) java.lang.Integer getParallelism()

Specified by:

getParallelism in interface ExecutorConfiguration

Returns:

The parallelism for ExecutorType.WORK_STEALING

getNumberOfThreads

@Min(value=1L)
public @Min(value=1L) java.lang.Integer getNumberOfThreads()

Specified by:

getNumberOfThreads in interface ExecutorConfiguration

Returns:

The number of threads for ExecutorType.FIXED

getCorePoolSize

@Min(value=1L)
public @Min(value=1L) java.lang.Integer getCorePoolSize()

Specified by:

getCorePoolSize in interface ExecutorConfiguration

Returns:

The core pool size for ExecutorType.SCHEDULED

getThreadFactoryClass

public java.util.Optional<java.lang.Class<? extends java.util.concurrent.ThreadFactory>> getThreadFactoryClass()

Specified by:

getThreadFactoryClass in interface ExecutorConfiguration

Returns:

The class to use as the ThreadFactory

setName

public void setName(java.lang.String name)

Sets the executor name.

Parameters:

name - The name

setType

public void setType(ExecutorType type)

Sets the executor type. Default value (ExecutorType.SCHEDULED).

Parameters:

type - The type

setParallelism

public void setParallelism(java.lang.Integer parallelism)

Sets the parallelism for ExecutorType.WORK_STEALING. Default value (Number of processors available to the Java virtual machine).

Parameters:

parallelism - The parallelism

setNumberOfThreads

public void setNumberOfThreads(java.lang.Integer nThreads)

Sets the number of threads for ExecutorType.FIXED. Default value (2 * Number of processors available to the Java virtual machine).

Parameters:

nThreads - The number of threads

setCorePoolSize

public void setCorePoolSize(java.lang.Integer corePoolSize)

Sets the core pool size for ExecutorType.SCHEDULED. Default value (2 * Number of processors available to the Java virtual machine).

Parameters:

corePoolSize - The core pool size

setThreadFactoryClass

public void setThreadFactoryClass(java.lang.Class<? extends java.util.concurrent.ThreadFactory> threadFactoryClass)

Sets the thread factory class.

Parameters:

threadFactoryClass - The thread factory class.

of

public static UserExecutorConfiguration of(ExecutorType type)

Construct a UserExecutorConfiguration for the given ExecutorType.

Parameters:

type - The type

Returns:

The configuration

of

public static UserExecutorConfiguration of(java.lang.String name,
                                           ExecutorType type)

Construct a UserExecutorConfiguration for the given ExecutorType.

Parameters:

name - The name

type - The type

Returns:

The configuration

of

public static UserExecutorConfiguration of(ExecutorType type,
                                           int num)

Construct a UserExecutorConfiguration for the given ExecutorType.

Parameters:

type - The type

num - The number of threads for ExecutorType.FIXED or the parallelism for ExecutorType.WORK_STEALING or the core pool size for ExecutorType.SCHEDULED

Returns:

The configuration

of

public static UserExecutorConfiguration of(ExecutorType type,
                                           int num,
                                           @Nullable
                                           java.lang.Class<? extends java.util.concurrent.ThreadFactory> threadFactoryClass)

Construct a UserExecutorConfiguration for the given ExecutorType.

Parameters:

type - The type

num - The number of threads for ExecutorType.FIXED or the parallelism for ExecutorType.WORK_STEALING or the core pool size for ExecutorType.SCHEDULED

threadFactoryClass - The thread factory class

Returns:

The configuration