com.oracle.truffle.api.object

Class DynamicObject

java.lang.Object

com.oracle.truffle.api.object.DynamicObject

All Implemented Interfaces:

TruffleObject

public abstract class DynamicObject
extends Object
implements TruffleObject

Represents an object members of which can be dynamically added and removed at run time.

Since:

0.8 or earlier

See Also:

Shape

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	DynamicObject(Shape shape) Constructor for subclasses.

Method Summary

Modifier and Type	Method and Description
boolean	containsKey(Object key) Returns true if this object contains a property with the given key.
abstract DynamicObject	copy(Shape currentShape) Create a shallow copy of this object.
void	define(Object key, Object value) Define new property or redefine existing property.
abstract void	define(Object key, Object value, int flags) Define new property or redefine existing property.
abstract void	define(Object key, Object value, int flags, LocationFactory locationFactory) Define new property with a static location or change existing property.
abstract boolean	delete(Object key) Delete property.
Object	get(Object key) Get property value.
abstract Object	get(Object key, Object defaultValue) Get property value.
Shape	getShape() Get the object's current shape.
abstract boolean	isEmpty() Returns true if this object contains no properties.
abstract boolean	set(Object key, Object value) Set value of existing property.
abstract void	setShapeAndGrow(Shape oldShape, Shape newShape) Set object shape and grow storage if necessary.
abstract void	setShapeAndResize(Shape oldShape, Shape newShape) Set object shape and resize storage if necessary.
abstract int	size() Returns the number of properties in this object.
abstract boolean	updateShape() Ensure object shape is up-to-date.

Methods inherited from class java.lang.Object

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

Constructor Detail

DynamicObject

protected DynamicObject(Shape shape)

Constructor for subclasses.

Since:

19.0

Method Detail

getShape

public final Shape getShape()

Get the object's current shape.

Since:

0.8 or earlier

get

public final Object get(Object key)

Get property value.

Parameters:

key - property identifier

Returns:

property value or null if object has no such property

Since:

0.8 or earlier

get

public abstract Object get(Object key,
                           Object defaultValue)

Get property value.

Parameters:

key - property identifier

defaultValue - return value if property is not found

Returns:

property value or defaultValue if object has no such property

Since:

0.8 or earlier

set

public abstract boolean set(Object key,
                            Object value)

Set value of existing property.

Parameters:

key - property identifier

value - value to be set

Returns:

true if successful or false if property not found

Since:

0.8 or earlier

containsKey

public final boolean containsKey(Object key)

Returns true if this object contains a property with the given key.

Since:

0.8 or earlier

define

public final void define(Object key,
                         Object value)

Define new property or redefine existing property.

Parameters:

key - property identifier

value - value to be set

Since:

0.8 or earlier

define

public abstract void define(Object key,
                            Object value,
                            int flags)

Define new property or redefine existing property.

Parameters:

key - property identifier

value - value to be set

flags - flags to be set

Since:

0.8 or earlier

define

public abstract void define(Object key,
                            Object value,
                            int flags,
                            LocationFactory locationFactory)

Define new property with a static location or change existing property.

Parameters:

key - property identifier

value - value to be set

flags - flags to be set

locationFactory - factory function that creates a location for a given shape and value

Since:

0.8 or earlier

delete

public abstract boolean delete(Object key)

Delete property.

Parameters:

key - property identifier

Returns:

true if successful or false if property not found

Since:

0.8 or earlier

size

public abstract int size()

Returns the number of properties in this object.

Since:

0.8 or earlier

isEmpty

public abstract boolean isEmpty()

Returns true if this object contains no properties.

Since:

0.8 or earlier

setShapeAndGrow

public abstract void setShapeAndGrow(Shape oldShape,
                                     Shape newShape)

Set object shape and grow storage if necessary.

Parameters:

oldShape - the object's current shape (must equal DynamicObject.getShape())

newShape - the new shape to be set

Since:

0.8 or earlier

setShapeAndResize

public abstract void setShapeAndResize(Shape oldShape,
                                       Shape newShape)

Set object shape and resize storage if necessary.

Parameters:

oldShape - the object's current shape (must equal DynamicObject.getShape())

newShape - the new shape to be set

Since:

0.8 or earlier

updateShape

public abstract boolean updateShape()

Ensure object shape is up-to-date.

Returns:

true if shape has changed

Since:

0.8 or earlier

copy

public abstract DynamicObject copy(Shape currentShape)

Create a shallow copy of this object.

Parameters:

currentShape - the object's current shape (must equal DynamicObject.getShape())

Since:

0.8 or earlier