Package org.jruby.embed.variable

Class Constant

java.lang.Object

org.jruby.embed.variable.AbstractVariable

org.jruby.embed.variable.Constant

All Implemented Interfaces:

BiVariable

public class Constant
extends AbstractVariable

An implementation of BiVariable for a Ruby constant.

Nested Class Summary

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

BiVariable.Type

Field Summary

Fields

Modifier and Type	Field	Description
private static final String	VALID_NAME

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

fromRuby, javaObject, javaType, name, receiver, rubyObject

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Constant(RubyObject receiver, String name, Object... javaObjects)
(package private)	Constant(RubyObject receiver, String name, IRubyObject irubyObject)	A constructor used when constants are retrieved from Ruby.

Method Summary

Modifier and Type	Method	Description
static BiVariable	getInstance(RubyObject receiver, String name, Object... javaObject)	Returns an instance of this class.
BiVariable.Type	getType()	Returns enum type of this variable defined in BiVariable.
void	inject()	Injects a constant value to a parsed Ruby script.
static boolean	isValidName(Object name)	Returns true if the given name is a decent Ruby constant.
void	remove()	Attempts to remove this constant from top self or receiver.
static void	retrieve(RubyObject receiver, BiVariableMap vars)	Retrieves constants from Ruby after the evaluation or method invocation.
static void	retrieveByKey(RubyObject receiver, BiVariableMap vars, String key)	Retrieves a constant by key from Ruby runtime after the evaluation.
private static void	updateConstants(RubyObject receiver, BiVariableMap vars)
private static void	updateConstantsOfSuperClass(RubyObject receiver, BiVariableMap vars)

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

getCurrentContext, getJavaObject, 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 Details

VALID_NAME

private static final String VALID_NAME

See Also:

• Constant Field Values

Constructor Details

Constant

private Constant(RubyObject receiver,
 String name,
 Object... javaObjects)

Constant

Constant(RubyObject receiver,
 String name,
 IRubyObject irubyObject)

A constructor used when constants are 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 Details

getInstance

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

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

Parameters:

receiver - object that this constant/variable is in.

name - a variable name

javaObject - Java object that should be assigned to.

Returns:

the instance of Constant

retrieve

public static void retrieve(RubyObject receiver,
 BiVariableMap vars)

Retrieves constants from Ruby after the evaluation or method invocation.

Parameters:

receiver - receiver object returned when a script is evaluated.

vars - map to save retrieved constants.

updateConstantsOfSuperClass

private static void updateConstantsOfSuperClass(RubyObject receiver,
 BiVariableMap vars)

updateConstants

private static void updateConstants(RubyObject receiver,
 BiVariableMap vars)

retrieveByKey

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

Retrieves a constant 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

getType

public BiVariable.Type getType()

Returns enum type of this variable defined in BiVariable.

Returns:

this enum type, BiVariable.Type.Constant.

isValidName

public static boolean isValidName(Object name)

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

Parameters:

name - is a name to be checked.

Returns:

true if the given name is of a Ruby constant.

inject

public void inject()

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

remove

public void remove()

Attempts to remove this constant from top self or receiver.