org.gradle.internal.concurrent.InterruptibleRunnable Maven / Gradle / Ivy

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

Gradle 6.5 API redistribution.

There is a newer version: 8.6

/*
 * Copyright 2018 the original author or authors.
 *
 * 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 org.gradle.internal.concurrent;

import java.util.concurrent.locks.Lock;
import java.util.concurrent.locks.ReentrantLock;

/**
 * Wraps a runnable so that it can be interrupted. Useful when {@link java.util.concurrent.Future} is not available or its behavior is not desired.
 *
 * In contrast to {@link java.util.concurrent.Future#cancel(boolean)}, the delegate Runnable is always called, even if an interrupt was received before this runnable was started.
 * This can be used to implement guaranteed delivery mechanisms, where proper interrupt handling is up to the delegate.
 */
public final class InterruptibleRunnable implements Runnable {
    private final Lock stateLock = new ReentrantLock();
    private final Runnable delegate;
    private boolean interrupted;
    private Thread thread;

    public InterruptibleRunnable(Runnable delegate) {
        this.delegate = delegate;
    }

    @Override
    public void run() {
        beforeRun();
        try {
            delegate.run();
        } finally {
            afterRun();
        }
    }

    private void beforeRun() {
        stateLock.lock();
        try {
            thread = Thread.currentThread();
            if (interrupted) {
                thread.interrupt();
            }
        } finally {
            stateLock.unlock();
        }
    }

    private void afterRun() {
        stateLock.lock();
        try {
            Thread.interrupted();
            thread = null;
        } finally {
            stateLock.unlock();
        }
    }

    public void interrupt() {
        stateLock.lock();
        try {
            if (thread == null) {
                interrupted = true;
            } else {
                thread.interrupt();
            }
        } finally {
            stateLock.unlock();
        }
    }
}