VariableTableManager (JRuby Core 9.2.9.0 API)

Constructor Summary

Constructors
Constructor and Description

VariableTableManager(RubyClass realClass)
Construct a new VariableTable Manager for the given "real" class.

Constructors
Constructor and Description
`VariableTableManager(RubyClass realClass)` Construct a new VariableTable Manager for the given "real" class.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`java.lang.Object`	`clearVariable(RubyBasicObject object, java.lang.String name)`
`void`	`deserializeVariables(RubyBasicObject object, java.io.ObjectInputStream ois)`
`java.lang.Object`	`getFFIHandle(RubyBasicObject self)` Retrieve the FFI ext handle for the given object.
`VariableAccessorField`	`getFFIHandleAccessorField()` Deprecated. Use `getFFIHandleAccessorForRead()` or `getFFIHandleAccessorForWrite()`
`VariableAccessor`	`getFFIHandleAccessorForRead()` Retrieve the read accessor for FFI handle.
`VariableAccessor`	`getFFIHandleAccessorForWrite()` Retrieve the write accessor for FFI handle.
`VariableAccessorField`	`getObjectGroupAccessorField()` Deprecated. Use `getObjectGroupAccessorForRead()` or `getObjectGroupAccessorForWrite()`
`VariableAccessor`	`getObjectGroupAccessorForRead()` Retrieve the read accessor for object group.
`VariableAccessor`	`getObjectGroupAccessorForWrite()` Retrieve the write accessor for object group.
`long`	`getObjectId(RubyBasicObject self)` Get the object_id from a given RubyBasicObject, possibly allocating space for it.
`VariableAccessorField`	`getObjectIdAccessorField()` Deprecated. Use `getObjectIdAccessorForRead()` or `getObjectIdAccessorForWrite()`
`VariableAccessor`	`getObjectIdAccessorForRead()` Retrieve the read accessor for object_id for reads.
`VariableAccessor`	`getObjectIdAccessorForWrite()` Retrieve the write accessor for object_id.
`VariableAccessor`	`getVariableAccessorForRead(java.lang.String name)` Get the variable accessor for the given name with intent to use it for reading.
`VariableAccessor`	`getVariableAccessorForVar(java.lang.String name, java.lang.invoke.MethodHandle getter, java.lang.invoke.MethodHandle setter)`
`VariableAccessor`	`getVariableAccessorForWrite(java.lang.String name)` Get the variable accessor for the given name with intent to use it for writing.
`java.util.Map<java.lang.String,VariableAccessor>`	`getVariableAccessorsForRead()` Get the map of all current variable accessors with intent to read from it.
`java.lang.String[]`	`getVariableNames()` Get an array of all the known instance variable names.
`java.util.Map<java.lang.String,VariableAccessor>`	`getVariableTableCopy()` Get a Map representing all variables registered in the variable table.
`int`	`getVariableTableSize()` Get the size of the variable table, excluding extra vars (object_id, etc).
`int`	`getVariableTableSizeWithExtras()` Get the size of the variable table, including extra vars (object_etc, etc).
`boolean`	`hasObjectID()` Whether this table has been used to allocate space for an object_id.
`boolean`	`hasVariables(RubyBasicObject object)` Returns true if object has any variables, defined as: instance variables class variables constants internal variables, such as those used when marshaling Ranges and Exceptions
`void`	`serializeVariables(RubyBasicObject object, java.io.ObjectOutputStream oos)`
`void`	`setFFIHandle(RubyBasicObject self, java.lang.Object value)` Set the FFI handle for the given object.
`void`	`setVariableInternal(RubyBasicObject self, int index, java.lang.Object value)` Virtual entry point for setting a variable into an object.
`static void`	`setVariableInternal(RubyClass realClass, RubyBasicObject self, int index, java.lang.Object value)` Static entry point for setting a variable in an object.
`void`	`syncVariables(RubyBasicObject self, IRubyObject other)` Sync one this object's variables with other's - this is used to make rbClone work correctly.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - VariableTableManager
```
public VariableTableManager(RubyClass realClass)
```
    Construct a new VariableTable Manager for the given "real" class.
    
    Parameters:
    
    realClass - the "real" class associated with this table
- Method Detail
  - getVariableAccessorsForRead
```
public java.util.Map<java.lang.String,VariableAccessor> getVariableAccessorsForRead()
```
    Get the map of all current variable accessors with intent to read from it.
    
    Returns:
    
    a map of current variable accessors
  - hasObjectID
```
public boolean hasObjectID()
```
    Whether this table has been used to allocate space for an object_id.
    
    Returns:
    
    true if object_id has been allocated; false otherwise
  - getObjectId
```
public long getObjectId(RubyBasicObject self)
```
    Get the object_id from a given RubyBasicObject, possibly allocating space for it.
    
    Parameters:
    
    self - the object from which to get object_id
    
    Returns:
    
    the object's object_id (possibly new)
  - setVariableInternal
```
public void setVariableInternal(RubyBasicObject self,
                                int index,
                                java.lang.Object value)
```
    Virtual entry point for setting a variable into an object.
    
    Parameters:
    
    self - the object into which to set the value
    
    index - the index allocated for the value
    
    value - the value
  - setVariableInternal
```
public static void setVariableInternal(RubyClass realClass,
                                       RubyBasicObject self,
                                       int index,
                                       java.lang.Object value)
```
    Static entry point for setting a variable in an object.
    
    Parameters:
    
    realClass - the "real" class of the object
    
    self - the object into which to set the variable
    
    index - the index allocated for the variable
    
    value - the value of the variable
  - getVariableAccessorForWrite
```
public VariableAccessor getVariableAccessorForWrite(java.lang.String name)
```
    Get the variable accessor for the given name with intent to use it for writing.
    
    Parameters:
    
    name - the name of the variable
    
    Returns:
    
    an accessor appropriate for writing
  - getVariableAccessorForVar
```
public VariableAccessor getVariableAccessorForVar(java.lang.String name,
                                                  java.lang.invoke.MethodHandle getter,
                                                  java.lang.invoke.MethodHandle setter)
```
  - getVariableAccessorForRead
```
public VariableAccessor getVariableAccessorForRead(java.lang.String name)
```
    Get the variable accessor for the given name with intent to use it for reading.
    
    Parameters:
    
    name - the name of the variable
    
    Returns:
    
    an accessor appropriate for reading
  - getObjectIdAccessorForRead
```
public VariableAccessor getObjectIdAccessorForRead()
```
    Retrieve the read accessor for object_id for reads. If no object_id has been prepared, this will return a dummy accessor that just returns null.
    
    Returns:
    
    the read accessor for object_id
  - getObjectIdAccessorForWrite
```
public VariableAccessor getObjectIdAccessorForWrite()
```
    Retrieve the write accessor for object_id.
    
    Returns:
    
    the write accessor for object_id
  - getFFIHandleAccessorForRead
```
public VariableAccessor getFFIHandleAccessorForRead()
```
    Retrieve the read accessor for FFI handle. If no object_id has been prepared, this will return a dummy accessor that just returns null.
    
    Returns:
    
    the read accessor for FFI handle
  - getFFIHandleAccessorForWrite
```
public VariableAccessor getFFIHandleAccessorForWrite()
```
    Retrieve the write accessor for FFI handle.
    
    Returns:
    
    the write accessor for FFI handle
  - getObjectGroupAccessorForRead
```
public VariableAccessor getObjectGroupAccessorForRead()
```
    Retrieve the read accessor for object group. If no object_id has been prepared, this will return a dummy accessor that just returns null.
    
    Returns:
    
    the read accessor for object group
  - getObjectGroupAccessorForWrite
```
public VariableAccessor getObjectGroupAccessorForWrite()
```
    Retrieve the write accessor for object group.
    
    Returns:
    
    the write accessor for object group
  - getFFIHandle
```
public final java.lang.Object getFFIHandle(RubyBasicObject self)
```
    Retrieve the FFI ext handle for the given object.
    
    Parameters:
    
    self - the object
    
    Returns:
    
    the object's FFI handle
  - setFFIHandle
```
public final void setFFIHandle(RubyBasicObject self,
                               java.lang.Object value)
```
    Set the FFI handle for the given object.
    
    Parameters:
    
    self - the object
    
    self - the object's FFI handle
  - getVariableTableSize
```
public int getVariableTableSize()
```
    Get the size of the variable table, excluding extra vars (object_id, etc).
    
    Returns:
    
    the variable table's size, excluding extras
  - getVariableTableSizeWithExtras
```
public int getVariableTableSizeWithExtras()
```
    Get the size of the variable table, including extra vars (object_etc, etc).
    
    Returns:
  - getVariableTableCopy
```
public java.util.Map<java.lang.String,VariableAccessor> getVariableTableCopy()
```
    Get a Map representing all variables registered in the variable table.
    
    Returns:
    
    a map of names to accessors for all variables
  - getVariableNames
```
public java.lang.String[] getVariableNames()
```
    Get an array of all the known instance variable names. The offset into the array indicates the offset of the variable's value in the per-object variable array.
    
    Returns:
    
    a copy of the array of known instance variable names
  - syncVariables
```
public void syncVariables(RubyBasicObject self,
                          IRubyObject other)
```
    Sync one this object's variables with other's - this is used to make rbClone work correctly.
    
    Parameters:
    
    self - the object into which to sync variables
    
    other - the object from which to sync variables
  - hasVariables
```
public boolean hasVariables(RubyBasicObject object)
```
    Returns true if object has any variables, defined as:
    - instance variables
    - class variables
    - constants
    - internal variables, such as those used when marshaling Ranges and Exceptions
    Returns:
    
    true if object has any variables, else false
  - serializeVariables
```
public void serializeVariables(RubyBasicObject object,
                               java.io.ObjectOutputStream oos)
                        throws java.io.IOException
```
    Throws:
    
    java.io.IOException
  - deserializeVariables
```
public void deserializeVariables(RubyBasicObject object,
                                 java.io.ObjectInputStream ois)
                          throws java.io.IOException,
                                 java.lang.ClassNotFoundException
```
    Throws:
    
    java.io.IOException
    
    java.lang.ClassNotFoundException
  - clearVariable
```
public java.lang.Object clearVariable(RubyBasicObject object,
                                      java.lang.String name)
```
  - getObjectIdAccessorField
```
public VariableAccessorField getObjectIdAccessorField()
```
    Deprecated. Use getObjectIdAccessorForRead() or getObjectIdAccessorForWrite()
    
    Retrieve the lazy accessor (VariableAccessorField) for object_id.
    
    Returns:
    
    the lazy accessor for object_id
  - getFFIHandleAccessorField
```
public VariableAccessorField getFFIHandleAccessorField()
```
    Deprecated. Use getFFIHandleAccessorForRead() or getFFIHandleAccessorForWrite()
    
    Retrieve the lazy accessor (VariableAccessorField) for FFI handle.
    
    Returns:
    
    the lazy accessor for FFI handle
  - getObjectGroupAccessorField
```
public VariableAccessorField getObjectGroupAccessorField()
```
    Deprecated. Use getObjectGroupAccessorForRead() or getObjectGroupAccessorForWrite()
    
    Retrieve the lazy accessor (VariableAccessorField) for object group.
    
    Returns:
    
    the lazy accessor for object group

Class VariableTableManager

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

VariableTableManager

Method Detail

getVariableAccessorsForRead

hasObjectID

getObjectId

setVariableInternal

setVariableInternal

getVariableAccessorForWrite

getVariableAccessorForVar

getVariableAccessorForRead

getObjectIdAccessorForRead

getObjectIdAccessorForWrite

getFFIHandleAccessorForRead

getFFIHandleAccessorForWrite

getObjectGroupAccessorForRead

getObjectGroupAccessorForWrite

getFFIHandle

setFFIHandle

getVariableTableSize

getVariableTableSizeWithExtras

getVariableTableCopy

getVariableNames

syncVariables

hasVariables

serializeVariables

deserializeVariables

clearVariable

getObjectIdAccessorField

getFFIHandleAccessorField

getObjectGroupAccessorField