com.oracle.truffle.api.object

Class Location

java.lang.Object

com.oracle.truffle.api.object.Location

public abstract class Location
extends Object

Property location. Planned to be deprecated.

Since:

0.8 or earlier

See Also:

Shape, Property, DynamicObject

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
boolean	canSet(DynamicObject store, Object value) Returns true if the location can be set to the given value.
boolean	canSet(Object value) Returns true if the location can be set to the value.
boolean	canStore(Object value) Returns true if the location is compatible with the type of the value.
protected static boolean	checkShape(DynamicObject store, Shape shape) Equivalent to Shape.check(DynamicObject).
abstract boolean	equals(Object obj) Abstract to force overriding.
protected static FinalLocationException	finalLocation()
Object	get(DynamicObject store) Get object value as object at this location in store.
Object	get(DynamicObject store, boolean condition) Get object value as object at this location in store.
Object	get(DynamicObject store, Shape shape) Get object value as object at this location in store.
Assumption	getFinalAssumption() Returns the assumption that this location is final.
protected abstract Object	getInternal(DynamicObject store)
abstract int	hashCode() Abstract to force overriding.
protected static IncompatibleLocationException	incompatibleLocation()
boolean	isAssumedFinal() Returns true if this location is assumed to be final.
boolean	isConstant() Returns true if this is a constant value location.
boolean	isDeclared() Returns true if this is a declared value location.
boolean	isFinal() Returns true if this is a final location, i.e.
boolean	isValue() Returns true if this is a value location.
void	set(DynamicObject store, Object value) Set object value at this location in store.
void	set(DynamicObject store, Object value, Shape shape) Set object value at this location in store.
void	set(DynamicObject store, Object value, Shape oldShape, Shape newShape) Set object value at this location in store and update shape.
protected abstract void	setInternal(DynamicObject store, Object value) Like Location.set(DynamicObject, Object, Shape), but does not invalidate final locations.

Methods inherited from class java.lang.Object

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

Constructor Detail

Location

protected Location()

Constructor for subclasses.

Since:

0.8 or earlier

Method Detail

incompatibleLocation

protected static IncompatibleLocationException incompatibleLocation()
                                                             throws IncompatibleLocationException

Throws:

IncompatibleLocationException

Since:

0.8 or earlier

finalLocation

protected static FinalLocationException finalLocation()
                                               throws FinalLocationException

Throws:

FinalLocationException

Since:

0.8 or earlier

get

public final Object get(DynamicObject store,
                        Shape shape)

Get object value as object at this location in store.

Parameters:

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

Since:

0.8 or earlier

get

public Object get(DynamicObject store,
                  boolean condition)

Get object value as object at this location in store. For internal use only and subject to change, use Location.get(DynamicObject, Shape) instead.

Parameters:

condition - the result of a shape check or false

Since:

0.8 or earlier

See Also:

Location.get(DynamicObject, Shape)

get

public final Object get(DynamicObject store)

Get object value as object at this location in store.

Since:

0.8 or earlier

set

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

Set object value at this location in store.

Parameters:

shape - the current shape of the storage object

Throws:

IncompatibleLocationException - for storage type invalidations

FinalLocationException - for effectively final fields

Since:

0.8 or earlier

set

public void set(DynamicObject store,
                Object value,
                Shape oldShape,
                Shape newShape)
         throws IncompatibleLocationException

Set object value at this location in store and update shape.

Parameters:

oldShape - the shape before the transition

newShape - new shape after the transition

Throws:

IncompatibleLocationException - if value is of non-assignable type

Since:

0.8 or earlier

set

public final void set(DynamicObject store,
                      Object value)
               throws IncompatibleLocationException,
                      FinalLocationException

Set object value at this location in store.

Throws:

IncompatibleLocationException - for storage type invalidations

FinalLocationException - for effectively final fields

Since:

0.8 or earlier

getInternal

protected abstract Object getInternal(DynamicObject store)

Since:

0.8 or earlier

setInternal

protected abstract void setInternal(DynamicObject store,
                                    Object value)
                             throws IncompatibleLocationException

Like Location.set(DynamicObject, Object, Shape), but does not invalidate final locations. For internal use only and subject to change, use DynamicObjectFactory to create objects with predefined properties.

Throws:

IncompatibleLocationException - if value is of non-assignable type

Since:

0.8 or earlier

canSet

public boolean canSet(DynamicObject store,
                      Object value)

Returns true if the location can be set to the given value.

Parameters:

store - the receiver object

value - the value in question

Since:

0.8 or earlier

canSet

public boolean canSet(Object value)

Returns true if the location can be set to the value.

Parameters:

value - the value in question

Since:

0.8 or earlier

canStore

public boolean canStore(Object value)

Returns true if the location is compatible with the type of the value. The actual value may still be rejected if Location.canSet(DynamicObject, Object) returns false.

Parameters:

value - the value in question

Since:

0.8 or earlier

isFinal

public boolean isFinal()

Returns true if this is a final location, i.e. readonly once set.

Since:

0.8 or earlier

isConstant

public boolean isConstant()

Returns true if this is a constant value location.

Since:

0.8 or earlier

hashCode

public abstract int hashCode()

Abstract to force overriding.

Overrides:

hashCode in class Object

Since:

0.8 or earlier

equals

public abstract boolean equals(Object obj)

Abstract to force overriding.

Overrides:

equals in class Object

Since:

0.8 or earlier

isDeclared

public boolean isDeclared()

Returns true if this is a declared value location.

Since:

0.18

isValue

public boolean isValue()

Returns true if this is a value location.

Since:

0.18

See Also:

Location.isConstant(), Location.isDeclared()

isAssumedFinal

public boolean isAssumedFinal()

Returns true if this location is assumed to be final.

Since:

0.18

See Also:

Location.getFinalAssumption()

getFinalAssumption

public Assumption getFinalAssumption()

Returns the assumption that this location is final.

Since:

0.18

See Also:

Location.isAssumedFinal()

checkShape

protected static boolean checkShape(DynamicObject store,
                                    Shape shape)

Equivalent to Shape.check(DynamicObject).

Since:

0.8 or earlier