- All Superinterfaces:
Thread.Builder
- Enclosing interface:
Thread.Builder
A builder for creating a platform
Thread
or ThreadFactory
that creates platform threads.
Unless otherwise specified, passing a null argument to a method in
this interface causes a NullPointerException
to be thrown.
- Since:
- 21
- See Also:
-
Nested Class Summary
Nested classes/interfaces declared in interface java.lang.Thread.Builder
Thread.Builder.OfPlatform, Thread.Builder.OfVirtual
-
Method Summary
Modifier and TypeMethodDescriptiondefault Thread.Builder.OfPlatform
daemon()
Sets the daemon status totrue
.daemon
(boolean on) Sets the daemon status.group
(ThreadGroup group) Sets the thread group.inheritInheritableThreadLocals
(boolean inherit) Sets whether the thread inherits the initial values of inheritable-thread-local variables from the constructing thread.Sets the thread name.Sets the thread name to be the concatenation of a string prefix and the string representation of a counter value.priority
(int priority) Sets the thread priority.stackSize
(long stackSize) Sets the desired stack size.Sets the uncaught exception handler.Methods declared in interface java.lang.Thread.Builder
factory, start, unstarted
-
Method Details
-
name
Description copied from interface:Thread.Builder
Sets the thread name.- Specified by:
name
in interfaceThread.Builder
- Parameters:
name
- thread name- Returns:
- this builder
-
name
Description copied from interface:Thread.Builder
Sets the thread name to be the concatenation of a string prefix and the string representation of a counter value. The counter's initial value isstart
. It is incremented after aThread
is created with this builder so that the next thread is named with the new counter value. AThreadFactory
created with this builder is seeded with the current value of the counter. TheThreadFactory
increments its copy of the counter afternewThread
is used to create aThread
.- Specified by:
name
in interfaceThread.Builder
- Parameters:
prefix
- thread name prefixstart
- the starting value of the counter- Returns:
- this builder
- Throws:
IllegalArgumentException
- if start is negative
-
inheritInheritableThreadLocals
Description copied from interface:Thread.Builder
Sets whether the thread inherits the initial values of inheritable-thread-local variables from the constructing thread. The default is to inherit.- Specified by:
inheritInheritableThreadLocals
in interfaceThread.Builder
- Parameters:
inherit
-true
to inherit,false
to not inherit- Returns:
- this builder
-
uncaughtExceptionHandler
Description copied from interface:Thread.Builder
Sets the uncaught exception handler.- Specified by:
uncaughtExceptionHandler
in interfaceThread.Builder
- Parameters:
ueh
- uncaught exception handler- Returns:
- this builder
-
group
Sets the thread group.- Parameters:
group
- the thread group- Returns:
- this builder
-
daemon
Sets the daemon status.- Parameters:
on
-true
to create daemon threads- Returns:
- this builder
-
daemon
Sets the daemon status totrue
.- Implementation Requirements:
- The default implementation invokes daemon(boolean) with
a value of
true
. - Returns:
- this builder
-
priority
Sets the thread priority.- Parameters:
priority
- priority- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the priority is less thanThread.MIN_PRIORITY
or greater thanThread.MAX_PRIORITY
-
stackSize
Sets the desired stack size.The stack size is the approximate number of bytes of address space that the Java virtual machine is to allocate for the thread's stack. The effect is highly platform dependent and the Java virtual machine is free to treat the
stackSize
parameter as a "suggestion". If the value is unreasonably low for the platform then a platform specific minimum may be used. If the value is unreasonably high then a platform specific maximum may be used. A value of zero is always ignored.- Parameters:
stackSize
- the desired stack size- Returns:
- this builder
- Throws:
IllegalArgumentException
- if the stack size is negative
-