CaRMtl/org/mozilla/javascript/ContinuationPending.java
2018-09-04 22:51:42 -04:00

100 lines
3.8 KiB
Java

/* -*- Mode: java; tab-width: 8; indent-tabs-mode: nil; c-basic-offset: 4 -*-
*
* ***** BEGIN LICENSE BLOCK *****
* Version: MPL 1.1/GPL 2.0
*
* The contents of this file are subject to the Mozilla Public License Version
* 1.1 (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.mozilla.org/MPL/
*
* Software distributed under the License is distributed on an "AS IS" basis,
* WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
* for the specific language governing rights and limitations under the
* License.
*
* The Original Code is Rhino code, released
* May 6, 1999.
*
* The Initial Developer of the Original Code is
* Netscape Communications Corporation.
* Portions created by the Initial Developer are Copyright (C) 1997-1999
* the Initial Developer. All Rights Reserved.
*
* Contributor(s):
* Norris Boyd
*
* Alternatively, the contents of this file may be used under the terms of
* the GNU General Public License Version 2 or later (the "GPL"), in which
* case the provisions of the GPL are applicable instead of those above. If
* you wish to allow use of your version of this file only under the terms of
* the GPL and not to allow others to use your version of this file under the
* MPL, indicate your decision by deleting the provisions above and replacing
* them with the notice and other provisions required by the GPL. If you do
* not delete the provisions above, a recipient may use your version of this
* file under either the MPL or the GPL.
*
* ***** END LICENSE BLOCK ***** */
package org.mozilla.javascript;
/**
* Exception thrown by
* {@link org.mozilla.javascript.Context#executeScriptWithContinuations(Script, Scriptable)}
* and {@link org.mozilla.javascript.Context#callFunctionWithContinuations(Callable, Scriptable, Object[])}
* when execution encounters a continuation captured by
* {@link org.mozilla.javascript.Context#captureContinuation()}.
* Exception will contain the captured state needed to restart the continuation
* with {@link org.mozilla.javascript.Context#resumeContinuation(Object, Scriptable, Object)}.
* @author Norris Boyd
*/
public class ContinuationPending extends RuntimeException {
private static final long serialVersionUID = 4956008116771118856L;
private NativeContinuation continuationState;
private Object applicationState;
/**
* Construct a ContinuationPending exception. Internal call only;
* users of the API should get continuations created on their behalf by
* calling {@link org.mozilla.javascript.Context#executeScriptWithContinuations(Script, Scriptable)}
* and {@link org.mozilla.javascript.Context#callFunctionWithContinuations(Callable, Scriptable, Object[])}
* @param continuationState Internal Continuation object
*/
ContinuationPending(NativeContinuation continuationState) {
this.continuationState = continuationState;
}
/**
* Get continuation object. The only
* use for this object is to be passed to
* {@link org.mozilla.javascript.Context#resumeContinuation(Object, Scriptable, Object)}.
* @return continuation object
*/
public Object getContinuation() {
return continuationState;
}
/**
* @return internal continuation state
*/
NativeContinuation getContinuationState() {
return continuationState;
}
/**
* Store an arbitrary object that applications can use to associate
* their state with the continuation.
* @param applicationState arbitrary application state
*/
public void setApplicationState(Object applicationState) {
this.applicationState = applicationState;
}
/**
* @return arbitrary application state
*/
public Object getApplicationState() {
return applicationState;
}
}