Package com.oracle.truffle.api.frame

Class FrameExtensions

java.lang.Object

com.oracle.truffle.api.frame.FrameExtensions

public abstract class FrameExtensions
extends Object

Internal frame accessor methods for internal Truffle components that are trusted.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	FrameExtensions()

Method Summary

Modifier and Type	Method	Description
abstract void	clear(Frame frame, int slot)	Clears a frame slot.
abstract void	copy(Frame frame, int srcSlot, int dstSlot)	Copies a value from one slot to another.
abstract void	copyTo(Frame srcFrame, int srcOffset, Frame dstFrame, int dstOffset, int length)	Copies a range of values from one frame to another.
abstract boolean	expectBoolean(Frame frame, int slot)	Reads a boolean from the frame, throwing an UnexpectedResultException with the slot value when the tag does not match.
abstract byte	expectByte(Frame frame, int slot)	Reads a byte from the frame, throwing an UnexpectedResultException with the slot value when the tag does not match.
abstract double	expectDouble(Frame frame, int slot)	Reads a double from the frame, throwing an UnexpectedResultException with the slot value when the tag does not match.
abstract float	expectFloat(Frame frame, int slot)	Reads a float from the frame, throwing an UnexpectedResultException with the slot value when the tag does not match.
abstract int	expectInt(Frame frame, int slot)	Reads an int from the frame, throwing an UnexpectedResultException with the slot value when the tag does not match.
abstract long	expectLong(Frame frame, int slot)	Reads a long from the frame, throwing an UnexpectedResultException with the slot value when the tag does not match.
abstract Object	expectObject(Frame frame, int slot)	Reads an Object from the frame, throwing an UnexpectedResultException with the slot value when the tag does not match.
abstract boolean	getBoolean(Frame frame, int slot)	Reads a boolean from the frame.
abstract byte	getByte(Frame frame, int slot)	Reads a byte from the frame.
abstract double	getDouble(Frame frame, int slot)	Reads a double from the frame.
abstract float	getFloat(Frame frame, int slot)	Reads a float from the frame.
abstract int	getInt(Frame frame, int slot)	Reads an int from the frame.
abstract long	getLong(Frame frame, int slot)	Reads a long from the frame.
abstract Object	getObject(Frame frame, int slot)	Reads an object from the frame.
abstract byte	getTag(Frame frame, int slot)
final Object	getValue(Frame frame, int slot)	Reads the value of a slot from the frame.
final Object	requireObject(Frame frame, int slot)	Reads an Object from the frame, recovering gracefully when the slot is not Object.
abstract void	setBoolean(Frame frame, int slot, boolean value)	Stores a boolean into the frame.
abstract void	setByte(Frame frame, int slot, byte value)	Stores a byte into the frame.
abstract void	setDouble(Frame frame, int slot, double value)	Stores a double into the frame.
abstract void	setFloat(Frame frame, int slot, float value)	Stores a float into the frame.
abstract void	setInt(Frame frame, int slot, int value)	Stores an int into the frame.
abstract void	setLong(Frame frame, int slot, long value)	Stores a long into the frame.
abstract void	setObject(Frame frame, int slot, Object value)	Stores an Object into the frame.
abstract Object	uncheckedGetObject(Frame frame, int slot)	Reads an object from the frame without checking the slot's tag.

Methods inherited from class java.lang.Object

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

Constructor Details

FrameExtensions

protected FrameExtensions()

Method Details

getTag

public abstract byte getTag(Frame frame,
 int slot)

getObject

public abstract Object getObject(Frame frame,
 int slot)
                          throws FrameSlotTypeException

Reads an object from the frame.

Throws:

FrameSlotTypeException

Since:

24.2

getBoolean

public abstract boolean getBoolean(Frame frame,
 int slot)
                            throws FrameSlotTypeException

Reads a boolean from the frame.

Throws:

FrameSlotTypeException

Since:

24.2

getInt

public abstract int getInt(Frame frame,
 int slot)
                    throws FrameSlotTypeException

Reads an int from the frame.

Throws:

FrameSlotTypeException

Since:

24.2

getLong

public abstract long getLong(Frame frame,
 int slot)
                      throws FrameSlotTypeException

Reads a long from the frame.

Throws:

FrameSlotTypeException

Since:

24.2

getByte

public abstract byte getByte(Frame frame,
 int slot)
                      throws FrameSlotTypeException

Reads a byte from the frame.

Throws:

FrameSlotTypeException

Since:

24.2

getFloat

public abstract float getFloat(Frame frame,
 int slot)
                        throws FrameSlotTypeException

Reads a float from the frame.

Throws:

FrameSlotTypeException

Since:

24.2

getDouble

public abstract double getDouble(Frame frame,
 int slot)

Reads a double from the frame.

Since:

24.2

setObject

public abstract void setObject(Frame frame,
 int slot,
 Object value)

Stores an Object into the frame.

Since:

24.2

setBoolean

public abstract void setBoolean(Frame frame,
 int slot,
 boolean value)

Stores a boolean into the frame.

Since:

24.2

setByte

public abstract void setByte(Frame frame,
 int slot,
 byte value)

Stores a byte into the frame.

Since:

24.2

setInt

public abstract void setInt(Frame frame,
 int slot,
 int value)

Stores an int into the frame.

Since:

24.2

setLong

public abstract void setLong(Frame frame,
 int slot,
 long value)

Stores a long into the frame.

Since:

24.2

setFloat

public abstract void setFloat(Frame frame,
 int slot,
 float value)

Stores a float into the frame.

Since:

24.2

setDouble

public abstract void setDouble(Frame frame,
 int slot,
 double value)

Stores a double into the frame.

Since:

24.2

expectBoolean

public abstract boolean expectBoolean(Frame frame,
 int slot)
                               throws UnexpectedResultException

Reads a boolean from the frame, throwing an UnexpectedResultException with the slot value when the tag does not match.

Throws:

UnexpectedResultException

Since:

24.2

expectByte

public abstract byte expectByte(Frame frame,
 int slot)
                         throws UnexpectedResultException

Reads a byte from the frame, throwing an UnexpectedResultException with the slot value when the tag does not match.

Throws:

UnexpectedResultException

Since:

24.2

expectInt

public abstract int expectInt(Frame frame,
 int slot)
                       throws UnexpectedResultException

Reads an int from the frame, throwing an UnexpectedResultException with the slot value when the tag does not match.

Throws:

UnexpectedResultException

Since:

24.2

expectLong

public abstract long expectLong(Frame frame,
 int slot)
                         throws UnexpectedResultException

Reads a long from the frame, throwing an UnexpectedResultException with the slot value when the tag does not match.

Throws:

UnexpectedResultException

Since:

24.2

expectObject

public abstract Object expectObject(Frame frame,
 int slot)
                             throws UnexpectedResultException

Reads an Object from the frame, throwing an UnexpectedResultException with the slot value when the tag does not match.

Throws:

UnexpectedResultException

Since:

24.2

expectFloat

public abstract float expectFloat(Frame frame,
 int slot)
                           throws UnexpectedResultException

Reads a float from the frame, throwing an UnexpectedResultException with the slot value when the tag does not match.

Throws:

UnexpectedResultException

Since:

24.2

expectDouble

public abstract double expectDouble(Frame frame,
 int slot)
                             throws UnexpectedResultException

Reads a double from the frame, throwing an UnexpectedResultException with the slot value when the tag does not match.

Throws:

UnexpectedResultException

Since:

24.2

requireObject

public final Object requireObject(Frame frame,
 int slot)

Reads an Object from the frame, recovering gracefully when the slot is not Object.

Since:

24.2

uncheckedGetObject

public abstract Object uncheckedGetObject(Frame frame,
 int slot)

Reads an object from the frame without checking the slot's tag.

Since:

24.2

copy

public abstract void copy(Frame frame,
 int srcSlot,
 int dstSlot)

Copies a value from one slot to another.

Since:

24.2

copyTo

public abstract void copyTo(Frame srcFrame,
 int srcOffset,
 Frame dstFrame,
 int dstOffset,
 int length)

Copies a range of values from one frame to another.

Since:

24.2

clear

public abstract void clear(Frame frame,
 int slot)

Clears a frame slot.

Since:

24.2

getValue

public final Object getValue(Frame frame,
 int slot)

Reads the value of a slot from the frame.

Since:

24.2