Package com.oracle.truffle.api.bytecode

Class LocalAccessor

java.lang.Object

com.oracle.truffle.api.bytecode.LocalAccessor

public final class LocalAccessor
extends Object

Operation parameter that allows an operation to get and set the value of a local. This class is intended to be used in combination with the ConstantOperand annotation.

When a local accessor is declared as a constant operand, the corresponding builder method will take a BytecodeLocal argument representing the local to be updated. Whenever possible using LocalAccessor should be preferred over BytecodeNode.getLocalValue(int, Frame, int) and builtin operations should be preferred over using LocalAccessor.

Example usage:

 @Operation
 @ConstantOperand(type = LocalAccessor.class)
 public static final class GetLocalAccessor {
     @Specialization
     public static Object perform(VirtualFrame frame, LocalAccessor accessor,

Since:

24.2

Method Summary

Modifier and Type	Method	Description
static LocalAccessor	constantOf(BytecodeLocal local)	Obtains an existing LocalAccessor.
boolean	equals(Object obj)
boolean	getBoolean(BytecodeNode node, VirtualFrame frame)	Loads a boolean from a local.
byte	getByte(BytecodeNode node, VirtualFrame frame)	Loads a byte from a local.
double	getDouble(BytecodeNode node, VirtualFrame frame)	Loads a double from a local.
float	getFloat(BytecodeNode node, VirtualFrame frame)	Loads a float from a local.
int	getInt(BytecodeNode node, VirtualFrame frame)	Loads an int from a local.
long	getLong(BytecodeNode node, VirtualFrame frame)	Loads a long from a local.
Object	getObject(BytecodeNode node, VirtualFrame frame)	Loads an Object from a local.
int	hashCode()
void	setBoolean(BytecodeNode node, VirtualFrame frame, boolean value)	Stores a short into the local.
void	setByte(BytecodeNode node, VirtualFrame frame, byte value)	Stores a short into the local.
void	setDouble(BytecodeNode node, VirtualFrame frame, double value)	Stores a double into the local.
void	setFloat(BytecodeNode node, VirtualFrame frame, float value)	Stores a float into the local.
void	setInt(BytecodeNode node, VirtualFrame frame, int value)	Stores an int into the local.
void	setLong(BytecodeNode node, VirtualFrame frame, long value)	Stores a long into the local.
void	setObject(BytecodeNode node, VirtualFrame frame, Object value)	Stores an object into the local.
String	toString()	Returns a string representation of a LocalAccessor.

Methods inherited from class java.lang.Object

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

Method Details

toString

public String toString()

Returns a string representation of a LocalAccessor.

Overrides:

toString in class Object

Since:

24.2

setObject

public void setObject(BytecodeNode node,
 VirtualFrame frame,
 Object value)

Stores an object into the local.

Since:

24.2

setInt

public void setInt(BytecodeNode node,
 VirtualFrame frame,
 int value)

Stores an int into the local.

Since:

24.2

setLong

public void setLong(BytecodeNode node,
 VirtualFrame frame,
 long value)

Stores a long into the local.

Since:

24.2

setBoolean

public void setBoolean(BytecodeNode node,
 VirtualFrame frame,
 boolean value)

Stores a short into the local.

Since:

24.2

See Also:

• the set method for an example on how to use it.

setByte

public void setByte(BytecodeNode node,
 VirtualFrame frame,
 byte value)

Stores a short into the local.

Since:

24.2

See Also:

• the set method for an example on how to use it.

setFloat

public void setFloat(BytecodeNode node,
 VirtualFrame frame,
 float value)

Stores a float into the local.

Since:

24.2

setDouble

public void setDouble(BytecodeNode node,
 VirtualFrame frame,
 double value)

Stores a double into the local.

Since:

24.2

getObject

public Object getObject(BytecodeNode node,
 VirtualFrame frame)

Loads an Object from a local.

Since:

24.2

getBoolean

public boolean getBoolean(BytecodeNode node,
 VirtualFrame frame)
                   throws UnexpectedResultException

Loads a boolean from a local.

Throws:

UnexpectedResultException

Since:

24.2

getByte

public byte getByte(BytecodeNode node,
 VirtualFrame frame)
             throws UnexpectedResultException

Loads a byte from a local.

Throws:

UnexpectedResultException

Since:

24.2

getInt

public int getInt(BytecodeNode node,
 VirtualFrame frame)
           throws UnexpectedResultException

Loads an int from a local.

Throws:

UnexpectedResultException

Since:

24.2

getLong

public long getLong(BytecodeNode node,
 VirtualFrame frame)
             throws UnexpectedResultException

Loads a long from a local.

Throws:

UnexpectedResultException

Since:

24.2

getFloat

public float getFloat(BytecodeNode node,
 VirtualFrame frame)
               throws UnexpectedResultException

Loads a float from a local.

Throws:

UnexpectedResultException

Since:

24.2

getDouble

public double getDouble(BytecodeNode node,
 VirtualFrame frame)
                 throws UnexpectedResultException

Loads a double from a local.

Throws:

UnexpectedResultException

Since:

24.2

constantOf

public static LocalAccessor constantOf(BytecodeLocal local)

Obtains an existing LocalAccessor. This method is invoked by the generated code and should not be called directly.

Since:

24.2

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object