Package com.oracle.truffle.api.frame

Enum Class FrameInstance.FrameAccess

java.lang.Object

java.lang.Enum<FrameInstance.FrameAccess>

com.oracle.truffle.api.frame.FrameInstance.FrameAccess

All Implemented Interfaces:

Serializable, Comparable<FrameInstance.FrameAccess>, Constable

Enclosing interface:

FrameInstance

public static enum FrameInstance.FrameAccess
extends Enum<FrameInstance.FrameAccess>

Access mode for FrameInstance.getFrame(FrameAccess).

Since:

0.8 or earlier

See Also:

• FrameInstance.getFrame(FrameAccess)

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MATERIALIZE	This mode allows to read a materialized version of the frame and provides read and write access to its local variables.
READ_ONLY	This mode allows to read the frame and provides read only access to its local variables.
READ_WRITE	This mode allows to read the frame and provides read and write access to its local variables.

Method Summary

Modifier and Type	Method	Description
static FrameInstance.FrameAccess	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FrameInstance.FrameAccess[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

READ_ONLY

public static final FrameInstance.FrameAccess READ_ONLY

This mode allows to read the frame and provides read only access to its local variables. The returned frame must not be stored/persisted. Writing local variables in this mode will result in an AssertionError only if assertions (-ea) are enabled.

Since:

0.8 or earlier

READ_WRITE

public static final FrameInstance.FrameAccess READ_WRITE

This mode allows to read the frame and provides read and write access to its local variables. The returned frame must not be stored/persisted.

Since:

0.8 or earlier

MATERIALIZE

public static final FrameInstance.FrameAccess MATERIALIZE

This mode allows to read a materialized version of the frame and provides read and write access to its local variables. In addition to READ_WRITE this mode allows to store/persist the returned frame.

Since:

0.8 or earlier

Method Details

values

public static FrameInstance.FrameAccess[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static FrameInstance.FrameAccess valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null