com.github.dm.jrt.channel.AbortException 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.github.dm.jrt.channel;

import javax.annotation.Nonnull;
import javax.annotation.Nullable;

/**
 * Exception indicating that an invocation has been explicitly aborted.
 * 
 * Created by davide-maestroni on 01/27/2015.
 */
public class AbortException extends RoutineException {

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

        super(cause);
    }

    /**
     * Wraps the specified throwable only if it is not an instance of
     * {@link com.github.dm.jrt.channel.RoutineException RoutineException}.
     *
     * @param cause the throwable to wrap.
     * @return the throwable or an abort exception wrapping it.
     */
    @Nonnull
    public static RoutineException wrapIfNeeded(@Nullable final Throwable cause) {

        return (cause instanceof RoutineException) ? (RoutineException) cause
                : new AbortException(cause);
    }
}