JRuby Base 10.0.0.0 · org.jruby.embed.variable.Constant

Modifier and Type	Field and Description
private static final String	VALID_NAME

Access	Constructor and Description
private	Constant(RubyObject receiver, String name, Object... javaObjects)
pack-priv	Constant(RubyObject a receiver object that this variable/constant is originally in. When the variable/constant is originated from Ruby, receiver may not be null. receiver, String the constant name name, IRubyObject Ruby constant object irubyObject) A constructor used when constants are retrieved from Ruby.

Method Summary

Modifier and Type	Method and Description
public static BiVariable	Returns: the instance of Constant getInstance(RubyObject object that this constant/variable is in. receiver, String a variable name name, Object... Java object that should be assigned to. javaObject) Returns an instance of this class.
public BiVariable.Type	Returns: this enum type, BiVariable.Type.Constant. getType() Implements org.jruby.embed.variable.BiVariable.getType. Returns enum type of this variable defined in `BiVariable`.
public void	inject() Implements org.jruby.embed.variable.BiVariable.inject. Injects a constant value to a parsed Ruby script.
public static boolean	Returns: true if the given name is of a Ruby constant. isValidName(Object is a name to be checked. name) Returns true if the given name is a decent Ruby constant.
public void	remove() Implements org.jruby.embed.variable.BiVariable.remove. Attempts to remove this constant from top self or receiver.
public static void	retrieve(RubyObject receiver object returned when a script is evaluated. receiver, BiVariableMap map to save retrieved constants. vars) Retrieves constants from Ruby after the evaluation or method invocation.
public static void	retrieveByKey(final RubyObject receiver object returned when a script is evaluated. receiver, final BiVariableMap map to save retrieved instance variables. vars, final String instace varible name key) Retrieves a constant by key from Ruby runtime after the evaluation.
private static void	updateConstants(ThreadContext context, final RubyObject receiver, final BiVariableMap vars)
private static void	updateConstantsOfSuperClass(RubyObject receiver, BiVariableMap vars)

Inherited from org.jruby.embed.variable.AbstractVariable:: getCurrentContext getJavaObject getName getReceiver getRubyClass getRubyObject getRuntime getTopSelf getTopSelf isReceiverIdentical isValidName setJavaObject setRubyObject updateByJavaObject updateRubyObject

VALID_NAME	back to summary
private static final String VALID_NAME

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

Constant	back to summary
pack-priv Constant(RubyObject receiver, String name, IRubyObject irubyObject) A constructor used when constants are retrieved from Ruby. Parameters receiver:RubyObject a receiver object that this variable/constant is originally in. When the variable/constant is originated from Ruby, receiver may not be null. name:String the constant name irubyObject:IRubyObject Ruby constant object

Method Detail

getInstance back to summary

getInstance	back to summary
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:RubyObject object that this constant/variable is in. name:String a variable name javaObject:Object[] Java object that should be assigned to. Returns:BiVariable the instance of Constant

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:RubyObject: object that this constant/variable is in.
name:String: a variable name
javaObject:Object[]: Java object that should be assigned to.

Returns:BiVariable

the instance of Constant

getType back to summary

getType	back to summary
public BiVariable.Type getType() Implements org.jruby.embed.variable.BiVariable.getType. Returns enum type of this variable defined in `BiVariable`. Returns:BiVariable.Type this enum type, BiVariable.Type.Constant. Annotations @Override

public BiVariable.Type getType()

Implements org.jruby.embed.variable.BiVariable.getType.

Returns enum type of this variable defined in BiVariable.

Returns:BiVariable.Type

this enum type, BiVariable.Type.Constant.

Annotations

@Override

inject	back to summary
public void inject() Implements org.jruby.embed.variable.BiVariable.inject. Injects a constant value to a parsed Ruby script. This method is invoked during EvalUnit#run() is executed. Annotations @Override

inject

back to summary

public void inject()

Implements org.jruby.embed.variable.BiVariable.inject.

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

Annotations

@Override

isValidName	back to summary
public static boolean isValidName(Object name) Returns true if the given name is a decent Ruby constant. Unless returns false. Parameters name:Object is a name to be checked. Returns:boolean true if the given name is of a Ruby constant.

isValidName

back to summary

public static boolean isValidName(Object name)

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

Parameters

name:Object: is a name to be checked.

Returns:boolean

true if the given name is of a Ruby constant.

remove	back to summary
public void remove() Implements org.jruby.embed.variable.BiVariable.remove. Attempts to remove this constant from top self or receiver. Annotations @Override

remove

back to summary

public void remove()

Implements org.jruby.embed.variable.BiVariable.remove.

Attempts to remove this constant from top self or receiver.

Annotations

@Override

retrieve	back to summary
public static void retrieve(RubyObject receiver, BiVariableMap vars) Retrieves constants from Ruby after the evaluation or method invocation. Parameters receiver:RubyObject receiver object returned when a script is evaluated. vars:BiVariableMap map to save retrieved constants.

retrieve

back to summary

public static void retrieve(RubyObject receiver, BiVariableMap vars)

Retrieves constants from Ruby after the evaluation or method invocation.

Parameters

receiver:RubyObject: receiver object returned when a script is evaluated.
vars:BiVariableMap: map to save retrieved constants.

retrieveByKey	back to summary
public static void retrieveByKey(final RubyObject receiver, final BiVariableMap vars, final String key) Retrieves a constant by key from Ruby runtime after the evaluation. This method is used when eager retrieval is off. Parameters receiver:RubyObject receiver object returned when a script is evaluated. vars:BiVariableMap map to save retrieved instance variables. key:String instace varible name

retrieveByKey

back to summary

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

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

Parameters

receiver:RubyObject: receiver object returned when a script is evaluated.
vars:BiVariableMap: map to save retrieved instance variables.
key:String: instace varible name

updateConstants	back to summary
private static void updateConstants(ThreadContext context, final RubyObject receiver, final BiVariableMap vars)

updateConstantsOfSuperClass	back to summary
private static void updateConstantsOfSuperClass(RubyObject receiver, BiVariableMap vars)

public Class Constant

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail