com.gargoylesoftware.htmlunit.javascript.host

Class Promise

java.lang.Object

net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

com.gargoylesoftware.htmlunit.javascript.host.Promise

All Implemented Interfaces:

Serializable, Cloneable, net.sourceforge.htmlunit.corejs.javascript.ConstProperties, net.sourceforge.htmlunit.corejs.javascript.debug.DebuggableObject, net.sourceforge.htmlunit.corejs.javascript.Scriptable

public class Promise
extends SimpleScriptable

A JavaScript object for Promise.

Author:

Ahmed Ashour, Marc Guillemot

See Also:

Serialized Form

Field Summary

Fields inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface net.sourceforge.htmlunit.corejs.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
Promise() Default constructor.
Promise(Object object) Constructor new promise with the given object.
Promise(Window window) Facility constructor.

Method Summary

Methods

Modifier and Type	Method and Description
static Promise	all(net.sourceforge.htmlunit.corejs.javascript.Context context, net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj, Object[] args, net.sourceforge.htmlunit.corejs.javascript.Function function) Returns a Promise that resolves when all of the promises in the iterable argument have resolved, or rejects with the reason of the first passed promise that rejects.
Promise	catch_js(net.sourceforge.htmlunit.corejs.javascript.Function onRejected) Returns a Promise and deals with rejected cases only.
static Promise	reject(net.sourceforge.htmlunit.corejs.javascript.Context context, net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj, Object[] args, net.sourceforge.htmlunit.corejs.javascript.Function function) Returns a Promise object that is rejected with the given value.
static Promise	resolve(net.sourceforge.htmlunit.corejs.javascript.Context context, net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj, Object[] args, net.sourceforge.htmlunit.corejs.javascript.Function function) Returns a Promise object that is resolved with the given value.
Promise	then(net.sourceforge.htmlunit.corejs.javascript.Function onFulfilled, net.sourceforge.htmlunit.corejs.javascript.Function onRejected) It takes two arguments, both are callback functions for the success and failure cases of the Promise.

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.SimpleScriptable

clone, equivalentValues, get, getBrowserVersion, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getWindow, getWindow, getWithPreemption, has, hasInstance, initParentScope, isReadOnlySettable, makeScriptableFor, setCaseSensitive, setDomNode, setDomNode, setHtmlElement

Methods inherited from class com.gargoylesoftware.htmlunit.javascript.HtmlUnitScriptable

defineFunctionProperties, defineProperty, getClassName, setClassName, setParentScope

Methods inherited from class net.sourceforge.htmlunit.corejs.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, delete, delete, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getPropertyIds, getPrototype, getSlot, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setExternalArrayData, setGetterOrSetter, setPrototype, size

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Promise

public Promise()

Default constructor.

Promise

public Promise(Window window)

Facility constructor.

Parameters:

window - the owning window

Promise

public Promise(Object object)

Constructor new promise with the given object.

Parameters:

object - the object

Method Detail

resolve

public static Promise resolve(net.sourceforge.htmlunit.corejs.javascript.Context context,
              net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj,
              Object[] args,
              net.sourceforge.htmlunit.corejs.javascript.Function function)

Returns a Promise object that is resolved with the given value.

Parameters:

context - the context

thisObj - this object

args - the arguments

function - the function

Returns:

a Promise

reject

public static Promise reject(net.sourceforge.htmlunit.corejs.javascript.Context context,
             net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj,
             Object[] args,
             net.sourceforge.htmlunit.corejs.javascript.Function function)

Returns a Promise object that is rejected with the given value.

Parameters:

context - the context

thisObj - this object

args - the arguments

function - the function

Returns:

a Promise

all

public static Promise all(net.sourceforge.htmlunit.corejs.javascript.Context context,
          net.sourceforge.htmlunit.corejs.javascript.Scriptable thisObj,
          Object[] args,
          net.sourceforge.htmlunit.corejs.javascript.Function function)

Returns a Promise that resolves when all of the promises in the iterable argument have resolved, or rejects with the reason of the first passed promise that rejects.

Parameters:

context - the context

thisObj - this object

args - the arguments

function - the function

Returns:

a Promise

then

public Promise then(net.sourceforge.htmlunit.corejs.javascript.Function onFulfilled,
           net.sourceforge.htmlunit.corejs.javascript.Function onRejected)

It takes two arguments, both are callback functions for the success and failure cases of the Promise.

Parameters:

onFulfilled - success function

onRejected - failure function

Returns:

Promise

catch_js

public Promise catch_js(net.sourceforge.htmlunit.corejs.javascript.Function onRejected)

Returns a Promise and deals with rejected cases only.

Parameters:

onRejected - failure function

Returns:

Promise