Package org.openhab.core.common

Class ThreadFactoryBuilder

java.lang.Object

org.openhab.core.common.ThreadFactoryBuilder

@NonNullByDefault
public class ThreadFactoryBuilder
extends Object

A builder for ThreadFactory instances. This builder is intended to be used for creating thread factories to be used, e.g., when creating Executors via the Executors utility methods.

The built ThreadFactory uses a wrapped ThreadFactory to create threads (defaulting to Executors.defaultThreadFactory(), and then overwrites thread properties as indicated in the build process.

Author:

Henning Sudbrock - Initial contribution

Method Summary

Modifier and Type	Method	Description
ThreadFactory	build()	Builds the ThreadFactory, configuring it as specified.
static ThreadFactoryBuilder	create()	Creates a fresh ThreadFactoryBuilder.
ThreadFactoryBuilder	withDaemonThreads(boolean daemonThreads)	Sets whether the ThreadFactory will create daemon threads.
ThreadFactoryBuilder	withName(@Nullable String name)	Sets the name to be used by the ThreadFactory.
ThreadFactoryBuilder	withNamePrefix(@Nullable String namePrefix)	Sets the name prefix to be used by the ThreadFactory.
ThreadFactoryBuilder	withPriority(@Nullable Integer priority)	Sets the priority to be set for created threads.
ThreadFactoryBuilder	withUncaughtExceptionHandler(@Nullable Thread.UncaughtExceptionHandler uncaughtExceptionHandler)	Sets the Thread.UncaughtExceptionHandler to be used for created threads.
ThreadFactoryBuilder	withWrappedThreadFactory(@Nullable ThreadFactory wrappedThreadFactory)	Sets the wrapped thread factory used to create threads.

Methods inherited from class java.lang.Object

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

Method Details

create

public static ThreadFactoryBuilder create()

Creates a fresh ThreadFactoryBuilder.

Returns:

A ThreadFactoryBuilder

withWrappedThreadFactory

public ThreadFactoryBuilder withWrappedThreadFactory(@Nullable ThreadFactory wrappedThreadFactory)

Sets the wrapped thread factory used to create threads.

If set to null, Executors.defaultThreadFactory() is used.

Defaults to null.

Parameters:

wrappedThreadFactory - the wrapped thread factory to be used

Returns:

this ThreadFactoryBuilder instance

withName

public ThreadFactoryBuilder withName(@Nullable String name)

Sets the name to be used by the ThreadFactory.

The threads created by the ThreadFactory are named 'namePrefix-name-i', where i is an integer incremented with each new thread, initialized to 1.

If the name is set to null, the created threads are named 'namePrefix-generatedName', where 'generatedName' is the name generated by the wrapped thread factory.

Defaults to null.

Parameters:

name - The name (can be null)

Returns:

this ThreadFactoryBuilder instance

withNamePrefix

public ThreadFactoryBuilder withNamePrefix(@Nullable String namePrefix)

Sets the name prefix to be used by the ThreadFactory.

The threads created by the ThreadFactory are named 'namePrefix-name-i', where i is an integer incremented with each new thread, initialized to 1. If set to null, threads are named 'name-i'.

Defaults to the name prefix 'OH'. Setting a name prefix different than the default one is intended to be used by solutions integrating openHAB.

Parameters:

namePrefix - The name prefix (can be null)

Returns:

this ThreadFactoryBuilder instance

withDaemonThreads

public ThreadFactoryBuilder withDaemonThreads(boolean daemonThreads)

Sets whether the ThreadFactory will create daemon threads. Defaults to false.

Parameters:

daemonThreads - indicates whether daemon threads shall be created

Returns:

this ThreadFactoryBuilder instance

withUncaughtExceptionHandler

public ThreadFactoryBuilder withUncaughtExceptionHandler(@Nullable Thread.UncaughtExceptionHandler uncaughtExceptionHandler)

Sets the Thread.UncaughtExceptionHandler to be used for created threads. If set to null, the built ThreadFactory will not change the handler set by the wrapped ThreadFactory. Defaults to null.

Parameters:

uncaughtExceptionHandler - The Thread.UncaughtExceptionHandler to be use for created threads.

Returns:

this ThreadFactoryBuilder instance

withPriority

public ThreadFactoryBuilder withPriority(@Nullable Integer priority)

Sets the priority to be set for created threads. Must be a valid thread priority, as indicated by Thread.MIN_PRIORITY and Thread.MAX_PRIORITY. If set to null, the built ThreadFactory will not change the priority set by the wrapped ThreadFactory. Defaults to null.

Parameters:

priority - The priority to be used for created threads.

Returns:

this ThreadFactoryBuilder instance

build

public ThreadFactory build()

Builds the ThreadFactory, configuring it as specified.

Returns:

the ThreadFactory