Class ThreadFactoryBuilder

java.lang.Object

com.google.common.util.concurrent.ThreadFactoryBuilder

@GwtIncompatible
public final class ThreadFactoryBuilder
extends Object

A ThreadFactory builder, providing any combination of these features:

• whether threads should be marked as daemon threads
• a naming format
• a thread priority
• an uncaught exception handler
• a backing thread factory

If no backing thread factory is provided, a default backing thread factory is used as if by calling setThreadFactory(Executors.defaultThreadFactory()).

Java 21+ users: consider using the Thread.Builder interface instead. E.g., instead of new ThreadFactoryBuilder().setPriority(priority).setDaemon(false).build(), use Thread.ofPlatform().priority(priority).daemon(false).factory().

Since:

4.0

Author:

Kurt Alfred Kluever

Constructor Summary

Constructors

Constructor	Description
ThreadFactoryBuilder()	Creates a new ThreadFactory builder.

Method Summary

Modifier and Type	Method	Description
ThreadFactory	build()	Returns a new thread factory using the options supplied during the building process.
ThreadFactoryBuilder	setDaemon(boolean daemon)	Sets daemon or not for new threads created with this ThreadFactory.
ThreadFactoryBuilder	setNameFormat(String nameFormat)	Sets the naming format to use when naming threads (Thread.setName(java.lang.String)) which are created with this ThreadFactory.
ThreadFactoryBuilder	setPriority(int priority)	Sets the priority for new threads created with this ThreadFactory.
ThreadFactoryBuilder	setThreadFactory(ThreadFactory backingThreadFactory)	Sets the backing ThreadFactory for new threads created with this ThreadFactory.
ThreadFactoryBuilder	setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler uncaughtExceptionHandler)	Sets the Thread.UncaughtExceptionHandler for new threads created with this ThreadFactory.

Methods inherited from class java.lang.Object

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

Constructor Details

ThreadFactoryBuilder

public ThreadFactoryBuilder()

Creates a new ThreadFactory builder.

Java 21+ users: use Thread.ofPlatform() instead, translating other calls on the builder as documented on each method (except for the rarely used setThreadFactory(java.util.concurrent.ThreadFactory), which does not have an equivalent).

Method Details

setNameFormat

@CanIgnoreReturnValue
public ThreadFactoryBuilder setNameFormat(String nameFormat)

Sets the naming format to use when naming threads (Thread.setName(java.lang.String)) which are created with this ThreadFactory.

Java 21+ users: use Thread.Builder.name(String, long) instead. Note that setNameFormat(java.lang.String) accepts a thread name format string (e.g., threadFactoryBuilder.setNameFormat("rpc-pool-%d")), while threadBuilder.name() accepts a thread name prefix and initial counter value (e.g., threadBuilder.name("rpc-pool-", 0).

Parameters:

nameFormat - a String.format(String, Object...)-compatible format String, to which a unique integer (0, 1, etc.) will be supplied as the single parameter. This integer will be unique to the built instance of the ThreadFactory and will be assigned sequentially. For example, "rpc-pool-%d" will generate thread names like "rpc-pool-0", "rpc-pool-1", "rpc-pool-2", etc.

Returns:

this for the builder pattern

setDaemon

@CanIgnoreReturnValue
public ThreadFactoryBuilder setDaemon(boolean daemon)

Sets daemon or not for new threads created with this ThreadFactory.

Java 21+ users: use Thread.Builder.OfPlatform.daemon(boolean) instead.

Parameters:

daemon - whether or not new Threads created with this ThreadFactory will be daemon threads

Returns:

this for the builder pattern

setPriority

@CanIgnoreReturnValue
public ThreadFactoryBuilder setPriority(int priority)

Sets the priority for new threads created with this ThreadFactory.

Warning: relying on the thread scheduler is discouraged.

Java 21+ users: use Thread.Builder.OfPlatform.priority(int) instead.

Parameters:

priority - the priority for new Threads created with this ThreadFactory

Returns:

this for the builder pattern

setUncaughtExceptionHandler

@CanIgnoreReturnValue
public ThreadFactoryBuilder setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler uncaughtExceptionHandler)

Sets the Thread.UncaughtExceptionHandler for new threads created with this ThreadFactory.

Java 21+ users: use Thread.Builder.uncaughtExceptionHandler(Thread.UncaughtExceptionHandler) instead.

Parameters:

uncaughtExceptionHandler - the uncaught exception handler for new Threads created with this ThreadFactory

Returns:

this for the builder pattern

setThreadFactory

@CanIgnoreReturnValue
public ThreadFactoryBuilder setThreadFactory(ThreadFactory backingThreadFactory)

Sets the backing ThreadFactory for new threads created with this ThreadFactory. Threads will be created by invoking #newThread(Runnable) on this backing ThreadFactory.

Parameters:

backingThreadFactory - the backing ThreadFactory which will be delegated to during thread creation.

Returns:

this for the builder pattern

See Also:

• MoreExecutors

build

public ThreadFactory build()

Returns a new thread factory using the options supplied during the building process. After building, it is still possible to change the options used to build the ThreadFactory and/or build again. State is not shared amongst built instances.

Java 21+ users: use Thread.Builder.factory() instead.

Returns:

the fully constructed ThreadFactory