001/*
002 * Copyright 2002-2018 the original author or authors.
003 *
004 * Licensed under the Apache License, Version 2.0 (the "License");
005 * you may not use this file except in compliance with the License.
006 * You may obtain a copy of the License at
007 *
008 *      https://www.apache.org/licenses/LICENSE-2.0
009 *
010 * Unless required by applicable law or agreed to in writing, software
011 * distributed under the License is distributed on an "AS IS" BASIS,
012 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
013 * See the License for the specific language governing permissions and
014 * limitations under the License.
015 */
016
017package org.springframework.core;
018
019import org.springframework.util.Assert;
020
021/**
022 * {@link InheritableThreadLocal} subclass that exposes a specified name
023 * as {@link #toString()} result (allowing for introspection).
024 *
025 * @author Juergen Hoeller
026 * @since 2.5.2
027 * @param <T> the value type
028 * @see NamedThreadLocal
029 */
030public class NamedInheritableThreadLocal<T> extends InheritableThreadLocal<T> {
031
032        private final String name;
033
034
035        /**
036         * Create a new NamedInheritableThreadLocal with the given name.
037         * @param name a descriptive name for this ThreadLocal
038         */
039        public NamedInheritableThreadLocal(String name) {
040                Assert.hasText(name, "Name must not be empty");
041                this.name = name;
042        }
043
044        @Override
045        public String toString() {
046                return this.name;
047        }
048
049}