Class DynamicObject.RemoveKeyNode

java.lang.Object

com.oracle.truffle.api.nodes.Node

com.oracle.truffle.api.object.DynamicObject.RemoveKeyNode

All Implemented Interfaces:

NodeInterface, Cloneable

Enclosing class:

DynamicObject

public abstract static class DynamicObject.RemoveKeyNode
extends Node

Removes the property with the given key from the object.

Since:

25.1

See Also:

• execute(DynamicObject, Object)

Nested Class Summary

Nested classes/interfaces inherited from class Node

Node.Child, Node.Children

Method Summary

Modifier and Type	Method	Description
static DynamicObject.RemoveKeyNode	create()
abstract boolean	execute(DynamicObject receiver, Object key)	Removes the property with the given key from the object.
static DynamicObject.RemoveKeyNode	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

Method Details

execute

public abstract boolean execute(DynamicObject receiver,
 Object key)

Removes the property with the given key from the object.

Usage example:

@ExportMessage
void removeMember(String member,
                @Cached @Shared DynamicObject.GetShapeFlagsNode getShapeFlagsNode,
                @Cached DynamicObject.RemoveKeyNode removeKeyNode) throws UnknownIdentifierException, UnsupportedMessageException {
    if ((getShapeFlagsNode.execute(this) & FROZEN) == FROZEN) {
        throw UnsupportedMessageException.create();
    }
    if (!removeKeyNode.execute(this, member)) {
        throw UnknownIdentifierException.create(member);
    }
}

Member name equality check omitted for brevity.

Parameters:

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

Returns:

true if the property was removed or false if property was not found

create

public static DynamicObject.RemoveKeyNode create()

Since:

25.1

getUncached

public static DynamicObject.RemoveKeyNode getUncached()

Since:

25.1