com.caoccao.javet.enums

Enum V8MicrotasksPolicy

java.lang.Object

java.lang.Enum<V8MicrotasksPolicy>

com.caoccao.javet.enums.V8MicrotasksPolicy

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<V8MicrotasksPolicy>

public enum V8MicrotasksPolicy
extends java.lang.Enum<V8MicrotasksPolicy>

The enum V8 microtasks policy represents how the microtasks of a V8 isolate are invoked.

The ids are aligned with v8::MicrotasksPolicy.

Since:

6.0.1

Enum Constant Summary

Enum Constants

Enum Constant and Description
Auto Microtasks are invoked when the JavaScript call depth decrements to zero.
Explicit Microtasks are only invoked by an explicit microtask checkpoint.
Scoped Microtasks invocation is controlled by v8::MicrotasksScope objects.

Method Summary

Modifier and Type	Method and Description
int	getId() Gets id.
java.lang.String	getName() Gets name.
static V8MicrotasksPolicy	parse(int id) Parse microtasks policy from id.
static V8MicrotasksPolicy	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static V8MicrotasksPolicy[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Explicit

public static final V8MicrotasksPolicy Explicit

Microtasks are only invoked by an explicit microtask checkpoint.

Nothing drains the microtask queue automatically, so the promise jobs stay pending until the checkpoint is performed. It allows a batch of calls to be made against the V8 runtime before the pending promise jobs are drained in one go.

Since:

6.0.1

Scoped

public static final V8MicrotasksPolicy Scoped

Microtasks invocation is controlled by v8::MicrotasksScope objects.

Javet never creates a v8::MicrotasksScope, hence this policy is not supported. It is defined here only so that the policy reported by V8 can always be represented.

Since:

6.0.1

Auto

public static final V8MicrotasksPolicy Auto

Microtasks are invoked when the JavaScript call depth decrements to zero.

It is the default policy in the V8 mode. Every call made against the V8 runtime is a call depth boundary of its own, so the microtask queue is drained as soon as that call returns.

Since:

6.0.1

Method Detail

values

public static V8MicrotasksPolicy[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (V8MicrotasksPolicy c : V8MicrotasksPolicy.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static V8MicrotasksPolicy valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

parse

public static V8MicrotasksPolicy parse(int id)

Parse microtasks policy from id.

Parameters:

id - the id

Returns:

the V8 microtasks policy

Since:

6.0.1

getId

public int getId()

Gets id.

Returns:

the id

Since:

6.0.1

getName

public java.lang.String getName()

Gets name.

Returns:

the name

Since:

6.0.1