Frame

All Known Subinterfaces:

MaterializedFrame, VirtualFrame
```
public interface Frame
```
Represents a frame containing values of local variables of the guest language. Instances of this type must not be stored in a field or cast to Object.

Since:

0.8 or earlier

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Object[]`	`getArguments()` Retrieves the arguments object from this frame.
`boolean`	`getBoolean(FrameSlot slot)` Read access to a local variable of type boolean.
`byte`	`getByte(FrameSlot slot)` Read access to a local variable of type byte.
`double`	`getDouble(FrameSlot slot)` Read access to a local variable of type double.
`float`	`getFloat(FrameSlot slot)` Read access to a local variable of type float.
`FrameDescriptor`	`getFrameDescriptor()`
`int`	`getInt(FrameSlot slot)` Read access to a local variable of type int.
`long`	`getLong(FrameSlot slot)` Read access to a local variable of type long.
`Object`	`getObject(FrameSlot slot)` Read access to a local variable of type `Object`.
`Object`	`getValue(FrameSlot slot)` Read access to a local variable of any type.
`boolean`	`isBoolean(FrameSlot slot)` Check whether the given `FrameSlot` is of type boolean.
`boolean`	`isByte(FrameSlot slot)` Check whether the given `FrameSlot` is of type byte.
`boolean`	`isDouble(FrameSlot slot)` Check whether the given `FrameSlot` is of type double.
`boolean`	`isFloat(FrameSlot slot)` Check whether the given `FrameSlot` is of type float.
`boolean`	`isInt(FrameSlot slot)` Check whether the given `FrameSlot` is of type int.
`boolean`	`isLong(FrameSlot slot)` Check whether the given `FrameSlot` is of type long.
`boolean`	`isObject(FrameSlot slot)` Check whether the given `FrameSlot` is of type object.
`MaterializedFrame`	`materialize()` Materializes this frame, which allows it to be stored in a field or cast to `Object`.
`void`	`setBoolean(FrameSlot slot, boolean value)` Write access to a local variable of type boolean.
`void`	`setByte(FrameSlot slot, byte value)`
`void`	`setDouble(FrameSlot slot, double value)` Write access to a local variable of type double.
`void`	`setFloat(FrameSlot slot, float value)` Write access to a local variable of type float.
`void`	`setInt(FrameSlot slot, int value)` Write access to a local variable of type int.
`void`	`setLong(FrameSlot slot, long value)` Write access to a local variable of type long.
`void`	`setObject(FrameSlot slot, Object value)` Write access to a local variable of type `Object`.

- Method Detail
  - getFrameDescriptor
```
FrameDescriptor getFrameDescriptor()
```
    Returns:
    
    the object describing the layout of this frame
    
    Since:
    
    0.8 or earlier
  - getArguments
```
Object[] getArguments()
```
    Retrieves the arguments object from this frame. The runtime assumes that the arguments object is never null.
    
    Returns:
    
    the arguments used when calling this method
    
    Since:
    
    0.8 or earlier
  - getObject
```
Object getObject(FrameSlot slot)
          throws FrameSlotTypeException
```
    Read access to a local variable of type Object.
    
    Parameters:
    
    slot - the slot of the local variable
    
    Returns:
    
    the current value of the local variable
    
    Throws:
    
    FrameSlotTypeException
    
    Since:
    
    0.8 or earlier
  - setObject
```
void setObject(FrameSlot slot,
               Object value)
```
    Write access to a local variable of type Object.
    
    Parameters:
    
    slot - the slot of the local variable
    
    value - the new value of the local variable
    
    Since:
    
    0.8 or earlier
  - getByte
```
byte getByte(FrameSlot slot)
      throws FrameSlotTypeException
```
    Read access to a local variable of type byte.
    
    Parameters:
    
    slot - the slot of the local variable
    
    Returns:
    
    the current value of the local variable
    
    Throws:
    
    FrameSlotTypeException
    
    Since:
    
    0.8 or earlier
  - setByte
```
void setByte(FrameSlot slot,
             byte value)
```
    Since:
    
    0.8 or earlier
  - getBoolean
```
boolean getBoolean(FrameSlot slot)
            throws FrameSlotTypeException
```
    Read access to a local variable of type boolean.
    
    Parameters:
    
    slot - the slot of the local variable
    
    Returns:
    
    the current value of the local variable
    
    Throws:
    
    FrameSlotTypeException
    
    Since:
    
    0.8 or earlier
  - setBoolean
```
void setBoolean(FrameSlot slot,
                boolean value)
```
    Write access to a local variable of type boolean.
    
    Parameters:
    
    slot - the slot of the local variable
    
    value - the new value of the local variable
    
    Since:
    
    0.8 or earlier
  - getInt
```
int getInt(FrameSlot slot)
    throws FrameSlotTypeException
```
    Read access to a local variable of type int.
    
    Parameters:
    
    slot - the slot of the local variable
    
    Returns:
    
    the current value of the local variable
    
    Throws:
    
    FrameSlotTypeException
    
    Since:
    
    0.8 or earlier
  - setInt
```
void setInt(FrameSlot slot,
            int value)
```
    Write access to a local variable of type int.
    
    Parameters:
    
    slot - the slot of the local variable
    
    value - the new value of the local variable
    
    Since:
    
    0.8 or earlier
  - getLong
```
long getLong(FrameSlot slot)
      throws FrameSlotTypeException
```
    Read access to a local variable of type long.
    
    Parameters:
    
    slot - the slot of the local variable
    
    Returns:
    
    the current value of the local variable
    
    Throws:
    
    FrameSlotTypeException
    
    Since:
    
    0.8 or earlier
  - setLong
```
void setLong(FrameSlot slot,
             long value)
```
    Write access to a local variable of type long.
    
    Parameters:
    
    slot - the slot of the local variable
    
    value - the new value of the local variable
    
    Since:
    
    0.8 or earlier
  - getFloat
```
float getFloat(FrameSlot slot)
        throws FrameSlotTypeException
```
    Read access to a local variable of type float.
    
    Parameters:
    
    slot - the slot of the local variable
    
    Returns:
    
    the current value of the local variable
    
    Throws:
    
    FrameSlotTypeException
    
    Since:
    
    0.8 or earlier
  - setFloat
```
void setFloat(FrameSlot slot,
              float value)
```
    Write access to a local variable of type float.
    
    Parameters:
    
    slot - the slot of the local variable
    
    value - the new value of the local variable
    
    Since:
    
    0.8 or earlier
  - getDouble
```
double getDouble(FrameSlot slot)
          throws FrameSlotTypeException
```
    Read access to a local variable of type double.
    
    Parameters:
    
    slot - the slot of the local variable
    
    Returns:
    
    the current value of the local variable
    
    Throws:
    
    FrameSlotTypeException
    
    Since:
    
    0.8 or earlier
  - setDouble
```
void setDouble(FrameSlot slot,
               double value)
```
    Write access to a local variable of type double.
    
    Parameters:
    
    slot - the slot of the local variable
    
    value - the new value of the local variable
    
    Since:
    
    0.8 or earlier
  - getValue
```
Object getValue(FrameSlot slot)
```
    Read access to a local variable of any type.
    
    Parameters:
    
    slot - the slot of the local variable
    
    Returns:
    
    the current value of the local variable or defaultValue if unset
    
    Since:
    
    0.8 or earlier
  - materialize
```
MaterializedFrame materialize()
```
    Materializes this frame, which allows it to be stored in a field or cast to Object.
    
    Returns:
    
    the new materialized frame
    
    Since:
    
    0.8 or earlier
  - isObject
```
boolean isObject(FrameSlot slot)
```
    Check whether the given FrameSlot is of type object.
    
    Since:
    
    0.8 or earlier
  - isByte
```
boolean isByte(FrameSlot slot)
```
    Check whether the given FrameSlot is of type byte.
    
    Since:
    
    0.8 or earlier
  - isBoolean
```
boolean isBoolean(FrameSlot slot)
```
    Check whether the given FrameSlot is of type boolean.
    
    Since:
    
    0.8 or earlier
  - isInt
```
boolean isInt(FrameSlot slot)
```
    Check whether the given FrameSlot is of type int.
    
    Since:
    
    0.8 or earlier
  - isLong
```
boolean isLong(FrameSlot slot)
```
    Check whether the given FrameSlot is of type long.
    
    Since:
    
    0.8 or earlier
  - isFloat
```
boolean isFloat(FrameSlot slot)
```
    Check whether the given FrameSlot is of type float.
    
    Since:
    
    0.8 or earlier
  - isDouble
```
boolean isDouble(FrameSlot slot)
```
    Check whether the given FrameSlot is of type double.
    
    Since:
    
    0.8 or earlier

Interface Frame

Method Summary

Method Detail

getFrameDescriptor

getArguments

getObject

setObject

getByte

setByte

getBoolean

setBoolean

getInt

setInt

getLong

setLong

getFloat

setFloat

getDouble

setDouble

getValue

materialize

isObject

isByte

isBoolean

isInt

isLong

isFloat

isDouble