V8ValueFunction (javet 3.1.2 API)

java.lang.Object
- com.caoccao.javet.values.V8Data
- - com.caoccao.javet.values.V8Value
  - - com.caoccao.javet.values.reference.V8ValueReference
    - - com.caoccao.javet.values.reference.V8ValueObject
      - com.caoccao.javet.values.reference.V8ValueFunction

All Implemented Interfaces:

IJavetClosable, IV8Cloneable, IV8Value, IV8Cacheable, IV8ValueFunction, IV8ValueObject, IV8ValueReference, java.lang.AutoCloseable

Direct Known Subclasses:

V8ValueBuiltInPromise, V8ValueBuiltInSymbol
```
public class V8ValueFunction
extends V8ValueObject
implements IV8ValueFunction
```
The type V8 value function.

Since:

0.7.0

Nested Class Summary
- Nested classes/interfaces inherited from interface com.caoccao.javet.values.reference.IV8ValueFunction
  IV8ValueFunction.GetScopeInfosOptions, IV8ValueFunction.ScopeInfo, IV8ValueFunction.ScopeInfos, IV8ValueFunction.ScriptSource, IV8ValueFunction.SetSourceCodeOptions

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.lang.String`	`ERROR_THE_SOURCE_FUNCTION_CANNOT_BE_IN_ANOTHER_V8_RUNTIME` The constant ERROR_THE_SOURCE_FUNCTION_CANNOT_BE_IN_ANOTHER_V8_RUNTIME.
`protected static java.lang.String`	`ERROR_THE_SOURCE_FUNCTION_CANNOT_BE_THE_CALLER` The constant ERROR_THE_SOURCE_FUNCTION_CANNOT_BE_THE_CALLER.
`protected static java.lang.String`	`ERROR_V8_CONTEXT_CANNOT_BE_NULL` The constant ERROR_V8_CONTEXT_CANNOT_BE_NULL.
`protected JSFunctionType`	`jsFunctionType` The JS function type.

Fields inherited from class com.caoccao.javet.values.reference.V8ValueObject
ERROR_THE_KEY_VALUE_PAIR_MUST_MATCH, FUNCTION_ADD, FUNCTION_DELETE, FUNCTION_GET, FUNCTION_HAS, FUNCTION_SET, METHOD_PREFIX_GET, METHOD_PREFIX_IS, METHOD_PREFIX_SET, PROPERTY_PROTOTYPE

Fields inherited from class com.caoccao.javet.values.reference.V8ValueReference
handle, INVALID_HANDLE, weak

Fields inherited from class com.caoccao.javet.values.V8Value
OBJECT_CONVERTER, v8Runtime

Fields inherited from interface com.caoccao.javet.values.reference.IV8ValueObject
DEFAULT_BATCH_SIZE, MIN_BATCH_SIZE

Constructor Summary

Constructors
Modifier Constructor and Description

protected V8ValueFunction(V8Runtime v8Runtime, long handle)
Instantiates a new V8 value function.

Constructors
Modifier	Constructor and Description
`protected`	`V8ValueFunction(V8Runtime v8Runtime, long handle)` Instantiates a new V8 value function.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends V8Value> T`	`callAsConstructor(java.lang.Object... objects)` Call a function as constructor by objects.
`<T extends V8Value> T`	`callAsConstructor(V8Value... v8Values)` Call a function as constructor by V8 values.
`<T extends V8Value> T`	`callExtended(V8Value receiver, boolean returnResult, java.lang.Object... objects)` Call a function by objects and return V8 value.
`<T extends V8Value> T`	`callExtended(V8Value receiver, boolean returnResult, V8Value... v8Values)` Call a function by V8 values and return V8 value.
`boolean`	`canDiscardCompiled()` Can discard compiled byte code.
`boolean`	`copyScopeInfoFrom(IV8ValueFunction sourceIV8ValueFunction)` Copy the scope info from the source V8 value function.
`boolean`	`discardCompiled()` Discard compiled byte code.
`java.lang.String[]`	`getArguments()` Gets arguments.
`byte[]`	`getCachedData()` Gets cached data.
`V8Context`	`getContext()` Gets the V8 context.
`IV8ValueArray`	`getInternalProperties()` Gets internal properties.
`JSFunctionType`	`getJSFunctionType()` Gets JS function type.
`JSScopeType`	`getJSScopeType()` Gets JS scope type.
`IV8ValueFunction.ScopeInfos`	`getScopeInfos(IV8ValueFunction.GetScopeInfosOptions options)` Gets scope infos.
`IV8ValueFunction.ScriptSource`	`getScriptSource()` Gets script source.
`java.lang.String`	`getSourceCode()` Gets source code.
`V8ValueReferenceType`	`getType()`
`boolean`	`isCompiled()` Is this function compiled.
`boolean`	`isWrapped()` Is wrapped function.
`boolean`	`setContext(V8Context v8Context)` Sets the V8 context.
`boolean`	`setScriptSource(IV8ValueFunction.ScriptSource scriptSource, boolean cloneScript)` Sets script source.
`boolean`	`setSourceCode(java.lang.String sourceCodeString, IV8ValueFunction.SetSourceCodeOptions options)` Sets source code with options.

Methods inherited from class com.caoccao.javet.values.reference.V8ValueObject
batchGet, bind, bindFunction, bindProperty, delete, deletePrivateProperty, forEach, forEach, get, getBoolean, getDouble, getIdentityHash, getInteger, getLong, getOwnPropertyNames, getPrivateProperty, getProperty, getPropertyNames, getPrototype, getString, has, hasInternalType, hasOwnProperty, hasPrivateProperty, invokeExtended, invokeExtended, sameValue, set, set, setBoolean, setDouble, setInteger, setLong, setNull, setPrivateProperty, setProperty, setPrototype, setString, setUndefined, strictEquals, toJsonString, toProtoString, unbind, unbindFunction, unbindProperty, unbindProperty, unbindProperty, unbindProperty

Methods inherited from class com.caoccao.javet.values.reference.V8ValueReference
addReference, checkV8Runtime, clearWeak, close, close, equals, getHandle, isClosed, isWeak, isWeak, removeReference, setWeak, toClone, toString

Methods inherited from class com.caoccao.javet.values.V8Value
getV8Runtime

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.caoccao.javet.values.reference.IV8ValueFunction
call, call, callBigInteger, callBoolean, callDouble, callFloat, callInteger, callLong, callObject, callString, callVoid, callVoid, callZonedDateTime, copyContextFrom, getScopeInfos, isAsyncFunction, isGeneratorFunction, setScriptSource, setSourceCode

Methods inherited from interface com.caoccao.javet.values.reference.IV8ValueObject
batchGet, bind, bindFunction, bindFunction, bindFunction, bindProperty, bindProperty, delete, deleteNull, deletePrivateProperty, deleteUndefined, forEach, forEach, forEach, forEach, forEach, forEach, forEach, forEach, get, getBigInteger, getBoolean, getDouble, getFloat, getIdentityHash, getInteger, getLong, getNull, getObject, getOwnPropertyNames, getOwnPropertyNameStrings, getPrivateProperty, getPrivatePropertyBoolean, getPrivatePropertyDouble, getPrivatePropertyFloat, getPrivatePropertyInteger, getPrivatePropertyLong, getPrivatePropertyNull, getPrivatePropertyObject, getPrivatePropertyPrimitive, getPrivatePropertyString, getPrivatePropertyUndefined, getPrivatePropertyZonedDateTime, getProperty, getPropertyBoolean, getPropertyDouble, getPropertyFloat, getPropertyInteger, getPropertyLong, getPropertyNames, getPropertyObject, getPropertyPrimitive, getPropertyString, getPropertyZonedDateTime, getPrototype, getString, getUndefined, getZonedDateTime, has, hasInternalType, hasNull, hasOwnProperty, hasPrivateProperty, hasUndefined, invoke, invoke, invokeBigInteger, invokeBoolean, invokeDouble, invokeExtended, invokeExtended, invokeFloat, invokeInteger, invokeLong, invokeObject, invokeString, invokeVoid, invokeVoid, invokeZonedDateTime, isGeneratorObject, set, set, setBoolean, setDouble, setInteger, setLong, setNull, setPrivateProperty, setPrivatePropertyNull, setPrivatePropertyUndefined, setProperty, setPropertyNull, setPropertyUndefined, setPrototype, setString, setUndefined, toJsonString, toProtoString, unbind, unbindFunction, unbindFunction, unbindFunction, unbindProperty, unbindProperty, unbindProperty, unbindProperty

Methods inherited from interface com.caoccao.javet.values.reference.IV8ValueReference
clearWeak, close, getHandle, isClosed, isWeak, isWeak, setWeak

Methods inherited from interface com.caoccao.javet.values.IV8Value
asBoolean, asDouble, asInt, asLong, asString, equals, getV8Runtime, isNull, isNullOrUndefined, isUndefined, sameValue, strictEquals

Methods inherited from interface com.caoccao.javet.interfaces.IJavetClosable
close

Methods inherited from interface com.caoccao.javet.interop.IV8Cloneable
toClone, toClone

- Field Detail
  - ERROR_THE_SOURCE_FUNCTION_CANNOT_BE_IN_ANOTHER_V8_RUNTIME
```
protected static final java.lang.String ERROR_THE_SOURCE_FUNCTION_CANNOT_BE_IN_ANOTHER_V8_RUNTIME
```
    The constant ERROR_THE_SOURCE_FUNCTION_CANNOT_BE_IN_ANOTHER_V8_RUNTIME.
    
    Since:
    
    2.0.1
    
    See Also:
    
    Constant Field Values
  - ERROR_THE_SOURCE_FUNCTION_CANNOT_BE_THE_CALLER
```
protected static final java.lang.String ERROR_THE_SOURCE_FUNCTION_CANNOT_BE_THE_CALLER
```
    The constant ERROR_THE_SOURCE_FUNCTION_CANNOT_BE_THE_CALLER.
    
    Since:
    
    2.0.1
    
    See Also:
    
    Constant Field Values
  - ERROR_V8_CONTEXT_CANNOT_BE_NULL
```
protected static final java.lang.String ERROR_V8_CONTEXT_CANNOT_BE_NULL
```
    The constant ERROR_V8_CONTEXT_CANNOT_BE_NULL.
    
    Since:
    
    2.0.1
    
    See Also:
    
    Constant Field Values
  - jsFunctionType
```
protected JSFunctionType jsFunctionType
```
    The JS function type.
    
    Since:
    
    0.8.8
- Constructor Detail
  - V8ValueFunction
```
protected V8ValueFunction(V8Runtime v8Runtime,
                          long handle)
                   throws JavetException
```
    Instantiates a new V8 value function.
    
    Parameters:
    
    v8Runtime - the V8 runtime
    
    handle - the handle
    
    Throws:
    
    JavetException - the javet exception
    
    Since:
    
    0.7.0
- Method Detail
  - callAsConstructor
```
@CheckReturnValue
public <T extends V8Value> T callAsConstructor(java.lang.Object... objects)
                                                           throws JavetException
```
    Description copied from interface: IV8ValueFunction
    
    Call a function as constructor by objects.
    
    Specified by:
    
    callAsConstructor in interface IV8ValueFunction
    
    Type Parameters:
    
    T - the type parameter
    
    Parameters:
    
    objects - the objects
    
    Returns:
    
    the V8 value
    
    Throws:
    
    JavetException - the javet exception
  - callAsConstructor
```
@CheckReturnValue
public <T extends V8Value> T callAsConstructor(V8Value... v8Values)
                                                           throws JavetException
```
    Description copied from interface: IV8ValueFunction
    
    Call a function as constructor by V8 values.
    
    Specified by:
    
    callAsConstructor in interface IV8ValueFunction
    
    Type Parameters:
    
    T - the type parameter
    
    Parameters:
    
    v8Values - the V8 values
    
    Returns:
    
    the V8 value
    
    Throws:
    
    JavetException - the javet exception
  - callExtended
```
@CheckReturnValue
public <T extends V8Value> T callExtended(V8Value receiver,
                                                             boolean returnResult,
                                                             java.lang.Object... objects)
                                                      throws JavetException
```
    Description copied from interface: IV8ValueFunction
    
    Call a function by objects and return V8 value.
    
    Specified by:
    
    callExtended in interface IV8ValueFunction
    
    Type Parameters:
    
    T - the type parameter
    
    Parameters:
    
    receiver - the receiver
    
    returnResult - the return result
    
    objects - the objects
    
    Returns:
    
    the t
    
    Throws:
    
    JavetException - the javet exception
  - callExtended
```
@CheckReturnValue
public <T extends V8Value> T callExtended(V8Value receiver,
                                                             boolean returnResult,
                                                             V8Value... v8Values)
                                                      throws JavetException
```
    Description copied from interface: IV8ValueFunction
    
    Call a function by V8 values and return V8 value.
    
    Specified by:
    
    callExtended in interface IV8ValueFunction
    
    Type Parameters:
    
    T - the type parameter
    
    Parameters:
    
    receiver - the receiver
    
    returnResult - the return result
    
    v8Values - the V8 values
    
    Returns:
    
    the t
    
    Throws:
    
    JavetException - the javet exception
  - canDiscardCompiled
```
public boolean canDiscardCompiled()
                           throws JavetException
```
    Description copied from interface: IV8ValueFunction
    
    Can discard compiled byte code.
    
    Specified by:
    
    canDiscardCompiled in interface IV8ValueFunction
    
    Returns:
    
    true : yes, false : no
    
    Throws:
    
    JavetException - the javet exception
  - copyScopeInfoFrom
```
public boolean copyScopeInfoFrom(IV8ValueFunction sourceIV8ValueFunction)
                          throws JavetException
```
    Description copied from interface: IV8ValueFunction
    
    Copy the scope info from the source V8 value function.
    This allows changing the existing function scope info on the fly. It is similar to the live edit in a JavaScript debug tool.
    
    Specified by:
    
    copyScopeInfoFrom in interface IV8ValueFunction
    
    Parameters:
    
    sourceIV8ValueFunction - the source V8 value function
    
    Returns:
    
    true : copied, false : not copied
    
    Throws:
    
    JavetException - the javet exception
  - discardCompiled
```
public boolean discardCompiled()
                        throws JavetException
```
    Description copied from interface: IV8ValueFunction
    
    Discard compiled byte code.
    
    Specified by:
    
    discardCompiled in interface IV8ValueFunction
    
    Returns:
    
    true : discarded, false : not discarded
    
    Throws:
    
    JavetException - the javet exception
  - getArguments
```
public java.lang.String[] getArguments()
                                throws JavetException
```
    Description copied from interface: IV8ValueFunction
    
    Gets arguments.
    
    Specified by:
    
    getArguments in interface IV8ValueFunction
    
    Returns:
    
    the arguments
    
    Throws:
    
    JavetException - the javet exception
  - getCachedData
```
public byte[] getCachedData()
                     throws JavetException
```
    Description copied from interface: IV8Cacheable
    
    Gets cached data.
    
    Specified by:
    
    getCachedData in interface IV8Cacheable
    
    Returns:
    
    the cached data
    
    Throws:
    
    JavetException - the javet exception
  - getContext
```
public V8Context getContext()
                     throws JavetException
```
    Description copied from interface: IV8ValueFunction
    
    Gets the V8 context.
    
    Specified by:
    
    getContext in interface IV8ValueFunction
    
    Returns:
    
    the V8 context
    
    Throws:
    
    JavetException - the javet exception
  - getInternalProperties
```
@CheckReturnValue
public IV8ValueArray getInternalProperties()
                                                       throws JavetException
```
    Description copied from interface: IV8ValueFunction
    
    Gets internal properties.
    
    Specified by:
    
    getInternalProperties in interface IV8ValueFunction
    
    Returns:
    
    the internal properties
    
    Throws:
    
    JavetException - the javet exception
  - getJSFunctionType
```
public JSFunctionType getJSFunctionType()
                                 throws JavetException
```
    Description copied from interface: IV8ValueFunction
    
    Gets JS function type.
    
    Specified by:
    
    getJSFunctionType in interface IV8ValueFunction
    
    Returns:
    
    the JS function type
    
    Throws:
    
    JavetException - the javet exception
  - getJSScopeType
```
public JSScopeType getJSScopeType()
                           throws JavetException
```
    Description copied from interface: IV8ValueFunction
    
    Gets JS scope type.
    
    Specified by:
    
    getJSScopeType in interface IV8ValueFunction
    
    Returns:
    
    the JS scope type
    
    Throws:
    
    JavetException - the javet exception
  - getScopeInfos
```
@CheckReturnValue
public IV8ValueFunction.ScopeInfos getScopeInfos(IV8ValueFunction.GetScopeInfosOptions options)
                                                             throws JavetException
```
    Description copied from interface: IV8ValueFunction
    
    Gets scope infos.
    
    Specified by:
    
    getScopeInfos in interface IV8ValueFunction
    
    Parameters:
    
    options - the options
    
    Returns:
    
    the scope infos
    
    Throws:
    
    JavetException - the javet exception
  - getScriptSource
```
public IV8ValueFunction.ScriptSource getScriptSource()
                                              throws JavetException
```
    Description copied from interface: IV8ValueFunction
    
    Gets script source.
    A user-defined JavaScript function is part of a script from start position to end position. This method returns the source code of the whole script with the start position and end position. If it is not a user-defined JavaScript function, the return value is null.
    
    Specified by:
    
    getScriptSource in interface IV8ValueFunction
    
    Returns:
    
    the script source
    
    Throws:
    
    JavetException - the javet exception
  - getSourceCode
```
public java.lang.String getSourceCode()
                               throws JavetException
```
    Description copied from interface: IV8ValueFunction
    
    Gets source code.
    
    Specified by:
    
    getSourceCode in interface IV8ValueFunction
    
    Returns:
    
    the source code
    
    Throws:
    
    JavetException - the javet exception
  - getType
```
public V8ValueReferenceType getType()
```
    Specified by:
    
    getType in interface IV8ValueReference
    
    Overrides:
    
    getType in class V8ValueObject
  - isCompiled
```
public boolean isCompiled()
                   throws JavetException
```
    Description copied from interface: IV8ValueFunction
    
    Is this function compiled.
    
    Specified by:
    
    isCompiled in interface IV8ValueFunction
    
    Returns:
    
    true : yes, false : no
    
    Throws:
    
    JavetException - the javet exception
  - isWrapped
```
public boolean isWrapped()
                  throws JavetException
```
    Description copied from interface: IV8ValueFunction
    
    Is wrapped function.
    Wrapped function means the source code is wrapped in the function.
    
    Specified by:
    
    isWrapped in interface IV8ValueFunction
    
    Returns:
    
    true : yes, false : no
    
    Throws:
    
    JavetException - the javet exception
  - setContext
```
public boolean setContext(V8Context v8Context)
                   throws JavetException
```
    Description copied from interface: IV8ValueFunction
    
    Sets the V8 context.
    
    Specified by:
    
    setContext in interface IV8ValueFunction
    
    Parameters:
    
    v8Context - the V8 context
    
    Returns:
    
    the V8 context
    
    Throws:
    
    JavetException - the javet exception
  - setScriptSource
```
public boolean setScriptSource(IV8ValueFunction.ScriptSource scriptSource,
                               boolean cloneScript)
                        throws JavetException
```
    Description copied from interface: IV8ValueFunction
    
    Sets script source.
    
    Specified by:
    
    setScriptSource in interface IV8ValueFunction
    
    Parameters:
    
    scriptSource - the script source
    
    cloneScript - the clone script
    
    Returns:
    
    true : success, false : failure
    
    Throws:
    
    JavetException - the javet exception
  - setSourceCode
```
public boolean setSourceCode(java.lang.String sourceCodeString,
                             IV8ValueFunction.SetSourceCodeOptions options)
                      throws JavetException
```
    Description copied from interface: IV8ValueFunction
    
    Sets source code with options.
    Note 1: The source code is shared among all function objects. So the caller is responsible for restoring the original source code, otherwise the next function call will likely fail because the source code of the next function call is incorrect. Note 2: The source code must be verified by compile(). Malformed source code will crash V8. Note 3: Sometimes the source code must not end with any of ' ', ';', '\n', though technically the source code is valid. Otherwise, V8 will crash.
    
    Specified by:
    
    setSourceCode in interface IV8ValueFunction
    
    Parameters:
    
    sourceCodeString - the source code string
    
    options - the options
    
    Returns:
    
    the source code
    
    Throws:
    
    JavetException - the javet exception

Class V8ValueFunction

Nested Class Summary

Nested classes/interfaces inherited from interface com.caoccao.javet.values.reference.IV8ValueFunction

Field Summary

Fields inherited from class com.caoccao.javet.values.reference.V8ValueObject

Fields inherited from class com.caoccao.javet.values.reference.V8ValueReference

Fields inherited from class com.caoccao.javet.values.V8Value

Fields inherited from interface com.caoccao.javet.values.reference.IV8ValueObject

Constructor Summary

Method Summary

Methods inherited from class com.caoccao.javet.values.reference.V8ValueObject

Methods inherited from class com.caoccao.javet.values.reference.V8ValueReference

Methods inherited from class com.caoccao.javet.values.V8Value

Methods inherited from class java.lang.Object

Methods inherited from interface com.caoccao.javet.values.reference.IV8ValueFunction

Methods inherited from interface com.caoccao.javet.values.reference.IV8ValueObject

Methods inherited from interface com.caoccao.javet.values.reference.IV8ValueReference

Methods inherited from interface com.caoccao.javet.values.IV8Value

Methods inherited from interface com.caoccao.javet.interfaces.IJavetClosable

Methods inherited from interface com.caoccao.javet.interop.IV8Cloneable

Field Detail

ERROR_THE_SOURCE_FUNCTION_CANNOT_BE_IN_ANOTHER_V8_RUNTIME

ERROR_THE_SOURCE_FUNCTION_CANNOT_BE_THE_CALLER

ERROR_V8_CONTEXT_CANNOT_BE_NULL

jsFunctionType

Constructor Detail

V8ValueFunction

Method Detail

callAsConstructor

callAsConstructor

callExtended

callExtended

canDiscardCompiled

copyScopeInfoFrom

discardCompiled

getArguments

getCachedData

getContext

getInternalProperties

getJSFunctionType

getJSScopeType

getScopeInfos

getScriptSource

getSourceCode

getType

isCompiled

isWrapped

setContext

setScriptSource

setSourceCode