org.jruby.embed.variable

Class Argv

java.lang.Object

org.jruby.embed.variable.AbstractVariable

org.jruby.embed.variable.Argv

All Implemented Interfaces:

BiVariable

public class Argv
extends AbstractVariable

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.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)	Argv(RubyObject receiver, java.lang.String name, IRubyObject irubyObject) A constructor used when ARGV is retrieved from Ruby.
private	Argv(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.
java.lang.Object	getJavaObject() Returns a value of the variable this object holds in Java type.
BiVariable.Type	getType() Returns enum type of this variable defined in BiVariable.
void	inject() Injects ARGV values to a parsed Ruby script.
static boolean	isValidName(java.lang.Object name) Returns true if the given name is ARGV.
void	remove() Removes this object from BiVariableMap.
static void	retrieve(RubyObject receiver, BiVariableMap vars) Retrieves ARGV from Ruby after the evaluation or method invocation.
static void	retrieveByKey(RubyObject receiver, BiVariableMap vars, java.lang.String key) Retrieves ARGV by key from Ruby runtime after the evaluation.
private static void	updateARGV(IRubyObject receiver, BiVariableMap vars)

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

getCurrentContext, getName, getReceiver, getRubyClass, getRubyObject, getRuntime, getTopSelf, getTopSelf, isReceiverIdentical, isValidName, setJavaObject, 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

Constructor Detail

Argv

private Argv(RubyObject receiver,
             java.lang.String name,
             java.lang.Object... javaObjects)

Argv

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

A constructor used when ARGV is retrieved from Ruby.

Parameters:

receiver - a receiver object that this variable/constant is originally in. When the variable/constant is originated from Ruby, receiver may not be null.

name - the constant name

irubyObject - Ruby constant 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 an ARGV is put in BiVariableMap.

Parameters:

runtime -

name - a variable name

javaObject - Java object that should be assigned to.

Returns:

the instance of Constant

getType

public BiVariable.Type getType()

Returns enum type of this variable defined in BiVariable.

Returns:

this enum type, BiVariable.Type.InstanceVariable.

isValidName

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

Returns true if the given name is ARGV. Unless returns false.

Parameters:

name - is a name to be checked.

Returns:

true if the given name is ARGV.

inject

public void inject()

Injects ARGV values 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()

Removes this object from BiVariableMap. Also, initialize this variable in top self.

retrieve

public static void retrieve(RubyObject receiver,
                            BiVariableMap vars)

Retrieves ARGV from Ruby after the evaluation or method invocation.

Parameters:

runtime - Ruby runtime

receiver - receiver object returned when a script is evaluated.

vars - map to save retrieved constants.

updateARGV

private static void updateARGV(IRubyObject receiver,
                               BiVariableMap vars)

retrieveByKey

public static void retrieveByKey(RubyObject receiver,
                                 BiVariableMap vars,
                                 java.lang.String key)

Retrieves ARGV by key from Ruby runtime after the evaluation. This method is used when eager retrieval is off.

Parameters:

receiver - receiver object returned when a script is evaluated.

vars - map to save retrieved instance variables.

key - instace varible name

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

Overrides:

getJavaObject in class AbstractVariable

Returns:

a value in Java type.