org.jruby.embed.variable

Class GlobalVariable

java.lang.Object

org.jruby.embed.variable.AbstractVariable

org.jruby.embed.variable.GlobalVariable

All Implemented Interfaces:

BiVariable

Direct Known Subclasses:

LocalGlobalVariable

public class GlobalVariable
extends AbstractVariable

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

Fields

Modifier and Type	Field and Description
private static java.util.Set<java.lang.String>	PREDEFINED_NAMES
private static java.lang.String[]	PREDEFINED_PATTERNS
private static java.lang.String	VALID_NAME

Fields inherited from class org.jruby.embed.variable.AbstractVariable

fromRuby, irubyObject, javaObject, javaType, name, receiver

Constructor Summary

Constructors

Modifier	Constructor and Description
(package private)	GlobalVariable(RubyObject receiver, java.lang.String name, IRubyObject irubyObject) A constructor used when global variables are retrieved from Ruby.
protected	GlobalVariable(RubyObject receiver, java.lang.String name, java.lang.Object... javaObjects)

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.
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.
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	tryEagerInjection(IRubyObject receiver) Injects a global variable value to a parsed Ruby script.
void	tryEagerInjection(Ruby runtime, IRubyObject receiver) Deprecated.
private static void	updateGlobalVar(BiVariableMap vars, RubyObject receiver, java.lang.String name, IRubyObject value)

Methods inherited from class org.jruby.embed.variable.AbstractVariable

getCurrentContext, getJavaObject, getName, getReceiver, getRubyClass, getRubyObject, getRuntime, getTopSelf, getTopSelf, isValidName, setRubyObject, updateByJavaObject, updateRubyObject

Methods inherited from class java.lang.Object

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

Field Detail

VALID_NAME

private static final java.lang.String VALID_NAME

See Also:

Constant Field Values

PREDEFINED_PATTERNS

private static final java.lang.String[] PREDEFINED_PATTERNS

PREDEFINED_NAMES

private static final java.util.Set<java.lang.String> PREDEFINED_NAMES

Constructor Detail

GlobalVariable

protected GlobalVariable(RubyObject receiver,
                         java.lang.String name,
                         java.lang.Object... javaObjects)

GlobalVariable

GlobalVariable(RubyObject receiver,
               java.lang.String name,
               IRubyObject irubyObject)

A constructor used when global variables are retrieved from Ruby.

Parameters:

name - the global variable name

irubyObject - Ruby global object

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 global 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 GlobalVariable

retrieve

public static void retrieve(IRubyObject receiver,
                            BiVariableMap vars)

Retrieves global variables from Ruby after the evaluation.

Parameters:

runtime - Ruby runtime

receiver - receiver object returned when a script is evaluated.

vars - map to save retrieved global variables.

updateGlobalVar

private static void updateGlobalVar(BiVariableMap vars,
                                    RubyObject receiver,
                                    java.lang.String name,
                                    IRubyObject value)

retrieveByKey

public static void retrieveByKey(Ruby runtime,
                                 BiVariableMap vars,
                                 java.lang.String key)

Retrieves a global variable by key from Ruby after the evaluation.

Parameters:

runtime - Ruby runtime

receiver - receiver object returned when a script is evaluated.

vars - map to save a retrieved global variable.

key - name of the global variable

isPredefined

protected static boolean isPredefined(java.lang.String name)

getType

public BiVariable.Type getType()

Returns enum type of this variable defined in BiVariable.

Returns:

this enum type, BiVariable.Type.GlobalVariable.

isValidName

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

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

Parameters:

name - is a name to be checked.

Returns:

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

setJavaObject

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

Sets a Java object and its Ruby type as a value of this object. At the same time, sets Ruby object to Ruby runtime.

Specified by:

setJavaObject in interface BiVariable

Overrides:

setJavaObject in class AbstractVariable

Parameters:

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

javaObject - is a variable value to be set.

inject

public void inject()

A global variable is injected when it is set. This method does nothing. Instead injection is done by tryEagerInjection.

tryEagerInjection

@Deprecated
public void tryEagerInjection(Ruby runtime,
                                          IRubyObject receiver)

Deprecated.

tryEagerInjection

public void tryEagerInjection(IRubyObject receiver)

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

Parameters:

runtime - is environment where a variable injection occurs

receiver - is the instance that will have variable injection.

remove

public void remove()

Attempts to remove this variable from top self or receiver.

isReceiverIdentical

public boolean isReceiverIdentical(RubyObject recv)

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

Specified by:

isReceiverIdentical in interface BiVariable

Overrides:

isReceiverIdentical in class AbstractVariable

Returns:

true always