|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.jruby.embed.variable.GlobalVariable
public class GlobalVariable
An implementation of BiVariable for a Ruby global variable.
Nested Class Summary |
---|
Nested classes/interfaces inherited from interface org.jruby.embed.variable.BiVariable |
---|
BiVariable.Type |
Field Summary | |
---|---|
protected boolean |
fromRuby
|
protected IRubyObject |
irubyObject
|
protected java.lang.Object |
javaObject
|
protected java.lang.Class |
javaType
|
protected java.lang.String |
name
|
protected IRubyObject |
receiver
|
Constructor Summary | |
---|---|
protected |
GlobalVariable(RubyObject receiver,
java.lang.String name,
java.lang.Object... javaObjects)
|
Method Summary | |
---|---|
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 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()
A global variable is injected when it is set. |
protected static boolean |
isPredefined(java.lang.String name)
|
boolean |
isReceiverIdentical(RubyObject recv)
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 global 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(IRubyObject receiver,
BiVariableMap vars)
Retrieves global variables from Ruby after the evaluation. |
static void |
retrieveByKey(Ruby runtime,
BiVariableMap vars,
java.lang.String key)
Retrieves a global variable by key from Ruby after the evaluation. |
void |
setJavaObject(Ruby runtime,
java.lang.Object javaObject)
Sets a Java object and its Ruby type 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. |
void |
tryEagerInjection(Ruby runtime,
IRubyObject receiver)
Injects a global variable value to a parsed Ruby script. |
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 |
---|
protected final IRubyObject receiver
protected java.lang.String name
protected java.lang.Object javaObject
protected java.lang.Class javaType
protected IRubyObject irubyObject
protected boolean fromRuby
Constructor Detail |
---|
protected GlobalVariable(RubyObject receiver, java.lang.String name, java.lang.Object... javaObjects)
Method Detail |
---|
public static BiVariable getInstance(RubyObject receiver, java.lang.String name, java.lang.Object... javaObject)
BiVariableMap
.
runtime
- Ruby runtimename
- a variable namejavaObject
- Java object that should be assigned to.
public static void retrieve(IRubyObject receiver, BiVariableMap vars)
runtime
- Ruby runtimereceiver
- receiver object returned when a script is evaluated.vars
- map to save retrieved global variables.public static void retrieveByKey(Ruby runtime, BiVariableMap vars, java.lang.String key)
runtime
- Ruby runtimereceiver
- receiver object returned when a script is evaluated.vars
- map to save a retrieved global variable.key
- name of the global variableprotected static boolean isPredefined(java.lang.String name)
public BiVariable.Type getType()
BiVariable
.
public static boolean isValidName(java.lang.Object name)
name
- is a name to be checked.
public void setJavaObject(Ruby runtime, java.lang.Object javaObject)
setJavaObject
in interface BiVariable
runtime
- is used to convert a Java object to Ruby object.javaObject
- is a variable value to be set.public void inject()
public void tryEagerInjection(Ruby runtime, IRubyObject receiver)
runtime
- is environment where a variable injection occursreceiver
- is the instance that will have variable injection.public void remove()
public boolean isReceiverIdentical(RubyObject recv)
isReceiverIdentical
in interface BiVariable
protected void updateByJavaObject(Ruby runtime, java.lang.Object... values)
protected void updateRubyObject(IRubyObject rubyObject)
public IRubyObject getReceiver()
BiVariable
getReceiver
in interface BiVariable
public java.lang.String getName()
BiVariable
getName
in interface BiVariable
public java.lang.Object getJavaObject()
BiVariable
getJavaObject
in interface BiVariable
public IRubyObject getRubyObject()
BiVariable
getRubyObject
in interface BiVariable
public void setRubyObject(IRubyObject rubyObject)
BiVariable
setRubyObject
in interface BiVariable
rubyObject
- is a variable value to be set.protected RubyModule getRubyClass(Ruby runtime)
protected static boolean isValidName(java.lang.String pattern, java.lang.Object name)
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |