Class DynamicObject.GetNode

java.lang.Object

com.oracle.truffle.api.nodes.Node

com.oracle.truffle.api.object.DynamicObject.GetNode

All Implemented Interfaces:

NodeInterface, Cloneable

Enclosing class:

DynamicObject

public abstract static class DynamicObject.GetNode
extends Node

Gets the value of a property or returns a default value if no such property exists.

Specialized return type variants are available for when a primitive result is expected.

Since:

25.1

See Also:

• execute(DynamicObject, Object, Object)
• executeInt(DynamicObject, Object, Object)
• executeLong(DynamicObject, Object, Object)
• executeDouble(DynamicObject, Object, Object)

Nested Class Summary

Nested classes/interfaces inherited from class Node

Node.Child, Node.Children

Method Summary

Modifier and Type	Method	Description
static DynamicObject.GetNode	create()
abstract Object	execute(DynamicObject receiver, Object key, Object defaultValue)	Gets the value of an existing property or returns the provided default value if no such property exists.
abstract double	executeDouble(DynamicObject receiver, Object key, Object defaultValue)	Gets the value of an existing property or returns the provided default value if no such property exists.
abstract int	executeInt(DynamicObject receiver, Object key, Object defaultValue)	Gets the value of an existing property or returns the provided default value if no such property exists.
abstract long	executeLong(DynamicObject receiver, Object key, Object defaultValue)	Gets the value of an existing property or returns the provided default value if no such property exists.
static DynamicObject.GetNode	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 Object execute(DynamicObject receiver,
 Object key,
 Object defaultValue)

Gets the value of an existing property or returns the provided default value if no such property exists.

Usage examples:

Simple use of DynamicObject.GetNode with a pre-interned symbol key.

abstract static class GetSimpleNode extends Node {
    abstract Object execute(DynamicObject receiver, Object key);

    @Specialization
    static Object doCached(MyDynamicObjectSubclass receiver, Symbol key,
                    @Cached DynamicObject.GetNode getNode) {
        return getNode.execute(receiver, key, NULL_VALUE);
    }
}

Simple use of DynamicObject.GetNode with a string key cached by equality.

abstract static class GetStringKeyNode extends Node {
    abstract Object execute(DynamicObject receiver, Object key);

    @Specialization(guards = "equalNode.execute(key, cachedKey, UTF_16)", limit = "3")
    static Object doCached(MyDynamicObjectSubclass receiver, TruffleString key,
                    @Cached("key") TruffleString cachedKey,
                    @Cached TruffleString.EqualNode equalNode,
                    @Cached DynamicObject.GetNode getNode) {
        return getNode.execute(receiver, cachedKey, NULL_VALUE);
    }
}

Parameters:

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

defaultValue - value to be returned if the property does not exist

Returns:

the property's value if it exists, else defaultValue.

Since:

25.1

executeInt

public abstract int executeInt(DynamicObject receiver,
 Object key,
 Object defaultValue)
                        throws UnexpectedResultException

Gets the value of an existing property or returns the provided default value if no such property exists.

Parameters:

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

defaultValue - the value to be returned if the property does not exist

Returns:

the property's value if it exists, else defaultValue.

Throws:

UnexpectedResultException - if the value (or default value if the property is missing) is not an int

Since:

25.1

See Also:

• execute(DynamicObject, Object, Object)

executeLong

public abstract long executeLong(DynamicObject receiver,
 Object key,
 Object defaultValue)
                          throws UnexpectedResultException

Gets the value of an existing property or returns the provided default value if no such property exists.

Parameters:

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

defaultValue - the value to be returned if the property does not exist

Returns:

the property's value if it exists, else defaultValue.

Throws:

UnexpectedResultException - if the value (or default value if the property is missing) is not an long

Since:

25.1

See Also:

• execute(DynamicObject, Object, Object)

executeDouble

public abstract double executeDouble(DynamicObject receiver,
 Object key,
 Object defaultValue)
                              throws UnexpectedResultException

Gets the value of an existing property or returns the provided default value if no such property exists.

Parameters:

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

defaultValue - the value to be returned if the property does not exist

Returns:

the property's value if it exists, else defaultValue.

Throws:

UnexpectedResultException - if the value (or default value if the property is missing) is not an double

Since:

25.1

See Also:

• execute(DynamicObject, Object, Object)

create

public static DynamicObject.GetNode create()

Since:

25.1

getUncached

public static DynamicObject.GetNode getUncached()

Since:

25.1