Class PropertyGetter

java.lang.Object

com.oracle.truffle.api.object.PropertyGetter

public final class PropertyGetter
extends Object

A lightweight property getter that allows getting the value of a DynamicObject property without any lookup or cache dispatch. Only objects of a specific Shape are accepted. Therefore, it should only be used where the object is already known to have the supported shape.

Since:

22.2

See Also:

• Shape.makePropertyGetter(Object)
• DynamicObjectLibrary

Method Summary

Modifier and Type	Method	Description
boolean	accepts(DynamicObject receiver)	Returns true if this PropertyGetter can be used with the given receiver object to get the property's value.
Object	get(DynamicObject receiver)	Gets the property's value from the given receiver object if the object has the supported Shape, i.e.
double	getDouble(DynamicObject receiver)	Gets the property's value from the given receiver object if the object has the supported Shape.
int	getFlags()	Returns the flags associated with the property represented by this getter.
int	getInt(DynamicObject receiver)	Gets the property's value from the given receiver object if the object has the supported Shape.
Object	getKey()	Returns the key of the property represented by this getter.
long	getLong(DynamicObject receiver)	Gets the property's value from the given receiver object if the object has the supported Shape.

Methods inherited from class java.lang.Object

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

Method Details

accepts

public boolean accepts(DynamicObject receiver)

Returns true if this PropertyGetter can be used with the given receiver object to get the property's value.

Parameters:

receiver - the receiver object

Returns:

true if the shape of the receiver object is supported by this PropertyGetter.

Since:

22.2

See Also:

• get(DynamicObject)

get

public Object get(DynamicObject receiver)

Gets the property's value from the given receiver object if the object has the supported Shape, i.e. the shape this property getter was created with. Otherwise, throws an IllegalArgumentException.

Parameters:

receiver - the receiver object

Returns:

the property's value

Throws:

IllegalArgumentException - if the object does not have the expected shape.

Since:

22.2

getInt

public int getInt(DynamicObject receiver)
           throws UnexpectedResultException

Gets the property's value from the given receiver object if the object has the supported Shape. Expects an int value or throws an UnexpectedResultException if the value is of a different type. If the object's shape is not supported, throws an IllegalArgumentException.

Parameters:

receiver - the receiver object

Returns:

the property's value

Throws:

IllegalArgumentException - if the object does not have the expected shape.

UnexpectedResultException - if the location does not contain an int value.

Since:

22.2

See Also:

• get(DynamicObject)

getLong

public long getLong(DynamicObject receiver)
             throws UnexpectedResultException

Gets the property's value from the given receiver object if the object has the supported Shape. Expects a long value or throws an UnexpectedResultException if the value is of a different type. If the object's shape is not supported, throws an IllegalArgumentException.

Parameters:

receiver - the receiver object

Returns:

the property's value

Throws:

IllegalArgumentException - if the object does not have the expected shape.

UnexpectedResultException - if the location does not contain a long value.

Since:

22.2

See Also:

• get(DynamicObject)

getDouble

public double getDouble(DynamicObject receiver)
                 throws UnexpectedResultException

Gets the property's value from the given receiver object if the object has the supported Shape. Expects a double value or throws an UnexpectedResultException if the value is of a different type. If the object's shape is not supported, throws an IllegalArgumentException.

Parameters:

receiver - the receiver object

Returns:

the property's value

Throws:

IllegalArgumentException - if the object does not have the expected shape.

UnexpectedResultException - if the location does not contain a double value.

Since:

22.2

See Also:

• get(DynamicObject)

getKey

public Object getKey()

Returns the key of the property represented by this getter.

Since:

22.2

See Also:

• Property.getKey()

getFlags

public int getFlags()

Returns the flags associated with the property represented by this getter.

Since:

22.2

See Also:

• Property.getFlags()