co.paralleluniverse.fibers.SuspendExecution Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of quasar-core Show documentation

Fibers, Channels and Actors for the JVM

The newest version!

/*
 * Quasar: lightweight threads and actors for the JVM.
 * Copyright (c) 2013-2014, Parallel Universe Software Co. All rights reserved.
 * 
 * This program and the accompanying materials are dual-licensed under
 * either the terms of the Eclipse Public License v1.0 as published by
 * the Eclipse Foundation
 *  
 *   or (per the licensee's choosing)
 *  
 * under the terms of the GNU Lesser General Public License version 3.0
 * as published by the Free Software Foundation.
 */
package co.paralleluniverse.fibers;

/**
 * 
 * An exception used to initiate the control transfer.
 * Methods which are declared to throw this exception are "suspendable". This
 * exception must always be propagated and never be caught.
 * 
 * Try/catch handlers are allowed:

 * {@code try{ doSomething(); } catch(Throwable ex) { handleException(ex); } }
 * 
 * Quasar instrumentation will enhance the bytecode of these methods to
 * support suspension and continuation of their execution; they will not catch {@code SuspendExecution}.
 * 
 * This class is for internal Quasar use. 
 * Throwing an instance of this class or a subclass of it will break things in strange ways.
 */
public final class SuspendExecution extends Exception { // InterruptedException {
    static final SuspendExecution PARK = new SuspendExecution();
    static final SuspendExecution YIELD = new SuspendExecution();

    protected SuspendExecution() {
        super("Oops. Forgot to instrument a method. Run your program with -Dco.paralleluniverse.fibers.verifyInstrumentation=true to catch the culprit!");
    }

    @Override
    public Throwable fillInStackTrace() {
        return this;
    }
}