--- old/src/share/classes/java/lang/ThreadLocal.java 2012-12-05 11:23:53.807709963 -0800
+++ new/src/share/classes/java/lang/ThreadLocal.java 2012-12-05 11:23:53.635709971 -0800
@@ -25,19 +25,21 @@
package java.lang;
import java.lang.ref.*;
+import java.util.Objects;
import java.util.concurrent.atomic.AtomicInteger;
+import java.util.function.Supplier;
/**
* This class provides thread-local variables. These variables differ from
* their normal counterparts in that each thread that accesses one (via its
- * get or set method) has its own, independently initialized
- * copy of the variable. ThreadLocal instances are typically private
+ * {@code get} or {@code set} method) has its own, independently initialized
+ * copy of the variable. {@code ThreadLocal} instances are typically private
* static fields in classes that wish to associate state with a thread (e.g.,
* a user ID or Transaction ID).
*
* For example, the class below generates unique identifiers local to each
* thread.
- * A thread's id is assigned the first time it invokes ThreadId.get()
+ * A thread's id is assigned the first time it invokes {@code ThreadId.get()}
* and remains unchanged on subsequent calls.
*
* import java.util.concurrent.atomic.AtomicInteger;
@@ -61,11 +63,20 @@
* }
*
* Each thread holds an implicit reference to its copy of a thread-local
- * variable as long as the thread is alive and the ThreadLocal
+ * variable as long as the thread is alive and the {@code ThreadLocal}
* instance is accessible; after a thread goes away, all of its copies of
* thread-local instances are subject to garbage collection (unless other
* references to these copies exist).
*
+ * The initial value of the variable is set by (1) calling the
+ * {@code initialValue method}, (2) obtaining it from a {@code Supplier}
+ * which has been provided via the
+ * constructor, or (3) by calling the {@code set} method.
+ *
+ * If (1) is used and an initial value other than the default of null is required,
+ * the {@code initialValue} method is typically overridden with an
+ * anonymous-inner class.
+ *
* @author Josh Bloch and Doug Lea
* @since 1.2
*/
@@ -97,6 +108,11 @@
private static final int HASH_INCREMENT = 0x61c88647;
/**
+ * Supplied by the invoker of the constructor to set the initial value
+ */
+ private final Supplier supplier;
+
+ /**
* Returns the next hash code.
*/
private static int nextHashCode() {
@@ -105,19 +121,17 @@
/**
* Returns the current thread's "initial value" for this
- * thread-local variable. This method will be invoked the first
+ * thread-local variable unless a {@code Supplier} has been passed
+ * to the constructor, in which case the Supplier is consulted in
+ * preference to this method. This method will be invoked the first
* time a thread accesses the variable with the {@link #get}
* method, unless the thread previously invoked the {@link #set}
- * method, in which case the initialValue method will not
+ * method, in which case the {@code initialValue} method will not
* be invoked for the thread. Normally, this method is invoked at
* most once per thread, but it may be invoked again in case of
* subsequent invocations of {@link #remove} followed by {@link #get}.
*
- * This implementation simply returns null; if the
- * programmer desires thread-local variables to have an initial
- * value other than null, ThreadLocal must be
- * subclassed, and this method overridden. Typically, an
- * anonymous inner class will be used.
+ *
This implementation simply returns {@code null}
*
* @return the initial value for this thread-local
*/
@@ -126,9 +140,21 @@
}
/**
- * Creates a thread local variable.
+ * Creates a thread local variable. The initial value of the variable is
+ * provided by calling the {@code intialValue} method.
*/
public ThreadLocal() {
+ supplier = null;
+ }
+
+ /**
+ * Creates a thread local variable. The initial value of the variable is
+ * determined by invoking the {@code get} method on the supplier.
+ *
+ * @param supplier the supplier to be used to determine the initial value
+ */
+ public ThreadLocal(Supplier supplier) {
+ this.supplier = Objects.requireNonNull(supplier);
}
/**
@@ -160,7 +186,7 @@
* @return the initial value
*/
private T setInitialValue() {
- T value = initialValue();
+ T value = (supplier != null ? supplier.get() : initialValue());
Thread t = Thread.currentThread();
ThreadLocalMap map = getMap(t);
if (map != null)
@@ -195,7 +221,7 @@
* reinitialized by invoking its {@link #initialValue} method,
* unless its value is {@linkplain #set set} by the current thread
* in the interim. This may result in multiple invocations of the
- * initialValue method in the current thread.
+ * {@code initialValue} method in the current thread.
*
* @since 1.5
*/
@@ -228,7 +254,7 @@
}
/**
- * Factory method to create map of inherited thread locals.
+ * Factory method to create map of inherited thread locals.
* Designed to be called only from Thread constructor.
*
* @param parentMap the map associated with parent thread
@@ -599,9 +625,9 @@
* @param i a position known NOT to hold a stale entry. The
* scan starts at the element after i.
*
- * @param n scan control: log2(n) cells are scanned,
+ * @param n scan control: {@code log2(n)} cells are scanned,
* unless a stale entry is found, in which case
- * log2(table.length)-1 additional cells are scanned.
+ * {@code log2(table.length)-1} additional cells are scanned.
* When called from insertions, this parameter is the number
* of elements, but when from replaceStaleEntry, it is the
* table length. (Note: all this could be changed to be either
--- /dev/null 2012-12-05 10:40:46.603834579 -0800
+++ new/test/java/lang/ThreadLocal/ThreadLocalSupplierTest.java 2012-12-05 11:23:54.479709931 -0800
@@ -0,0 +1,116 @@
+/*
+ * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
+ * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
+ *
+ * This code is free software; you can redistribute it and/or modify it
+ * under the terms of the GNU General Public License version 2 only, as
+ * published by the Free Software Foundation. Oracle designates this
+ * particular file as subject to the "Classpath" exception as provided
+ * by Oracle in the LICENSE file that accompanied this code.
+ *
+ * This code is distributed in the hope that it will be useful, but WITHOUT
+ * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
+ * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
+ * version 2 for more details (a copy is included in the LICENSE file that
+ * accompanied this code).
+ *
+ * You should have received a copy of the GNU General Public License version
+ * 2 along with this work; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
+ *
+ * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
+ * or visit www.oracle.com if you need additional information or have any
+ * questions.
+ */
+
+import java.util.concurrent.atomic.AtomicInteger;
+import java.util.function.Supplier;
+import org.testng.annotations.Test;
+import static org.testng.Assert.*;
+
+/**
+ * @test
+ * @run testng ThreadLocalSupplierTest
+ * @summary tests ThreadLocal. Adapted from java.lang.Basic functional test of ThreadLocal
+ *
+ * @author Jim Gish
+ */
+@Test
+public class ThreadLocalSupplierTest {
+ static IntegerFactory theFactory = new IntegerFactory();
+
+ static class MyThreadLocal extends ThreadLocal {
+ public volatile boolean everCalled;
+
+ public MyThreadLocal( Supplier f ) {
+ super(f);
+ }
+
+ @Override
+ protected synchronized Integer initialValue() {
+ // N.B. this should never be called since we are using the factory
+ // instead
+ everCalled = true;
+ return null;
+ }
+ }
+
+ /**
+ * Our one and only ThreadLocal from which we get thread ids using a
+ * factory which simply increments a counter on each call of make().
+ */
+ static MyThreadLocal threadLocal = new MyThreadLocal(theFactory);
+
+ static class IntegerFactory implements Supplier {
+ private AtomicInteger whatImake = new AtomicInteger(0);
+
+ @Override
+ public Integer get() {
+ return whatImake.getAndIncrement();
+ }
+
+ public int numCalls() {
+ return whatImake.intValue();
+ }
+ }
+
+ public ThreadLocalSupplierTest() {
+ }
+
+ public void test() throws Exception {
+ int threadCount = 500;
+ Thread th[] = new Thread[threadCount];
+ final boolean visited[] = new boolean[threadCount];
+
+ // Create and start the threads
+ for (int i = 0; i < threadCount; i++) {
+ th[i] = new Thread() {
+ @Override
+ public void run() {
+ int threadId = threadLocal.get();
+ assertFalse(visited[threadId], "visited[" + threadId + "]=" + visited[threadId]);
+ visited[threadId] = true;
+ // check the get() again
+ int secondCheckThreadId = threadLocal.get();
+ assertEquals( secondCheckThreadId, threadId );
+ Thread.yield();
+ }
+ };
+ th[i].start();
+ }
+
+ // Wait for the threads to finish
+ for (int i = 0; i < threadCount; i++) {
+ th[i].join();
+ }
+
+ assertEquals(theFactory.numCalls(), threadCount );
+ // make sure the provided initialValue() has not been called
+ assertFalse(threadLocal.everCalled);
+ // Check results
+ for (int i = 0; i < threadCount; i++) {
+ assertTrue(visited[i],"visited[" + i + "]=" + visited[i]);
+ }
+ }
+}
+