com.oracle.truffle.api.object

Class Shape.DerivedBuilder

java.lang.Object

com.oracle.truffle.api.object.Shape.DerivedBuilder

Enclosing class:

Shape

public static final class Shape.DerivedBuilder
extends Object

Builder class to construct derived Shape instances. The builder instance is not thread-safe and must not be used from multiple threads at the same time.

Since:

20.2.0

See Also:

Shape.newBuilder(Shape)

Method Summary

Modifier and Type	Method and Description
Shape.DerivedBuilder	addConstantProperty(Object key, Object value, int flags) Adds a property with a constant value to the shape.
Shape	build() Builds a derived shape from the base shape supplied to the constructor using the configuration of this builder.
Shape.DerivedBuilder	dynamicType(Object dynamicType) Sets initial dynamic object type identifier.
Shape.DerivedBuilder	shapeFlags(int flags) Sets initial shape flags (default: 0).

Methods inherited from class java.lang.Object

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

Method Detail

dynamicType

public Shape.DerivedBuilder dynamicType(Object dynamicType)

Sets initial dynamic object type identifier. See DynamicObjectLibrary.setDynamicType(DynamicObject, Object) for more information.

Parameters:

dynamicType - a non-null object type identifier

Throws:

NullPointerException - if the type is null

IllegalArgumentException

Since:

20.2.0

See Also:

DynamicObjectLibrary.getDynamicType(DynamicObject), DynamicObjectLibrary.setDynamicType(DynamicObject, Object)

shapeFlags

public Shape.DerivedBuilder shapeFlags(int flags)

Sets initial shape flags (default: 0). Currently limited to 8 bits. See DynamicObjectLibrary.setShapeFlags(DynamicObject, int) for more information.

Parameters:

flags - an int value in the range from 0 to 255 (inclusive)

Throws:

IllegalArgumentException - if the flags value is not in the supported range

Since:

20.2.0

See Also:

DynamicObjectLibrary.getShapeFlags(DynamicObject), DynamicObjectLibrary.setShapeFlags(DynamicObject, int)

addConstantProperty

public Shape.DerivedBuilder addConstantProperty(Object key,
                                                Object value,
                                                int flags)

Adds a property with a constant value to the shape. The key must not be null and must not be equal to any previously added property's key.

Parameters:

key - the property's key

value - the property's value

flags - the property's flags

Throws:

NullPointerException - if the key is null

IllegalArgumentException - if a property with the key already exists

Since:

20.2.0

See Also:

DynamicObjectLibrary.putConstant(DynamicObject, Object, Object, int)

build

public Shape build()

Builds a derived shape from the base shape supplied to the constructor using the configuration of this builder.

Returns:

a new or cached shape

Since:

20.2.0