com.palantir.common.concurrent.ThreadNamingCallable Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of commons-api Show documentation

Palantir open source project

There is a newer version: 0.1152.0

/*
 * (c) Copyright 2018 Palantir Technologies Inc. All rights reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package com.palantir.common.concurrent;

import java.util.concurrent.Callable;

/**
 * Whenever this callable is called, for the duration of the call we will have a new thread name.
 * 
 * This is useful for debugging because when you get thread dumps the name will reflect what callable
 * is running.
 * @author carrino
 */
@SuppressWarnings("checkstyle:FinalClass") // Avoid breaking API
public class ThreadNamingCallable implements Callable {
    final Callable delegate;
    final String name;
    final Type type;

    public enum Type {
        PREPEND,
        REPLACE,
        APPEND;
    }

    public static  Callable wrapWithThreadName(Callable delegate, String threadName) {
        return wrapWithThreadName(delegate, threadName, Type.REPLACE);
    }

    public static  Callable wrapWithThreadName(Callable delegate, String threadName, Type type) {
        return new ThreadNamingCallable(delegate, threadName, type);
    }

    private ThreadNamingCallable(Callable delegate, String name, Type type) {
        this.delegate = delegate;
        this.name = name;
        this.type = type;
    }

    @Override
    public T call() throws Exception {
        final String oldName = Thread.currentThread().getName();
        Thread.currentThread().setName(getNewName(oldName));
        try {
            return delegate.call();
        } finally {
            Thread.currentThread().setName(oldName);
        }
    }

    private String getNewName(String oldName) {
        switch (type) {
            case PREPEND:
                return name + ' ' + oldName;
            case REPLACE:
                return name;
            case APPEND:
                return oldName + ' ' + name;
            default:
                throw new IllegalArgumentException("type not found: " + type);
        }
    }
}