com.gh.bmd.jrt.common.InvocationInterruptedException Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jroutine Show documentation

Parallel programming on the go

There is a newer version: 5.9.0

/**
 * 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.gh.bmd.jrt.common;

import javax.annotation.Nullable;

/**
 * Exception wrapping a thread interrupted exception caught inside a routine execution.
 * 
 * Created by davide on 9/8/14.
 */
public class InvocationInterruptedException extends RoutineException {

    /**
     * Constructor.
     *
     * @param cause the wrapped exception.
     */
    public InvocationInterruptedException(@Nullable final InterruptedException cause) {

        super(cause);
    }

    /**
     * Sets the interrupt flag of the current thread and returns a wrapped exception.
     *
     * @param exception the thread interrupted exception.
     * @return the wrapped exception.
     */
    public static InvocationInterruptedException interrupt(
            @Nullable final InterruptedException exception) throws InvocationInterruptedException {

        return new InvocationInterruptedException(exception).interrupt();
    }

    /**
     * Sets the interrupt flag of the current thread and returns this exception.
     *
     * @return this exception.
     */
    public InvocationInterruptedException interrupt() {

        Thread.currentThread().interrupt();
        return this;
    }
}