org.jruby.embed.variable

Class PersistentLocalVariable

java.lang.Object

org.jruby.embed.variable.PersistentLocalVariable

All Implemented Interfaces:

BiVariable

public class PersistentLocalVariable
extends java.lang.Object

An implementation of BiVariable for a persistent local variable. This type of a local variable survives over multiple evaluation.

Author:

Yoko Harada

Nested Class Summary

Nested classes/interfaces inherited from interface org.jruby.embed.variable.BiVariable

BiVariable.Type

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	fromRuby
protected java.lang.Object	javaObject
protected java.lang.Class	javaType
protected java.lang.String	name
protected IRubyObject	receiver
protected IRubyObject	rubyObject

Method Summary

Modifier and Type	Method and Description
static BiVariable	getInstance(RubyObject receiver, java.lang.String name, java.lang.Object... javaObject) Returns an instance of this class.
java.lang.Object	getJavaObject() Returns a value of the variable this object holds in Java type.
java.lang.String	getName() Returns a name of the variable this object holds.
IRubyObject	getReceiver() Returns the original receiver where this variable has been retrieved.
protected static RubyModule	getRubyClass(Ruby runtime)
IRubyObject	getRubyObject() Returns a value of the variable this object holds in a org.jruby.runtime.builtin.IRubyObject type.
BiVariable.Type	getType() Returns enum type of this variable defined in BiVariable.
void	inject() Injects a local variable value to a parsed Ruby script.
boolean	isReceiverIdentical(RubyObject receiver) Returns true if a given receiver is identical to the receiver this object has.
static boolean	isValidName(java.lang.Object name) Returns true if the given name is a decent Ruby local variable.
protected static boolean	isValidName(java.lang.String pattern, java.lang.Object name)
void	remove() Attempts to remove this variable from top self or receiver.
static void	retrieve(RubyObject receiver, BiVariableMap vars) Retrieves local variables from Ruby after the evaluation.
void	setJavaObject(Ruby runtime, java.lang.Object javaObject) Sets a Java object as a value of this object.
void	setRubyObject(IRubyObject rubyObject) Sets a org.jruby.runtime.builtin.IRubyObject type, Ruby object as a value of this object.
protected void	updateByJavaObject(Ruby runtime, java.lang.Object... values)
protected void	updateRubyObject(IRubyObject rubyObject)

Methods inherited from class java.lang.Object

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

Field Detail

receiver

protected final IRubyObject receiver

name

protected final java.lang.String name

javaObject

protected java.lang.Object javaObject

javaType

protected java.lang.Class javaType

rubyObject

protected IRubyObject rubyObject

fromRuby

protected boolean fromRuby

Method Detail

getInstance

public static BiVariable getInstance(RubyObject receiver,
                                     java.lang.String name,
                                     java.lang.Object... javaObject)

Returns an instance of this class. This factory method is used when a persistent local variable is put in BiVariableMap.

Parameters:

runtime - Ruby runtime

name - a variable name

javaObject - Java object that should be assigned to.

Returns:

the instance of PersistentLocalVariable

getType

public BiVariable.Type getType()

Returns enum type of this variable defined in BiVariable.

Returns:

this enum type, BiVariable.Type.LocalVariable.

isValidName

public static boolean isValidName(java.lang.Object name)

Returns true if the given name is a decent Ruby local variable. Unless returns false.

Parameters:

name - is a name to be checked.

Returns:

true if the given name is of a Ruby local variable.

retrieve

public static void retrieve(RubyObject receiver,
                            BiVariableMap vars)

Retrieves local variables from Ruby after the evaluation. This retrieval doesn't depend on eager option. Local variables are always retrieved eagerly.

Parameters:

runtime - Ruby runtime

receiver - receiver object returned when a script is evaluated.

vars - map to save retrieved local variables.

inject

public void inject()

Injects a local variable value to a parsed Ruby script. This method is invoked during EvalUnit#run() is executed.

remove

public void remove()

Attempts to remove this variable from top self or receiver.

updateByJavaObject

protected void updateByJavaObject(Ruby runtime,
                                  java.lang.Object... values)

updateRubyObject

protected void updateRubyObject(IRubyObject rubyObject)

getReceiver

public IRubyObject getReceiver()

Description copied from interface: BiVariable

Returns the original receiver where this variable has been retrieved.

Specified by:

getReceiver in interface BiVariable

Returns:

an original receiver.

isReceiverIdentical

public boolean isReceiverIdentical(RubyObject receiver)

Returns true if a given receiver is identical to the receiver this object has.

Specified by:

isReceiverIdentical in interface BiVariable

Returns:

true if identical otherwise false

getName

public java.lang.String getName()

Description copied from interface: BiVariable

Returns a name of the variable this object holds. The name follows Ruby's naming rule.

Specified by:

getName in interface BiVariable

Returns:

a name of the variable

getJavaObject

public java.lang.Object getJavaObject()

Description copied from interface: BiVariable

Returns a value of the variable this object holds in Java type.

Specified by:

getJavaObject in interface BiVariable

Returns:

a value in Java type.

setJavaObject

public void setJavaObject(Ruby runtime,
                          java.lang.Object javaObject)

Description copied from interface: BiVariable

Sets a Java object as a value of this object. At the same time, an equivalent Ruby object is set automatically.

Specified by:

setJavaObject in interface BiVariable

Parameters:

runtime - is used to convert a Java object to Ruby object.

javaObject - is a variable value to be set.

getRubyObject

public IRubyObject getRubyObject()

Description copied from interface: BiVariable

Returns a value of the variable this object holds in a org.jruby.runtime.builtin.IRubyObject type.

Specified by:

getRubyObject in interface BiVariable

Returns:

a value in IRubyObject type.

setRubyObject

public void setRubyObject(IRubyObject rubyObject)

Description copied from interface: BiVariable

Sets a org.jruby.runtime.builtin.IRubyObject type, Ruby object as a value of this object. At the same time, an equivalent Java object is set automatically.

Specified by:

setRubyObject in interface BiVariable

Parameters:

rubyObject - is a variable value to be set.

getRubyClass

protected static RubyModule getRubyClass(Ruby runtime)

isValidName

protected static boolean isValidName(java.lang.String pattern,
                                     java.lang.Object name)