com.oracle.truffle.object

Class LocationImpl

java.lang.Object

com.oracle.truffle.api.object.Location

com.oracle.truffle.object.LocationImpl

Direct Known Subclasses:

Locations.ValueLocation

public abstract class LocationImpl
extends Location

Since:

0.17 or earlier

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	LocationImpl.InternalLongLocation
static interface	LocationImpl.LocationVisitor

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LocationImpl()

Method Summary

Modifier and Type	Method and Description
abstract void	accept(LocationImpl.LocationVisitor locationVisitor) Accept a visitor for location allocation for this and every nested location.
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 boolean	canStoreFinal(DynamicObject store, Object value)
boolean	equals(Object obj) Abstract to force overriding.
protected Object	getInternal(DynamicObject store)
protected String	getWhereString()
int	hashCode() Abstract to force overriding.
boolean	isConstant() Returns true if this is a constant value location.
boolean	isFinal() Returns true if this is a final location, i.e.
int	objectArrayCount() Get the number of object array elements this location requires.
int	objectFieldCount() Get the number of in-object Object fields this location requires.
int	primitiveArrayCount() Get the number of primitive array elements this location requires.
int	primitiveFieldCount() Get the number of in-object primitive fields this location requires.
void	set(DynamicObject store, Object value, Shape shape) Set object value at this location in store.
protected abstract void	setInternal(DynamicObject store, Object value) Like Location.set(DynamicObject, Object, Shape), but does not invalidate final locations.
String	toString()
static boolean	valueEquals(Object val1, Object val2) Boxed values need to be compared by value not by reference.

Methods inherited from class com.oracle.truffle.api.object.Location

checkShape, finalLocation, get, get, get, getFinalAssumption, incompatibleLocation, isAssumedFinal, isDeclared, isValue, set, set

Methods inherited from class java.lang.Object

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

Constructor Detail

LocationImpl

protected LocationImpl()

Since:

0.17 or earlier

Method Detail

set

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

Description copied from class: Location

Set object value at this location in store.

Overrides:

set in class Location

shape - the current shape of the storage object

Throws:

IncompatibleLocationException - for storage type invalidations

FinalLocationException - for effectively final fields

Since:

0.17 or earlier

getInternal

protected final Object getInternal(DynamicObject store)

Specified by:

getInternal in class Location

Since:

0.17 or earlier

setInternal

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

Description copied from class: Location

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.

Specified by:

setInternal in class Location

Throws:

IncompatibleLocationException - if value is of non-assignable type

Since:

0.17 or earlier

canSet

public boolean canSet(DynamicObject store,
                      Object value)

Description copied from class: Location

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

Overrides:

canSet in class Location

Parameters:

store - the receiver object

value - the value in question

Since:

0.17 or earlier

canSet

public boolean canSet(Object value)

Description copied from class: Location

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

Overrides:

canSet in class Location

Parameters:

value - the value in question

Since:

0.17 or earlier

canStore

public boolean canStore(Object value)

Description copied from class: Location

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.

Overrides:

canStore in class Location

Parameters:

value - the value in question

Since:

0.17 or earlier

canStoreFinal

protected boolean canStoreFinal(DynamicObject store,
                                Object value)

Since:

0.17 or earlier

isFinal

public boolean isFinal()

Description copied from class: Location

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

Overrides:

isFinal in class Location

Since:

0.17 or earlier

isConstant

public boolean isConstant()

Description copied from class: Location

Returns true if this is a constant value location.

Overrides:

isConstant in class Location

Since:

0.17 or earlier

hashCode

public int hashCode()

Description copied from class: Location

Abstract to force overriding.

Specified by:

hashCode in class Location

Since:

0.17 or earlier

equals

public boolean equals(Object obj)

Description copied from class: Location

Abstract to force overriding.

Specified by:

equals in class Location

Since:

0.17 or earlier

toString

public String toString()

Overrides:

toString in class Object

Since:

0.17 or earlier

getWhereString

protected String getWhereString()

Since:

0.17 or earlier

objectArrayCount

public int objectArrayCount()

Get the number of object array elements this location requires.

Since:

0.17 or earlier

objectFieldCount

public int objectFieldCount()

Get the number of in-object Object fields this location requires.

Since:

0.17 or earlier

primitiveFieldCount

public int primitiveFieldCount()

Get the number of in-object primitive fields this location requires.

Since:

0.17 or earlier

primitiveArrayCount

public int primitiveArrayCount()

Get the number of primitive array elements this location requires.

Since:

0.17 or earlier

accept

public abstract void accept(LocationImpl.LocationVisitor locationVisitor)

Accept a visitor for location allocation for this and every nested location.

Parameters:

locationVisitor - visitor to be notified of every allocated slot in use by this location

Since:

0.17 or earlier

valueEquals

public static boolean valueEquals(Object val1,
                                  Object val2)

Boxed values need to be compared by value not by reference. The first parameter should be the one with the more precise type information. For sets to final locations, otherValue.equals(thisValue) seems more beneficial, since we usually know more about the value to be set.

Since:

0.17 or earlier