org.htmlunit.corejs.javascript

Class LambdaConstructor

java.lang.Object

org.htmlunit.corejs.javascript.SlotMapOwner

org.htmlunit.corejs.javascript.ScriptableObject

org.htmlunit.corejs.javascript.BaseFunction

org.htmlunit.corejs.javascript.LambdaFunction

org.htmlunit.corejs.javascript.LambdaConstructor

All Implemented Interfaces:

Serializable, Callable, ConstProperties, Constructable, DebuggableObject, Function, Scriptable, SymbolScriptable

public class LambdaConstructor
extends LambdaFunction

This class implements a JavaScript function that may be used as a constructor by delegating to an interface that can be easily implemented as a lambda. The LambdaFunction class may be used to add functions to the prototype that are also implemented as lambdas.

In micro benchmarks (as of 2021) using this class to implement a built-in class is about 15% more efficient than using IdScriptableObject, and about 25% faster than using reflection via the ScriptableObject.defineClass() family of methods. Furthermore, it results in code that more directly maps to JavaScript idioms than either methods, it is much easier to implement than IdScriptableObject, and the lambda pattern makes it easier to maintain state in various ways that don't always map directly to the existing concepts.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class org.htmlunit.corejs.javascript.ScriptableObject

ScriptableObject.KeyComparator, ScriptableObject.LambdaGetterFunction, ScriptableObject.LambdaSetterFunction

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONSTRUCTOR_DEFAULT By default, the constructor may be invoked either way
static int	CONSTRUCTOR_FUNCTION If this flag is set, the constructor may be invoked as an ordinary function
static int	CONSTRUCTOR_NEW If this flag is set, the constructor may be invoked using "new"
protected SerializableConstructable	targetConstructor

Fields inherited from class org.htmlunit.corejs.javascript.LambdaFunction

target

Fields inherited from class org.htmlunit.corejs.javascript.BaseFunction

Id_arguments, Id_arity, Id_length, Id_name, Id_prototype, MAX_INSTANCE_ID

Fields inherited from class org.htmlunit.corejs.javascript.ScriptableObject

CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST

Fields inherited from interface org.htmlunit.corejs.javascript.Scriptable

NOT_FOUND

Constructor Summary

Constructors

Constructor and Description
LambdaConstructor(Scriptable scope, String name, int length, int flags, SerializableConstructable target) Create a new function that may be used as a constructor.
LambdaConstructor(Scriptable scope, String name, int length, Object prototype, SerializableCallable target, SerializableConstructable targetConstructor)
LambdaConstructor(Scriptable scope, String name, int length, SerializableCallable target, SerializableConstructable targetConstructor) Create a new function that may be used as a constructor.
LambdaConstructor(Scriptable scope, String name, int length, SerializableConstructable target) Create a new function that may be used as a constructor.

Method Summary

Modifier and Type	Method and Description
Object	call(Context cx, Scriptable scope, Scriptable thisObj, Object[] args) Should be overridden.
Scriptable	construct(Context cx, Scriptable scope, Object[] args) Call the function as a constructor.
static <T> T	convertThisObject(Scriptable thisObj, Class<T> targetClass) A convenience method to convert JavaScript's "this" object into a target class and throw a TypeError if it does not match.
void	defineConstructorMethod(Scriptable scope, String name, int length, Object prototype, SerializableCallable target, int attributes, int propertyAttributes) Define a function property directly on the constructor that is implemented under the covers by a LambdaFunction, and override the properties of its "name", "length", "arity", and "protoyupe" properties.
void	defineConstructorMethod(Scriptable scope, String name, int length, SerializableCallable target, int attributes) Define a function property directly on the constructor that is implemented under the covers by a LambdaFunction.
void	defineConstructorMethod(Scriptable scope, String name, int length, SerializableCallable target, int attributes, int propertyAttributes) Define a function property directly on the constructor that is implemented under the covers by a LambdaFunction, and override the properties of its "name", "length", and "arity" properties.
void	defineConstructorMethod(Scriptable scope, Symbol key, String name, int length, SerializableCallable target, int attributes) Define a function property directly on the constructor that is implemented under the covers by a LambdaFunction.
void	defineKnownBuiltInPrototypeMethod(Object tag, Scriptable scope, String name, int length, Object prototype, SerializableCallable target, int attributes, int propertyAttributes) Define a function property on the prototype of the constructor using a KnownBuiltInFunction under the covers.
void	definePrototypeAlias(String name, String alias, int attributes) Define a property on the prototype that has the same value as another property.
void	definePrototypeAlias(String name, SymbolKey alias, int attributes) Define a property on the prototype that has the same value as another property.
void	definePrototypeMethod(Scriptable scope, String name, int length, Object prototype, SerializableCallable target, int attributes, int propertyAttributes) Define a function property on the prototype of the constructor using a LambdaFunction under the covers.
void	definePrototypeMethod(Scriptable scope, String name, int length, SerializableCallable target) Define a function property on the prototype of the constructor using a LambdaFunction under the covers.
void	definePrototypeMethod(Scriptable scope, String name, int length, SerializableCallable target, int attributes, int propertyAttributes) Define a function property on the prototype of the constructor using a LambdaFunction under the covers.
void	definePrototypeMethod(Scriptable scope, String name, int length, SerializableCallable target, int attributes, int propertyAttributes, boolean defaultPrototype) Define a function property on the prototype of the constructor using a LambdaFunction under the covers and control the prototype of the new function
void	definePrototypeMethod(Scriptable scope, SymbolKey name, int length, Object prototype, SerializableCallable target, int attributes, int propertyAttributes) Define a function property on the prototype of the constructor using a LambdaFunction under the covers.
void	definePrototypeMethod(Scriptable scope, SymbolKey name, int length, SerializableCallable target, int attributes, int propertyAttributes) Define a function property on the prototype of the constructor using a LambdaFunction under the covers.
void	definePrototypeProperty(Context cx, String name, ScriptableObject.LambdaGetterFunction getter, int attributes) Define a property on the prototype using a function.
void	definePrototypeProperty(Context cx, String name, ScriptableObject.LambdaGetterFunction getter, ScriptableObject.LambdaSetterFunction setter, int attributes) Define a property on the prototype using functions for getter and setter.
void	definePrototypeProperty(Context cx, String name, ScriptableObject descriptor)
void	definePrototypeProperty(Context cx, Symbol key, ScriptableObject.LambdaGetterFunction getter, int attributes)
void	definePrototypeProperty(Context cx, Symbol key, ScriptableObject.LambdaGetterFunction getter, ScriptableObject.LambdaSetterFunction setter, int attributes)
void	definePrototypeProperty(Context cx, Symbol key, ScriptableObject descriptor)
void	definePrototypeProperty(String name, Object value, int attributes) Define a property that may be of any type on the prototype of this constructor.
void	definePrototypeProperty(Symbol key, Object value, int attributes)
protected Constructable	getTargetConstructor()
void	setPrototypeScriptable(ScriptableObject proto) Replace the default "Object" prototype with a prototype of a specific implementation.

Methods inherited from class org.htmlunit.corejs.javascript.LambdaFunction

getArity, getFunctionName, getLength

Methods inherited from class org.htmlunit.corejs.javascript.BaseFunction

createObject, createProperties, createPrototypeProperty, defaultGet, defaultHas, defaultPut, getClassName, getClassPrototype, getHomeObject, getPrototypeProperty, getTypeOf, hasDefaultParameters, hasInstance, hasPrototypeProperty, includeNonStandardProps, isGeneratorFunction, setHomeObject, setImmunePrototypeProperty, setPrototypeProperty, setPrototypePropertyAttributes, setStandardPropertyAttributes, setupDefaultPrototype

Methods inherited from class org.htmlunit.corejs.javascript.ScriptableObject

applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChangeForSlot, checkPropertyDefinition, defineBuiltInProperty, defineBuiltInProperty, defineBuiltInProperty, defineBuiltInProperty, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureScriptableObjectButNotSymbol, ensureSymbolScriptable, ensureType, equivalentValues, get, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getSuperProperty, getSuperProperty, getSuperProperty, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, has, has, has, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, put, putConst, putConstProperty, putOwnProperty, putOwnProperty, putOwnProperty, putProperty, putProperty, putProperty, putSuperProperty, putSuperProperty, putSuperProperty, querySlot, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setCommonDescriptorProperties, setExternalArrayData, setGetterOrSetter, setParentScope, setPrototype, size

Methods inherited from class org.htmlunit.corejs.javascript.SlotMapOwner

createSlotMap

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.htmlunit.corejs.javascript.Scriptable

delete, delete, get, get, getDefaultValue, getIds, getParentScope, getPrototype, has, has, put, put, setParentScope, setPrototype

Field Detail

CONSTRUCTOR_FUNCTION

public static final int CONSTRUCTOR_FUNCTION

If this flag is set, the constructor may be invoked as an ordinary function

See Also:

Constant Field Values

CONSTRUCTOR_NEW

public static final int CONSTRUCTOR_NEW

If this flag is set, the constructor may be invoked using "new"

See Also:

Constant Field Values

CONSTRUCTOR_DEFAULT

public static final int CONSTRUCTOR_DEFAULT

By default, the constructor may be invoked either way

See Also:

Constant Field Values

targetConstructor

protected final SerializableConstructable targetConstructor

Constructor Detail

LambdaConstructor

public LambdaConstructor(Scriptable scope,
                         String name,
                         int length,
                         SerializableConstructable target)

Create a new function that may be used as a constructor. The new object will have the Function prototype and no parent. The caller is responsible for binding this object to the appropriate scope. The new constructor function can be invoked using "new" or by calling it directly, and in either case will result in a new object being returned and wired to the correct prototype and scope.

Parameters:

scope - scope of the calling context

name - name of the function

length - the arity of the function

target - an object that implements the function in Java. Since Constructable is a single-function interface this will typically be implemented as a lambda.

LambdaConstructor

public LambdaConstructor(Scriptable scope,
                         String name,
                         int length,
                         int flags,
                         SerializableConstructable target)

Create a new function that may be used as a constructor. The new object will have the Function prototype and no parent. The caller is responsible for binding this object to the appropriate scope. The "flags" argument controls whether the function may be invoked using "new," via a direct call, or both. If allowed by the flags, then the constructor will have the same effect either way. If not allowed by the flags, then a TypeError will be thrown.

Parameters:

scope - scope of the calling context

name - name of the function

length - the arity of the function

flags - which may be a combination of CONSTRUCTOR_NEW and CONSTRUCTOR_FUNCTION

target - an object that implements the function in Java. Since Constructable is a single-function interface this will typically be implemented as a lambda.

LambdaConstructor

public LambdaConstructor(Scriptable scope,
                         String name,
                         int length,
                         SerializableCallable target,
                         SerializableConstructable targetConstructor)

Create a new function that may be used as a constructor. The new object will have the Function prototype and no parent. The caller is responsible for binding this object to the appropriate scope. The new constructor function will have different behavior depending on whether it is invoked via "new" or via a direct call. In the case of "new", a new object with a prototype and scope chain be returned, but in the case of a direct call, the user must implement whatever they need. This is typically used in the case of functions like the native Date constructor, which has totally different behavior depending on how it's invoked.

Parameters:

scope - scope of the calling context

name - name of the function

length - the arity of the function

target - an object that implements the function in Java. Since Constructable is a single-function interface this will typically be implemented as a lambda.

LambdaConstructor

public LambdaConstructor(Scriptable scope,
                         String name,
                         int length,
                         Object prototype,
                         SerializableCallable target,
                         SerializableConstructable targetConstructor)

Method Detail

getTargetConstructor

protected Constructable getTargetConstructor()

call

public Object call(Context cx,
                   Scriptable scope,
                   Scriptable thisObj,
                   Object[] args)

Description copied from class: BaseFunction

Should be overridden.

Specified by:

call in interface Callable

Specified by:

call in interface Function

Overrides:

call in class LambdaFunction

Parameters:

cx - the current Context for this thread

scope - the scope to execute the function relative to. This is set to the value returned by getParentScope() except when the function is called from a closure.

thisObj - the JavaScript this object

args - the array of arguments

Returns:

the result of the call

construct

public Scriptable construct(Context cx,
                            Scriptable scope,
                            Object[] args)

Description copied from interface: Function

Call the function as a constructor.

This method is invoked by the runtime in order to satisfy a use of the JavaScript new operator. This method is expected to create a new object and return it.

Specified by:

construct in interface Constructable

Specified by:

construct in interface Function

Overrides:

construct in class LambdaFunction

Parameters:

cx - the current Context for this thread

scope - an enclosing scope of the caller except when the function is called from a closure.

args - the array of arguments

Returns:

the allocated object

definePrototypeMethod

public void definePrototypeMethod(Scriptable scope,
                                  String name,
                                  int length,
                                  SerializableCallable target)

Define a function property on the prototype of the constructor using a LambdaFunction under the covers.

definePrototypeMethod

public void definePrototypeMethod(Scriptable scope,
                                  String name,
                                  int length,
                                  SerializableCallable target,
                                  int attributes,
                                  int propertyAttributes)

Define a function property on the prototype of the constructor using a LambdaFunction under the covers.

definePrototypeMethod

public void definePrototypeMethod(Scriptable scope,
                                  String name,
                                  int length,
                                  SerializableCallable target,
                                  int attributes,
                                  int propertyAttributes,
                                  boolean defaultPrototype)

Define a function property on the prototype of the constructor using a LambdaFunction under the covers and control the prototype of the new function

definePrototypeMethod

public void definePrototypeMethod(Scriptable scope,
                                  SymbolKey name,
                                  int length,
                                  SerializableCallable target,
                                  int attributes,
                                  int propertyAttributes)

Define a function property on the prototype of the constructor using a LambdaFunction under the covers.

definePrototypeMethod

public void definePrototypeMethod(Scriptable scope,
                                  String name,
                                  int length,
                                  Object prototype,
                                  SerializableCallable target,
                                  int attributes,
                                  int propertyAttributes)

Define a function property on the prototype of the constructor using a LambdaFunction under the covers.

defineKnownBuiltInPrototypeMethod

public void defineKnownBuiltInPrototypeMethod(Object tag,
                                              Scriptable scope,
                                              String name,
                                              int length,
                                              Object prototype,
                                              SerializableCallable target,
                                              int attributes,
                                              int propertyAttributes)

Define a function property on the prototype of the constructor using a KnownBuiltInFunction under the covers.

definePrototypeMethod

public void definePrototypeMethod(Scriptable scope,
                                  SymbolKey name,
                                  int length,
                                  Object prototype,
                                  SerializableCallable target,
                                  int attributes,
                                  int propertyAttributes)

Define a function property on the prototype of the constructor using a LambdaFunction under the covers.

definePrototypeProperty

public void definePrototypeProperty(String name,
                                    Object value,
                                    int attributes)

Define a property that may be of any type on the prototype of this constructor.

definePrototypeProperty

public void definePrototypeProperty(Symbol key,
                                    Object value,
                                    int attributes)

definePrototypeProperty

public void definePrototypeProperty(Context cx,
                                    String name,
                                    ScriptableObject descriptor)

definePrototypeProperty

public void definePrototypeProperty(Context cx,
                                    Symbol key,
                                    ScriptableObject descriptor)

definePrototypeProperty

public void definePrototypeProperty(Context cx,
                                    String name,
                                    ScriptableObject.LambdaGetterFunction getter,
                                    int attributes)

Define a property on the prototype using a function. The function will be wired to a JavaScript function, so the resulting property will look just like one that was defined using "Object.defineOwnProperty" with a property descriptor.

definePrototypeProperty

public void definePrototypeProperty(Context cx,
                                    Symbol key,
                                    ScriptableObject.LambdaGetterFunction getter,
                                    int attributes)

definePrototypeProperty

public void definePrototypeProperty(Context cx,
                                    String name,
                                    ScriptableObject.LambdaGetterFunction getter,
                                    ScriptableObject.LambdaSetterFunction setter,
                                    int attributes)

Define a property on the prototype using functions for getter and setter. The function will be wired to a JavaScript function, so the resulting property will look just like one that was defined using "Object.defineOwnProperty" with a property descriptor.

definePrototypeProperty

public void definePrototypeProperty(Context cx,
                                    Symbol key,
                                    ScriptableObject.LambdaGetterFunction getter,
                                    ScriptableObject.LambdaSetterFunction setter,
                                    int attributes)

definePrototypeAlias

public void definePrototypeAlias(String name,
                                 SymbolKey alias,
                                 int attributes)

Define a property on the prototype that has the same value as another property.

definePrototypeAlias

public void definePrototypeAlias(String name,
                                 String alias,
                                 int attributes)

Define a property on the prototype that has the same value as another property.

defineConstructorMethod

public void defineConstructorMethod(Scriptable scope,
                                    String name,
                                    int length,
                                    SerializableCallable target,
                                    int attributes)

Define a function property directly on the constructor that is implemented under the covers by a LambdaFunction.

Parameters:

name - the key to use to look up the new function property, and also the value to return for the "name" property of the Function object

length - the value to return for the "length" property of the Function object

target - the target to call when the method is invoked

attributes - the attributes to set on the new property

defineConstructorMethod

public void defineConstructorMethod(Scriptable scope,
                                    Symbol key,
                                    String name,
                                    int length,
                                    SerializableCallable target,
                                    int attributes)

Define a function property directly on the constructor that is implemented under the covers by a LambdaFunction.

Parameters:

key - the Symbol to use to look up the property

name - the value to return for the "name" property of the Function object

length - the value to return for the "length" property of the Function object

target - the target to call when the method is invoked

attributes - the attributes to set on the new property

defineConstructorMethod

public void defineConstructorMethod(Scriptable scope,
                                    String name,
                                    int length,
                                    SerializableCallable target,
                                    int attributes,
                                    int propertyAttributes)

Define a function property directly on the constructor that is implemented under the covers by a LambdaFunction, and override the properties of its "name", "length", and "arity" properties.

defineConstructorMethod

public void defineConstructorMethod(Scriptable scope,
                                    String name,
                                    int length,
                                    Object prototype,
                                    SerializableCallable target,
                                    int attributes,
                                    int propertyAttributes)

Define a function property directly on the constructor that is implemented under the covers by a LambdaFunction, and override the properties of its "name", "length", "arity", and "protoyupe" properties.

setPrototypeScriptable

public void setPrototypeScriptable(ScriptableObject proto)

Replace the default "Object" prototype with a prototype of a specific implementation. This is only necessary for a few built-in constructors, like Boolean, that must have their prototype be an object with a specific "internal data slot."

convertThisObject

public static <T> T convertThisObject(Scriptable thisObj,
                                      Class<T> targetClass)

A convenience method to convert JavaScript's "this" object into a target class and throw a TypeError if it does not match. This is useful for implementing lambda functions, as "this" in JavaScript doesn't necessarily map to an instance of the class.