com.oracle.truffle.api.object

Class Property

java.lang.Object

com.oracle.truffle.api.object.Property

public abstract class Property
extends Object

Property objects represent the mapping between property identifiers (keys) and storage locations. Optionally, properties may have metadata attached to them.

Since:

0.8 or earlier

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Property() Constructor for subclasses.

Method Summary

Modifier and Type	Method and Description
static Property	create(Object key, Location location, int flags) Create a new property.
abstract Object	get(DynamicObject store, boolean condition) Gets the value of this property of the object.
abstract Object	get(DynamicObject store, Shape shape) Gets the value of this property of the object.
abstract int	getFlags() Get property flags, which are free for language-specific use.
abstract Object	getKey() Get property identifier.
abstract Location	getLocation() Get the property location.
abstract boolean	isHidden() Is this property hidden from iteration.
abstract void	set(DynamicObject store, Object value, Shape shape) Assigns value to this property of the object.
abstract void	setGeneric(DynamicObject store, Object value, Shape shape) Assigns value to this property of the object.
abstract void	setSafe(DynamicObject store, Object value, Shape shape) Like Property.set(DynamicObject, Object, Shape), but throws an IllegalStateException instead.
abstract void	setSafe(DynamicObject store, Object value, Shape oldShape, Shape newShape) Assigns value to this property of the object, changing the object's shape.

Methods inherited from class java.lang.Object

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

Constructor Detail

Property

protected Property()

Constructor for subclasses.

Since:

0.8 or earlier

Method Detail

create

public static Property create(Object key,
                              Location location,
                              int flags)

Create a new property.

Parameters:

key - the key of the property

location - location of the property

flags - for language-specific use

Returns:

new instance of the property

Since:

0.8 or earlier

getKey

public abstract Object getKey()

Get property identifier.

Since:

0.8 or earlier

getFlags

public abstract int getFlags()

Get property flags, which are free for language-specific use.

Since:

0.8 or earlier

get

public abstract Object get(DynamicObject store,
                           Shape shape)

Gets the value of this property of the object. Planned to be deprecated.

Parameters:

store - the store that this property resides in

shape - the current shape of the object, which must contain this location

Since:

0.8 or earlier

See Also:

DynamicObjectLibrary.getOrDefault(DynamicObject, Object, Object)

get

public abstract Object get(DynamicObject store,
                           boolean condition)

Gets the value of this property of the object. Planned to be deprecated.

Parameters:

store - the store that this property resides in

condition - the result of a shape check or false

Since:

0.8 or earlier

See Also:

DynamicObjectLibrary.getOrDefault(DynamicObject, Object, Object), Property.get(DynamicObject, Shape)

set

public abstract void set(DynamicObject store,
                         Object value,
                         Shape shape)
                  throws IncompatibleLocationException,
                         FinalLocationException

Assigns value to this property of the object. Throws an exception if the value cannot be assigned to the property's current location. Planned to be deprecated.

Parameters:

store - the store that this property resides in

value - the value to assign

shape - the current shape of the object or null

Throws:

IncompatibleLocationException - if the value is incompatible with the property location

FinalLocationException - if the location is final and values differ

Since:

0.8 or earlier

See Also:

DynamicObjectLibrary.put(DynamicObject, Object, Object)

setGeneric

public abstract void setGeneric(DynamicObject store,
                                Object value,
                                Shape shape)

Assigns value to this property of the object. Automatically relocates the property if the value cannot be assigned to its current location. Planned to be deprecated.

Parameters:

shape - the current shape of the object or null

Since:

0.8 or earlier

setSafe

public abstract void setSafe(DynamicObject store,
                             Object value,
                             Shape shape)

Like Property.set(DynamicObject, Object, Shape), but throws an IllegalStateException instead. Planned to be deprecated.

Since:

0.8 or earlier

setSafe

public abstract void setSafe(DynamicObject store,
                             Object value,
                             Shape oldShape,
                             Shape newShape)

Assigns value to this property of the object, changing the object's shape. Combines setShapeAndGrow and Property.setSafe(DynamicObject, Object, Shape) to an atomic operation. Planned to be deprecated.

Parameters:

store - the store that this property resides in

value - the value to assign

oldShape - the shape before the transition

newShape - the shape after the transition

Since:

0.8 or earlier

getLocation

public abstract Location getLocation()

Get the property location. Planned to be deprecated.

Since:

0.8 or earlier

isHidden

public abstract boolean isHidden()

Is this property hidden from iteration.

Since:

0.8 or earlier

See Also:

HiddenKey