blob: 26c0572c9d40278f8cfaf7ac4495369ec8828fdf [file] [log] [blame]
J. Duke319a3b92007-12-01 00:00:00 +00001/*
2 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
3 *
4 * This code is free software; you can redistribute it and/or modify it
5 * under the terms of the GNU General Public License version 2 only, as
6 * published by the Free Software Foundation. Sun designates this
7 * particular file as subject to the "Classpath" exception as provided
8 * by Sun in the LICENSE file that accompanied this code.
9 *
10 * This code is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
13 * version 2 for more details (a copy is included in the LICENSE file that
14 * accompanied this code).
15 *
16 * You should have received a copy of the GNU General Public License version
17 * 2 along with this work; if not, write to the Free Software Foundation,
18 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
19 *
20 * Please contact Sun Microsystems, Inc., 4150 Network Circle, Santa Clara,
21 * CA 95054 USA or visit www.sun.com if you need additional information or
22 * have any questions.
23 */
24
25/*
26 * This file is available under and governed by the GNU General Public
27 * License version 2 only, as published by the Free Software Foundation.
28 * However, the following notice accompanied the original version of this
29 * file:
30 *
31 * Written by Doug Lea with assistance from members of JCP JSR-166
32 * Expert Group and released to the public domain, as explained at
33 * http://creativecommons.org/licenses/publicdomain
34 */
35
36package java.util.concurrent;
37
38/**
39 * An object that creates new threads on demand. Using thread factories
40 * removes hardwiring of calls to {@link Thread#Thread(Runnable) new Thread},
41 * enabling applications to use special thread subclasses, priorities, etc.
42 *
43 * <p>
44 * The simplest implementation of this interface is just:
45 * <pre>
46 * class SimpleThreadFactory implements ThreadFactory {
47 * public Thread newThread(Runnable r) {
48 * return new Thread(r);
49 * }
50 * }
51 * </pre>
52 *
53 * The {@link Executors#defaultThreadFactory} method provides a more
54 * useful simple implementation, that sets the created thread context
55 * to known values before returning it.
56 * @since 1.5
57 * @author Doug Lea
58 */
59public interface ThreadFactory {
60
61 /**
62 * Constructs a new {@code Thread}. Implementations may also initialize
63 * priority, name, daemon status, {@code ThreadGroup}, etc.
64 *
65 * @param r a runnable to be executed by new thread instance
66 * @return constructed thread, or {@code null} if the request to
67 * create a thread is rejected
68 */
69 Thread newThread(Runnable r);
70}