Module org.tquadrat.foundation.base

Package org.tquadrat.foundation.lang.internal

Class ThreadFactoryBuilderImpl

java.lang.Object

org.tquadrat.foundation.lang.internal.ThreadFactoryBuilderImpl

All Implemented Interfaces:

ThreadFactoryBuilder

@ClassVersion(sourceVersion="$Id: ThreadFactoryBuilderImpl.java 1118 2024-03-15 16:14:15Z tquadrat $")
@API(status=INTERNAL,
     since="0.1.0")
public final class ThreadFactoryBuilderImpl
extends Object
implements ThreadFactoryBuilder

The implementation of ThreadFactoryBuilder.

Author:

Thomas Thrien (thomas.thrien@tquadrat.org)

Version:

$Id: ThreadFactoryBuilderImpl.java 1118 2024-03-15 16:14:15Z tquadrat $

Since:

0.1.0

UML Diagram

⁠

UML Diagram for "org.tquadrat.foundation.lang.internal.ThreadFactoryBuilderImpl"

⁠

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
private static final class	ThreadFactoryBuilderImpl.ThreadFactoryImpl	The implementation of ThreadFactory that is returned by ThreadFactoryBuilder.build().

Field Summary

Fields

Modifier and Type	Field	Description
private ClassLoader	m_ContextClassLoader	The context ClassLoader for the new threads.
private boolean	m_InheritThreadLocals	If true, inherit initial values for inheritable thread-locals from the constructing thread, otherwise no initial values are inherited.
private boolean	m_IsDaemon	true if the new threads are daemon thread, false otherwise.
private boolean	m_IsVirtual	Flag that determines whether this thread factory creates virtual threads.
private IntFunction<String>	m_NameFactory	The factory method for the thread names.
private int	m_Priority	The priority for the new threads.
private long	m_StackSize	The desired stack size for the new threads.
private ThreadGroup	m_ThreadGroup	The thread group for the new threads.
private Thread.UncaughtExceptionHandler	m_UncaughtExceptionHandler	The uncaught exception handler for the new threads.

Constructor Summary

Constructors

Constructor	Description
ThreadFactoryBuilderImpl()	Creates a new instance of ThreadFactoryBuilderImpl.

Method Summary

Modifier and Type	Method	Description
final ThreadFactory	build()	Creates the instance of ThreadFactory.
final ThreadFactoryBuilderImpl	setContextClassLoader(ClassLoader contextClassLoader)	Sets the context class loader for the new threads created by the new thread factory.
final ThreadFactoryBuilderImpl	setDaemon(boolean flag)	Sets the flag whether the new thread created by the new thread factory should be a daemon thread.
final ThreadFactoryBuilderImpl	setInheritThreadLocals(boolean flag)	Sets the flag that controls whether the new threads, created by the new thread factory, will suppress, or not, the inheriting of initial values for inheritable thread-local variables from the constructing thread.
final ThreadFactoryBuilderImpl	setNameFactory(IntFunction<String> nameFactory)	Sets the factory for the name of the threads created by the new thread factory.
final ThreadFactoryBuilderImpl	setPriority(int priority)	Sets the priority for the new threads created by the new thread factory.
final ThreadFactoryBuilderImpl	setStackSize(long stackSize)	Sets the stack size for the new threads created by the new thread factory.
final ThreadFactoryBuilderImpl	setThreadGroup(ThreadGroup threadGroup)	Sets the thread group for the new threads created by the new thread factory.
final ThreadFactoryBuilderImpl	setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler uncaughtExceptionHandler)	Sets the UncaughtExceptionHandler for the new threads created by the new thread factory.
final ThreadFactoryBuilderImpl	setVirtual(boolean flag)	Determines whether the threads generated by this thread factory will be virtual threads.
final String	toString()

Methods inherited from class java.lang.Object

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

Field Details

m_ContextClassLoader

private ClassLoader m_ContextClassLoader

The context ClassLoader for the new threads. The default is null.

m_InheritThreadLocals

private boolean m_InheritThreadLocals

If true, inherit initial values for inheritable thread-locals from the constructing thread, otherwise no initial values are inherited. The default is true.

m_IsDaemon

private boolean m_IsDaemon

true if the new threads are daemon thread, false otherwise. The default is false.

m_IsVirtual

private boolean m_IsVirtual

Flag that determines whether this thread factory creates virtual threads.

Since:

0.4.5

m_NameFactory

private IntFunction<String> m_NameFactory

The factory method for the thread names. The default returns "Thread-#", where "#" stands for a counter.

m_Priority

private int m_Priority

The priority for the new threads. The default value of -1 indicates that no priority will be set explicitly.

m_StackSize

private long m_StackSize

The desired stack size for the new threads. The default value of zero indicates that this parameter is to be ignored.

m_ThreadGroup

private ThreadGroup m_ThreadGroup

The thread group for the new threads. The default is null.

m_UncaughtExceptionHandler

private Thread.UncaughtExceptionHandler m_UncaughtExceptionHandler

The uncaught exception handler for the new threads. The default is null.

Constructor Details

ThreadFactoryBuilderImpl

public ThreadFactoryBuilderImpl()

Creates a new instance of ThreadFactoryBuilderImpl.

Method Details

build

public final ThreadFactory build()

Creates the instance of ThreadFactory.

Specified by:

build in interface ThreadFactoryBuilder

Returns:

The thread factory.

setContextClassLoader

public final ThreadFactoryBuilderImpl setContextClassLoader(ClassLoader contextClassLoader)

Sets the context class loader for the new threads created by the new thread factory.

The context class loader allows the creator of the thread to provide the appropriate class loader, through Thread.getContextClassLoader(), to code running in the thread when loading classes and resources.

If not set, new threads will use the system class loader (or, failing that, the bootstrap class loader).

Specified by:

setContextClassLoader in interface ThreadFactoryBuilder

Parameters:

contextClassLoader - The context classloader.

Returns:

The builder.

See Also:

• Thread.setContextClassLoader(ClassLoader)

setInheritThreadLocals

public final ThreadFactoryBuilderImpl setInheritThreadLocals(boolean flag)

Sets the flag that controls whether the new threads, created by the new thread factory, will suppress, or not, the inheriting of initial values for inheritable thread-local variables from the constructing thread. This allows for finer grain control over inheritable thread-locals. Care must be taken when setting the flag to false, as it may lead to unexpected behavior if the new thread executes code that expects a specific thread-local value to be inherited.

If not set, the value for the new threads will be true.

Specified by:

setInheritThreadLocals in interface ThreadFactoryBuilder

Parameters:

flag - true if the values for inheritable thread locals will be inherited, false to disable this feature.

Returns:

The builder.

See Also:

• Thread(ThreadGroup, Runnable, String, long, boolean)

setDaemon

public final ThreadFactoryBuilderImpl setDaemon(boolean flag)

Sets the flag whether the new thread created by the new thread factory should be a daemon thread. Daemon threads will be aborted automatically when the last non-daemon thread terminates.

If not set, the new threads are not daemon threads.

Specified by:

setDaemon in interface ThreadFactoryBuilder

Parameters:

flag - true if the new threads are daemon threads, false if they are regular threads.

Returns:

The builder.

See Also:

• Thread.isDaemon()
• Thread.setDaemon(boolean)

setNameFactory

public final ThreadFactoryBuilderImpl setNameFactory(IntFunction<String> nameFactory)

Sets the factory for the name of the threads created by the new thread factory.

The name factory method will be call with a numeric argument that is unique for each invocation by the new thread factory; in fact, it is a counter value.

If not set, a name factory is used that returns names looking like this: "Thread-#" where the hash symbol will be replaced by the counter value.

Specified by:

setNameFactory in interface ThreadFactoryBuilder

Parameters:

nameFactory - The name factory.

Returns:

The builder.

setPriority

public final ThreadFactoryBuilderImpl setPriority(int priority)
                                           throws ValidationException

Sets the priority for the new threads created by the new thread factory. Proper values are -1 (to indicate that the priority should not be set explicitly) and numbers between 1 to 10, inclusively.

If not set, the value will be -1.

If the thread factory will not be configured explicitly with a priority, the newly created threads will get their priority set equal to the priority of the thread calling ThreadFactory.newThread(Runnable), creating a new thread. The method Thread.setPriority(int) may be used to change the priority to a new value.

Specified by:

setPriority in interface ThreadFactoryBuilder

Parameters:

priority - The priority value.

Returns:

The builder.

Throws:

ValidationException - The given value is not valid.

See Also:

• Thread.setPriority(int)

setStackSize

public final ThreadFactoryBuilderImpl setStackSize(long stackSize)

Sets the stack size for the new threads created by the new thread factory. The stack size is the approximate number of bytes of address space that the virtual machine is to allocate for the new thread's stack. The effect of the stackSize parameter, if any, is highly platform dependent.

On some platforms, specifying a higher value for the stackSize parameter may allow a thread to achieve greater recursion depth before throwing a StackOverflowError. Similarly, specifying a lower value may allow a greater number of threads to exist concurrently without throwing an OutOfMemoryError (or other internal error). The details of the relationship between the value of the stackSize parameter and the maximum recursion depth and concurrency level are platform-dependent. On some platforms, the value of the stackSize parameter may have no effect whatsoever.

The virtual machine is free to treat the stackSize parameter as a suggestion. If the specified value is unreasonably low for the platform, the virtual machine may instead use some platform-specific minimum value; if the specified value is unreasonably high, the virtual machine may instead use some platform-specific maximum. Likewise, the virtual machine is free to round the specified value up or down as it sees fit (or to ignore it completely).

Specifying a value of zero for the stackSize parameter will cause the new tread factory to not set the stack size for the new threads explicitly.

Specified by:

setStackSize in interface ThreadFactoryBuilder

Parameters:

stackSize - The stack size for the new threads.

Returns:

The builder.

See Also:

• Thread(ThreadGroup, Runnable, String, long, boolean)
• Thread(ThreadGroup, Runnable, String, long)

setThreadGroup

public final ThreadFactoryBuilderImpl setThreadGroup(ThreadGroup threadGroup)

Sets the thread group for the new threads created by the new thread factory.

If no thread group will be specified, the thread group for threads created by the new thread factory is set to the thread group of the thread that called . ThreadFactory.newThread(Runnable).

Specified by:

setThreadGroup in interface ThreadFactoryBuilder

Parameters:

threadGroup - The thread group.

Returns:

The builder.

See Also:

• Thread(ThreadGroup, Runnable, String, long, boolean)
• Thread(ThreadGroup, Runnable, String, long)
• Thread(ThreadGroup, String)
• Thread(ThreadGroup, Runnable)
• Thread(ThreadGroup, Runnable, String)

setUncaughtExceptionHandler

public final ThreadFactoryBuilderImpl setUncaughtExceptionHandler(Thread.UncaughtExceptionHandler uncaughtExceptionHandler)

Sets the UncaughtExceptionHandler for the new threads created by the new thread factory.

No handler will be set if none is specified for the new factory.

Specified by:

setUncaughtExceptionHandler in interface ThreadFactoryBuilder

Parameters:

uncaughtExceptionHandler - The uncaught exception handler.

Returns:

The builder.

See Also:

• Thread.setUncaughtExceptionHandler(UncaughtExceptionHandler)
• Thread.setDefaultUncaughtExceptionHandler(UncaughtExceptionHandler)
• Thread.getUncaughtExceptionHandler()
• Thread.getDefaultUncaughtExceptionHandler()
• ThreadGroup.uncaughtException(Thread, Throwable)

setVirtual

@API(status=INTERNAL,
     since="0.4.5")
public final ThreadFactoryBuilderImpl setVirtual(boolean flag)

Determines whether the threads generated by this thread factory will be virtual threads.

Specified by:

setVirtual in interface ThreadFactoryBuilder

Parameters:

flag - true if the generated threads are virtual, otherwise false.

toString

public final String toString()

Overrides:

toString in class Object