Class DynamicObject.PutAllNode

java.lang.Object

com.oracle.truffle.api.nodes.Node

com.oracle.truffle.api.object.DynamicObject.PutAllNode

All Implemented Interfaces:

NodeInterface, Cloneable

Enclosing class:

DynamicObject

public abstract static class DynamicObject.PutAllNode
extends Node

Adds or sets multiple properties in bulk. Behaves like DynamicObject.PutNode, but is usually more efficient for cases like object initialization where more than a few properties are added at once.

Cached nodes may retain the supplied keys array. Its elements must not be modified after being passed to a cached node, including between executions. Use a new array for different keys. Values and property flags arrays are not retained and may be modified between executions. No input array may be modified during execution.

Since:

25.1

See Also:

• execute(DynamicObject, Object[], Object[])
• executeIfAbsent(DynamicObject, Object[], Object[])
• executeIfPresent(DynamicObject, Object[], Object[])
• executeWithFlags(DynamicObject, Object[], Object[], int[])
• executeWithFlagsIfAbsent(DynamicObject, Object[], Object[], int[])
• executeWithFlagsIfPresent(DynamicObject, Object[], Object[], int[])
• DynamicObject.PutNode

Nested Class Summary

Nested classes/interfaces inherited from class Node

Node.Child, Node.Children

Constructor Summary

Constructors

Constructor	Description
PutAllNode()

Method Summary

Modifier and Type	Method	Description
static DynamicObject.PutAllNode	create()
final void	execute(DynamicObject receiver, Object[] keys, Object[] values)	Adds multiple properties or sets the values of multiple existing properties at once.
final void	executeIfAbsent(DynamicObject receiver, Object[] keys, Object[] values)	Like execute(DynamicObject, Object[], Object[]) but only adds properties that are absent.
final void	executeIfPresent(DynamicObject receiver, Object[] keys, Object[] values)	Like execute(DynamicObject, Object[], Object[]) but only sets properties that are already present.
final void	executeWithFlags(DynamicObject receiver, Object[] keys, Object[] values, int[] propertyFlags)	Like execute(DynamicObject, Object[], Object[]) but additionally sets property flags.
final void	executeWithFlagsIfAbsent(DynamicObject receiver, Object[] keys, Object[] values, int[] propertyFlags)	Like executeIfAbsent(DynamicObject, Object[], Object[]) but also sets property flags when adding a property.
final void	executeWithFlagsIfPresent(DynamicObject receiver, Object[] keys, Object[] values, int[] propertyFlags)	Like executeIfPresent(DynamicObject, Object[], Object[]) but also sets property flags when a property is present.
static DynamicObject.PutAllNode	getUncached()

Methods inherited from class Node

accept, adoptChildren, atomic, atomic, copy, deepCopy, getChildren, getCost, getDebugProperties, getDescription, getEncapsulatingSourceSection, getLock, getParent, getRootNode, getSourceSection, insert, insert, isAdoptable, isSafelyReplaceableBy, notifyInserted, onReplace, replace, replace, reportPolymorphicSpecialize, reportReplace, toString

Methods inherited from class Object

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

Constructor Details

PutAllNode

public PutAllNode()

Method Details

execute

public final void execute(DynamicObject receiver,
 Object[] keys,
 Object[] values)

Adds multiple properties or sets the values of multiple existing properties at once.

Newly added properties will have flags 0; flags of existing properties will not be changed. Use executeWithFlags(DynamicObject, Object[], Object[], int[]) to set property flags as well.

Cached property keys are compared by identity (==), not equality (equals).

Usage example:

Simple use of DynamicObject.PutAllNode to allocate and fill an object with properties.

abstract static class ObjectInitializerNode extends Node {
    @CompilationFinal private Shape initialShape;
    @CompilationFinal(dimensions = 1) private Object[] keys;
    @Children private ExprNode[] valueNodes;

    abstract void execute();

    @ExplodeLoop
    @Specialization
    void doDefault(@Cached DynamicObject.PutAllNode putAllNode) {
        var receiver = new MyDynamicObjectSubclass(initialShape);
        var values = new Object[keys.length];
        for (int i = 0; i < keys.length; i++) {
            values[i] = valueNodes[i].execute();
        }
        putAllNode.execute(receiver, keys, values);
    }
}

Parameters:

keys - the property keys, compared by identity (==), not equality (equals). See DynamicObject for more information.

values - the values to be set; needs to be the same length as keys

Since:

25.1

See Also:

• executeIfPresent(DynamicObject, Object[], Object[])
• executeWithFlags(DynamicObject, Object[], Object[], int[])

executeIfPresent

public final void executeIfPresent(DynamicObject receiver,
 Object[] keys,
 Object[] values)

Like execute(DynamicObject, Object[], Object[]) but only sets properties that are already present.

Since:

25.1

See Also:

• execute(DynamicObject, Object[], Object[])

executeIfAbsent

public final void executeIfAbsent(DynamicObject receiver,
 Object[] keys,
 Object[] values)

Like execute(DynamicObject, Object[], Object[]) but only adds properties that are absent.

Since:

25.1

See Also:

• execute(DynamicObject, Object[], Object[])

executeWithFlags

public final void executeWithFlags(DynamicObject receiver,
 Object[] keys,
 Object[] values,
 int[] propertyFlags)

Like execute(DynamicObject, Object[], Object[]) but additionally sets property flags. If a property already exists, its flags will be updated before the value is set.

Parameters:

keys - the property keys, compared by identity (==), not equality (equals). See DynamicObject for more information.

values - the values to be set; needs to be the same length as keys

propertyFlags - the property flags to be set; needs to be the same length as keys

Since:

25.1

executeWithFlagsIfPresent

public final void executeWithFlagsIfPresent(DynamicObject receiver,
 Object[] keys,
 Object[] values,
 int[] propertyFlags)

Like executeIfPresent(DynamicObject, Object[], Object[]) but also sets property flags when a property is present.

Since:

25.1

See Also:

• executeWithFlags(DynamicObject, Object[], Object[], int[])
• executeIfPresent(DynamicObject, Object[], Object[])

executeWithFlagsIfAbsent

public final void executeWithFlagsIfAbsent(DynamicObject receiver,
 Object[] keys,
 Object[] values,
 int[] propertyFlags)

Like executeIfAbsent(DynamicObject, Object[], Object[]) but also sets property flags when adding a property.

Since:

25.1

See Also:

• executeWithFlags(DynamicObject, Object[], Object[], int[])
• executeIfAbsent(DynamicObject, Object[], Object[])

getUncached

public static DynamicObject.PutAllNode getUncached()

create

public static DynamicObject.PutAllNode create()