V8Object (j2v8 3.1.2 API)

java.lang.Object
- com.eclipsesource.v8.V8Value
- - com.eclipsesource.v8.V8Object

All Implemented Interfaces:

Releasable

Direct Known Subclasses:

V8, V8Array, V8Function
```
public class V8Object
extends V8Value
```
The concrete class for all V8 Objects. V8Objects are JavaScript objects accessible in java. Specialized subclasses exist for V8Arrays and V8Functions. V8Object are JavaScript object with key value pairs. Specific get methods exist to access values as primitives. General get methods also exist, which return Java Objects and can be casted to the correct subclass. V8Object have native resources and must be released when they are no longer need in Java.

Field Summary
- Fields inherited from class com.eclipsesource.v8.V8Value
  BOOLEAN, DOUBLE, INTEGER, NULL, objectHandle, released, STRING, UNDEFINED, UNKNOWN, v8, V8_ARRAY, V8_FUNCTION, V8_OBJECT

Constructor Summary

Constructors
Modifier Constructor and Description

protected V8Object()

V8Object(V8 v8)
Create a new V8Object and associate it with a runtime.

Constructors
Modifier	Constructor and Description
`protected`	`V8Object()`
	`V8Object(V8 v8)` Create a new V8Object and associate it with a runtime.

Method Summary

Methods
Modifier and Type	Method and Description
`V8Object`	`add(String key, boolean value)` Adds a key value pair to the receiver where the value is a boolean.
`V8Object`	`add(String key, double value)` Adds a key value pair to the receiver where the value is a double.
`V8Object`	`add(String key, int value)` Adds a key value pair to the receiver where the value is an integer.
`V8Object`	`add(String key, String value)` Adds a key value pair to the receiver where the value is a String.
`V8Object`	`add(String key, V8Value value)` Adds a key value pair to the receiver where the value is a V8Value.
`V8Object`	`addNull(String key)` Associate NULL with the given key.
`V8Object`	`addUndefined(String key)` Associate UNDEFINED with the given key.
`boolean`	`contains(String key)` Determine if a key/value pair with this key exists in the Object.
`protected V8Value`	`createTwin()`
`V8Array`	`executeArrayFunction(String name, V8Array parameters)` Invoke a JavaScript function and return the result as a V8Array.
`boolean`	`executeBooleanFunction(String name, V8Array parameters)` Invoke a JavaScript function and return the result as a boolean.
`double`	`executeDoubleFunction(String name, V8Array parameters)` Invoke a JavaScript function and return the result as a double.
`Object`	`executeFunction(String name, V8Array parameters)` Invoke a JavaScript function and return the result as a Java Object.
`int`	`executeIntegerFunction(String name, V8Array parameters)` Invoke a JavaScript function and return the result as a integer.
`V8Object`	`executeObjectFunction(String name, V8Array parameters)` Invoke a JavaScript function and return the result as a V8Object.
`String`	`executeStringFunction(String name, V8Array parameters)` Invoke a JavaScript function and return the result as a String.
`void`	`executeVoidFunction(String name, V8Array parameters)` Invokes a JavaScript function which does not return a result.
`Object`	`get(String key)` Returns the value associated with this key.
`V8Array`	`getArray(String key)` Returns the V8Array value associated with this key.
`boolean`	`getBoolean(String key)` Returns the boolean value associated with this key.
`double`	`getDouble(String key)` Returns the double value associated with this key.
`int`	`getInteger(String key)` Returns the integer value associated with this key.
`String[]`	`getKeys()` Returns all the keys associated with this JavaScript Object.
`V8Object`	`getObject(String key)` Returns the V8Object value associated with this key.
`String`	`getString(String key)` Returns the String value associated with this key.
`int`	`getType(String key)` Returns the type of the value associated with this Key, or UNDEFINED if the key does not exist.
`V8Object`	`registerJavaMethod(JavaCallback callback, String jsFunctionName)` Register a Java method as a JavaScript function.
`V8Object`	`registerJavaMethod(JavaVoidCallback callback, String jsFunctionName)` Register a void Java method as a JavaScript function.
`V8Object`	`registerJavaMethod(Object object, String methodName, String jsFunctionName, Class<?>[] parameterTypes)` Register a Java method reflectively given it's name a signature.
`V8Object`	`registerJavaMethod(Object object, String methodName, String jsFunctionName, Class<?>[] parameterTypes, boolean includeReceiver)` Register a Java method reflectively given it's name a signature.
`V8Object`	`setPrototype(V8Object value)` Sets the prototype of the receiver.
`String`	`toString()`
`V8Object`	`twin()` Creates a new Java object pointing at the same V8 Value as this.

Methods inherited from class com.eclipsesource.v8.V8Value
checkReleaesd, equals, getHandle, getRuntime, getRutime, hashCode, initialize, isReleased, isUndefined, jsEquals, release, strictEquals

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

- Constructor Detail
  - V8Object
```
public V8Object(V8 v8)
```
    Create a new V8Object and associate it with a runtime. Once created, it must be released.
    
    Parameters:
    v8 - The runtime on which to associate the V8Object.
  - V8Object
```
protected V8Object()
```
- Method Detail
  - createTwin
```
protected V8Value createTwin()
```
    Specified by:
    
    createTwin in class V8Value
  - twin
```
public V8Object twin()
```
    Description copied from class: V8Value
    
    Creates a new Java object pointing at the same V8 Value as this. If the value is mutated (by adding new members or changing existing ones) then both the original and twin will be updated. Twins are .equal and .strict equals, but not == in Java. Twins must be released separately since they have their own native resources.
    
    Overrides:
    
    twin in class V8Value
    
    Returns:
    A new Java object pointing at the same V8 Value as this.
  - contains
```
public boolean contains(String key)
```
    Determine if a key/value pair with this key exists in the Object.
    
    Parameters:
    key - The key to check
    
    Returns:
    True if the key exists, false otherwise.
  - getKeys
```
public String[] getKeys()
```
    Returns all the keys associated with this JavaScript Object. Keys associated with the objects prototype are not returned.
    
    Returns:
    The keys associated with this JavaScript Object.
  - getType
```
public int getType(String key)
```
    Returns the type of the value associated with this Key, or UNDEFINED if the key does not exist. Types are specified as integer constants. The types are all defined in V8Value.
    
    Parameters:
    key - The key whose type to lookup.
    
    Returns:
    The Type of the value associated with this key
  - get
```
public Object get(String key)
```
    Returns the value associated with this key. Values are Java Objects. If the value is a primitive, its boxed type is returned. If the value is a V8Value, it must be released.
    
    Parameters:
    key - The key whose value to return.
    
    Returns:
    The value associated with this key.
  - getInteger
```
public int getInteger(String key)
```
    Returns the integer value associated with this key. If the value associated with this key does not exist, or if it's not an integer, then V8ResultUndefined exception is thrown.
    
    Parameters:
    key - The key whose value to return.
    
    Returns:
    The integer value associated with this key, or V8ResultUndefined if the key does not exist or the value is not an integer.
  - getBoolean
```
public boolean getBoolean(String key)
```
    Returns the boolean value associated with this key. If the value associated with this key does not exist, or if it's not a boolean, then V8ResultUndefined exception is thrown.
    
    Parameters:
    key - The key whose value to return.
    
    Returns:
    The boolean value associated with this key, or V8ResultUndefined if the key does not exist or the value is not a boolean.
  - getDouble
```
public double getDouble(String key)
```
    Returns the double value associated with this key. If the value associated with this key does not exist, or if it's not a double, then V8ResultUndefined exception is thrown.
    
    Parameters:
    key - The key whose value to return.
    
    Returns:
    The double value associated with this key, or V8ResultUndefined if the key does not exist or the value is not a double.
  - getString
```
public String getString(String key)
```
    Returns the String value associated with this key. If the value associated with this key does not exist, or if it's not a String, then V8ResultUndefined exception is thrown.
    
    Parameters:
    key - The key whose value to return.
    
    Returns:
    The String value associated with this key, or V8ResultUndefined if the key does not exist or the value is not a String.
  - getArray
```
public V8Array getArray(String key)
```
    Returns the V8Array value associated with this key. If the value associated with this key does not exist then UNDEFINED is returned. If the value exists but is not an array then V8ResultUndefined exception is thrown.
    
    Parameters:
    key - The key whose value to return.
    
    Returns:
    The V8Array value associated with this key.
  - getObject
```
public V8Object getObject(String key)
```
    Returns the V8Object value associated with this key. If the value associated with this key does not exist then UNDEFINED is returned. If the value exists but is not an JS Object then V8ResultUndefined exception is thrown.
    
    Parameters:
    key - The key whose value to return.
    
    Returns:
    The V8Object value associated with this key.
  - executeIntegerFunction
```
public int executeIntegerFunction(String name,
                         V8Array parameters)
```
    Invoke a JavaScript function and return the result as a integer. If the result is not an integer, or does not exist, then V8ResultUndefined is thrown.
    
    Parameters:
    name - The name of the JS Function to call.
    parameters - The parameters to pass to the function. Parameters must be released.
    
    Returns:
    An integer representing the result of the function call or V8ResultUndefined if the result is not an integer.
  - executeDoubleFunction
```
public double executeDoubleFunction(String name,
                           V8Array parameters)
```
    Invoke a JavaScript function and return the result as a double. If the result is not a double, or does not exist, then V8ResultUndefined is thrown.
    
    Parameters:
    name - The name of the JS Function to call.
    parameters - The parameters to pass to the function. Parameters must be released.
    
    Returns:
    A double representing the result of the function call or V8ResultUndefined if the result is not a double.
  - executeStringFunction
```
public String executeStringFunction(String name,
                           V8Array parameters)
```
    Invoke a JavaScript function and return the result as a String. If the result is not a String, or does not exist, then V8ResultUndefined is thrown.
    
    Parameters:
    name - The name of the JS Function to call.
    parameters - The parameters to pass to the function. Parameters must be released.
    
    Returns:
    A String representing the result of the function call or V8ResultUndefined if the result is not a String.
  - executeBooleanFunction
```
public boolean executeBooleanFunction(String name,
                             V8Array parameters)
```
    Invoke a JavaScript function and return the result as a boolean. If the result is not a boolean, or does not exist, then V8ResultUndefined is thrown.
    
    Parameters:
    name - The name of the JS Function to call.
    parameters - The parameters to pass to the function. Parameters must be released.
    
    Returns:
    A boolean representing the result of the function call or V8ResultUndefined if the result is not a boolean.
  - executeArrayFunction
```
public V8Array executeArrayFunction(String name,
                           V8Array parameters)
```
    Invoke a JavaScript function and return the result as a V8Array. If the result is not a V8Array then V8ResultUndefined is thrown.
    
    Parameters:
    name - The name of the JS Function to call.
    parameters - The parameters to pass to the function. Parameters must be released.
    
    Returns:
    A V8Array representing the result of the function call or V8ResultUndefined if the result is not a V8Array. The result must be released.
  - executeObjectFunction
```
public V8Object executeObjectFunction(String name,
                             V8Array parameters)
```
    Invoke a JavaScript function and return the result as a V8Object. If the result is not a V8Object then V8ResultUndefined is thrown.
    
    Parameters:
    name - The name of the JS Function to call.
    parameters - The parameters to pass to the function. Parameters must be released.
    
    Returns:
    A V8Object representing the result of the function call or V8ResultUndefined if the result is not a V8Object. The result must be released.
  - executeFunction
```
public Object executeFunction(String name,
                     V8Array parameters)
```
    Invoke a JavaScript function and return the result as a Java Object.
    
    Parameters:
    name - The name of the JS Function to call.
    parameters - The parameters to pass to the function. Parameters must be released.
    
    Returns:
    A Java Object representing the result of the function call.
  - executeVoidFunction
```
public void executeVoidFunction(String name,
                       V8Array parameters)
```
    Invokes a JavaScript function which does not return a result.
    
    Parameters:
    name - The name of the JS Function to call.
    parameters - The parameters to pass to the function. Parameters must be released.
  - add
```
public V8Object add(String key,
           int value)
```
    Adds a key value pair to the receiver where the value is an integer.
    
    Parameters:
    key - The key to associate the value with.
    value - The value to add.
    
    Returns:
    The receiver.
  - add
```
public V8Object add(String key,
           boolean value)
```
    Adds a key value pair to the receiver where the value is a boolean.
    
    Parameters:
    key - The key to associate the value with.
    value - The value to add.
    
    Returns:
    The receiver.
  - add
```
public V8Object add(String key,
           double value)
```
    Adds a key value pair to the receiver where the value is a double.
    
    Parameters:
    key - The key to associate the value with.
    value - The value to add.
    
    Returns:
    The receiver.
  - add
```
public V8Object add(String key,
           String value)
```
    Adds a key value pair to the receiver where the value is a String.
    
    Parameters:
    key - The key to associate the value with.
    value - The value to add.
    
    Returns:
    The receiver.
  - add
```
public V8Object add(String key,
           V8Value value)
```
    Adds a key value pair to the receiver where the value is a V8Value.
    
    Parameters:
    key - The key to associate the value with.
    value - The value to add.
    
    Returns:
    The receiver.
  - addUndefined
```
public V8Object addUndefined(String key)
```
    Associate UNDEFINED with the given key.
    
    Parameters:
    key - The key to associate UNDEFINED with.
    
    Returns:
    The receiver.
  - addNull
```
public V8Object addNull(String key)
```
    Associate NULL with the given key.
    
    Parameters:
    key - The key to associate NULL with.
    
    Returns:
    The receiver.
  - setPrototype
```
public V8Object setPrototype(V8Object value)
```
    Sets the prototype of the receiver.
    
    Parameters:
    value - The prototype to associate with this V8Object.
    
    Returns:
    The receiver.
  - registerJavaMethod
```
public V8Object registerJavaMethod(JavaCallback callback,
                          String jsFunctionName)
```
    Register a Java method as a JavaScript function. When the JS Function is invoked the Java method will be called.
    
    Parameters:
    callback - The JavaCallback to call when the JSFunction is invoked.
    jsFunctionName - The name of the JSFunction.
    
    Returns:
    The receiver.
  - registerJavaMethod
```
public V8Object registerJavaMethod(JavaVoidCallback callback,
                          String jsFunctionName)
```
    Register a void Java method as a JavaScript function. When the JS Function is invoked the Java method will be called.
    
    Parameters:
    callback - The JavaVoidCallback to call when the JSFunction is invoked.
    jsFunctionName - The name of the JSFunction.
    
    Returns:
    The receiver.
  - registerJavaMethod
```
public V8Object registerJavaMethod(Object object,
                          String methodName,
                          String jsFunctionName,
                          Class<?>[] parameterTypes)
```
    Register a Java method reflectively given it's name a signature.
    
    Parameters:
    object - The Java Object on which the method is defined.
    methodName - The name of the method to register.
    jsFunctionName - The name of the JavaScript function to register the method with.
    parameterTypes - The parameter types of the method.
    
    Returns:
    The receiver.
  - registerJavaMethod
```
public V8Object registerJavaMethod(Object object,
                          String methodName,
                          String jsFunctionName,
                          Class<?>[] parameterTypes,
                          boolean includeReceiver)
```
    Register a Java method reflectively given it's name a signature. The option to include the JS Object in the callback can be specified by setting includeReceiver true.
    
    Parameters:
    object - The Java Object on which the method is defined.
    methodName - The name of the method to register.
    jsFunctionName - The name of the JavaScript function to register the method with.
    parameterTypes - The parameter types of the method.
    includeReceiver - True if the first parameter should include the JS Object, false otherwise.
    
    Returns:
    The receiver.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class V8Object

Field Summary

Fields inherited from class com.eclipsesource.v8.V8Value

Constructor Summary

Method Summary

Methods inherited from class com.eclipsesource.v8.V8Value

Methods inherited from class java.lang.Object

Constructor Detail

V8Object

V8Object

Method Detail

createTwin

twin

contains

getKeys

getType

get

getInteger

getBoolean

getDouble

getString

getArray

getObject

executeIntegerFunction

executeDoubleFunction

executeStringFunction

executeBooleanFunction

executeArrayFunction

executeObjectFunction

executeFunction

executeVoidFunction

add

add

add

add

add

addUndefined

addNull

setPrototype

registerJavaMethod

registerJavaMethod

registerJavaMethod

registerJavaMethod

toString