third-party/atomix/utils/src/main/java/io/atomix/utils/concurrent/AtomixThread.java

   1 /*
   2  * Copyright 2015-present Open Networking Foundation
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  * http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package io.atomix.utils.concurrent;
  17
  18 import java.lang.ref.WeakReference;
  19
  20 /**
  21  * Atomix thread.
  22  * <p>
  23  * The Atomix thread primarily serves to store a {@link ThreadContext} for the current thread.
  24  * The context is stored in a {@link WeakReference} in order to allow the thread to be garbage collected.
  25  * <p>
  26  * There is no {@link ThreadContext} associated with the thread when it is first created.
  27  * It is the responsibility of thread creators to {@link #setContext(ThreadContext) set} the thread context when appropriate.
  28  *
  29  * @author <a href="http://github.com/kuujo">Jordan Halterman</a>
  30  */
  31 public class AtomixThread extends Thread {
  32   private WeakReference<ThreadContext> context;
  33
  34   public AtomixThread(Runnable target) {
  35     super(target);
  36   }
  37
  38   /**
  39    * Sets the thread context.
  40    *
  41    * @param context The thread context.
  42    */
  43   public void setContext(ThreadContext context) {
  44     this.context = new WeakReference<>(context);
  45   }
  46
  47   /**
  48    * Returns the thread context.
  49    *
  50    * @return The thread {@link ThreadContext} or {@code null} if no context has been configured.
  51    */
  52   public ThreadContext getContext() {
  53     return context != null ? context.get() : null;
  54   }
  55
  56 }