Represents bidirectional, both Java and Ruby, variables. Users don't instantiate BiVariable type objects. Instead, users can get this type object from BiVariableMap after a variable is set to the map. Users can set variables in Java program explicitly through put() methods in ScriptingContainer and BiVariableMap or equivalents. However, variables in Ruby scripts are set in the map implicitly. When variables and constants are used in the script, those are automatically saved in the map converting to this type.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	BiVariable.Type Defines a type correspond to Ruby's variables and constant types.

Method Summary

Modifier and Type	Method and Description
public Object	Returns: a value in Java type. getJavaObject() Returns a value of the variable this object holds in Java type.
public String	Returns: a name of the variable getName() Returns a name of the variable this object holds.
public IRubyObject	Returns: an original receiver. getReceiver() Returns the original receiver where this variable has been retrieved.
public IRubyObject	Returns: a value in IRubyObject type. getRubyObject() Returns a value of the variable this object holds in a org.jruby.runtime.builtin.IRubyObject type.
public BiVariable.Type	Returns: a type that corresponds to Ruby's variables and constant types. getType() Returns one of the Ruby's variables or constant types defined by Type.
public void	inject() Injects a variable value to a parsed Ruby script.
public boolean	Returns: true if identical otherwise false. isReceiverIdentical(RubyObject receiver) Returns true if a given receiver is identical to the receiver this object has.
public void	remove() Attempts to remove this variable/constant from top self or receiver.
public void	setJavaObject(Ruby is used to convert a Java object to Ruby object. runtime, Object is a variable value to be set. javaObject) Sets a Java object as a value of this object.
public void	setRubyObject(IRubyObject is a variable value to be set. rubyObject) Sets a org.jruby.runtime.builtin.IRubyObject type, Ruby object as a value of this object.

Method Detail

getJavaObject	back to summary
public Object getJavaObject() Returns a value of the variable this object holds in Java type. Returns:Object a value in Java type.

getJavaObject

back to summary

public Object getJavaObject()

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

Returns:Object: a value in Java type.

getName	back to summary
public String getName() Returns a name of the variable this object holds. The name follows Ruby's naming rule. Returns:String a name of the variable

getName

back to summary

public String getName()

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

Returns:String: a name of the variable

getReceiver	back to summary
public IRubyObject getReceiver() Returns the original receiver where this variable has been retrieved. Returns:IRubyObject an original receiver.

getReceiver

back to summary

public IRubyObject getReceiver()

Returns the original receiver where this variable has been retrieved.

Returns:IRubyObject: an original receiver.

getRubyObject	back to summary
public IRubyObject getRubyObject() Returns a value of the variable this object holds in a org.jruby.runtime.builtin.IRubyObject type. Returns:IRubyObject a value in IRubyObject type.

getRubyObject

back to summary

public IRubyObject getRubyObject()

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

Returns:IRubyObject: a value in IRubyObject type.

getType	back to summary
public BiVariable.Type getType() Returns one of the Ruby's variables or constant types defined by Type. Returns:BiVariable.Type a type that corresponds to Ruby's variables and constant types.

getType

back to summary

public BiVariable.Type getType()

Returns one of the Ruby's variables or constant types defined by Type.

Returns:BiVariable.Type: a type that corresponds to Ruby's variables and constant types.

inject	back to summary
public void inject() Injects a variable value to a parsed Ruby script. This method is invoked during EvalUnit#run() is executed. Users don't use this method.

isReceiverIdentical	back to summary
public boolean isReceiverIdentical(RubyObject receiver) Returns true if a given receiver is identical to the receiver this object has. Returns:boolean true if identical otherwise false.

isReceiverIdentical

back to summary

public boolean isReceiverIdentical(RubyObject receiver)

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

Returns:boolean: true if identical otherwise false.

remove	back to summary
public void remove() Attempts to remove this variable/constant from top self or receiver.

setJavaObject	back to summary
public void setJavaObject(Ruby runtime, Object javaObject) Sets a Java object as a value of this object. At the same time, an equivalent Ruby object is set automatically. Parameters runtime:Ruby is used to convert a Java object to Ruby object. javaObject:Object is a variable value to be set.

setJavaObject

back to summary

public void setJavaObject(Ruby runtime, Object javaObject)

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

Parameters

runtime:Ruby: is used to convert a Java object to Ruby object.
javaObject:Object: is a variable value to be set.

setRubyObject	back to summary
public void setRubyObject(IRubyObject rubyObject) 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. Parameters rubyObject:IRubyObject is a variable value to be set.

setRubyObject

back to summary

public void setRubyObject(IRubyObject rubyObject)

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.

Parameters

rubyObject:IRubyObject: is a variable value to be set.

org.jruby.embed.variable back to summary

public final Enum BiVariable.Type

Class Inheritance

extends Enum<BiVariable.Type>

java.lang.Object
java.lang.Enum
org.jruby.embed.variable.BiVariable.Type

Defines a type correspond to Ruby's variables and constant types.

Field Summary

Modifier and Type	Field and Description
public static final BiVariable.Type	Argv
public static final BiVariable.Type	ClassVariable
public static final BiVariable.Type	Constant
public static final BiVariable.Type	GlobalVariable
public static final BiVariable.Type	InstanceVariable
public static final BiVariable.Type	LocalGlobalVariable
public static final BiVariable.Type	LocalVariable

Constructor Summary

Access	Constructor and Description
private	Type()

Method Summary

Modifier and Type	Method and Description
public static BiVariable.Type	valueOf(String name)
public static BiVariable.Type[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

Argv	back to summary
public static final BiVariable.Type Argv

ClassVariable	back to summary
public static final BiVariable.Type ClassVariable

Constant	back to summary
public static final BiVariable.Type Constant

GlobalVariable	back to summary
public static final BiVariable.Type GlobalVariable

InstanceVariable	back to summary
public static final BiVariable.Type InstanceVariable

LocalGlobalVariable	back to summary
public static final BiVariable.Type LocalGlobalVariable

LocalVariable	back to summary
public static final BiVariable.Type LocalVariable

Constructor Detail

Type	back to summary
private Type()

Method Detail

valueOf	back to summary
public static BiVariable.Type valueOf(String name)

values	back to summary
public static BiVariable.Type[] values()

public Interface BiVariable

Nested and Inner Type Summary

Method Summary

Method Detail

public final Enum BiVariable.Type

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail