util/concurrent/ThreadFactory.java

/*
 * Written by Doug Lea with assistance from members of JCP JSR-166
 * Expert Group and released to the public domain, as explained at
 * http://creativecommons.org/licenses/publicdomain
 */

package java.util.concurrent;

/**
 * An object that creates new threads on demand.  Using thread factories
 * removes hardwiring of calls to {@link Thread#Thread(Runnable) new Thread},
 * enabling applications to use special thread subclasses, priorities, etc.
 *
 * <p>
 * The simplest implementation of this interface is just:
 * <pre>
 * class SimpleThreadFactory implements ThreadFactory {
 *   public Thread newThread(Runnable r) {
 *     return new Thread(r);
 *   }
 * }
 * </pre>
 *
 * The {@link Executors#defaultThreadFactory} method provides a more
 * useful simple implementation, that sets the created thread context
 * to known values before returning it.
 * @since 1.5
 * @author Doug Lea
 */
public interface ThreadFactory {

    /**
     * Constructs a new <tt>Thread</tt>.  Implementations may also initialize
     * priority, name, daemon status, <tt>ThreadGroup</tt>, etc.
     *
     * @param r a runnable to be executed by new thread instance
     * @return constructed thread, or <tt>null</tt> if the request to 
     * create a thread is rejected.
     */
    Thread newThread(Runnable r);
}
Revision:	1.10
Committed:	Sun Jun 25 22:59:45 2006 UTC (17 years, 11 months ago) by dl
Branch:	MAIN
Changes since 1.9:	+2 -1 lines
Log Message:	Clarify null return spec
#	Content
1	/*
2	* Written by Doug Lea with assistance from members of JCP JSR-166
3	* Expert Group and released to the public domain, as explained at
4	* http://creativecommons.org/licenses/publicdomain
5	*/
6
7	package java.util.concurrent;
8
9	/**
10	* An object that creates new threads on demand. Using thread factories
11	* removes hardwiring of calls to {@link Thread#Thread(Runnable) new Thread},
12	* enabling applications to use special thread subclasses, priorities, etc.
13	*
14	* <p>
15	* The simplest implementation of this interface is just:
16	* <pre>
17	* class SimpleThreadFactory implements ThreadFactory {
18	* public Thread newThread(Runnable r) {
19	* return new Thread(r);
20	* }
21	* }
22	* </pre>
23	*
24	* The {@link Executors#defaultThreadFactory} method provides a more
25	* useful simple implementation, that sets the created thread context
26	* to known values before returning it.
27	* @since 1.5
28	* @author Doug Lea
29	*/
30	public interface ThreadFactory {
31
32	/**
33	* Constructs a new <tt>Thread</tt>. Implementations may also initialize
34	* priority, name, daemon status, <tt>ThreadGroup</tt>, etc.
35	*
36	* @param r a runnable to be executed by new thread instance
37	* @return constructed thread, or <tt>null</tt> if the request to
38	* create a thread is rejected.
39	*/
40	Thread newThread(Runnable r);
41	}