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

Access	Constructor and Description
public	VariableInterceptor()

Method Summary

Modifier and Type	Method and Description
public static BiVariable	Returns: an appropriate type of the variable instance. getVariableInstance(LocalVariableBehavior behavior, RubyObject Receiver object returned when a script is evaluated. receiver, String variable name name, Object... variable value value) Returns an appropriate type of a variable instance to the specified local variable behavior.
public static void	inject(BiVariableMap a variable map that has name-value pairs to be injected map, Ruby Ruby runtime runtime, ManyVarsDynamicScope scope to inject local variable values scope) Deprecated Injects variable values from Java to Ruby just before an evaluation or method invocation.
public static void	inject(BiVariableMap a variable map that has name-value pairs to be injected map, DynamicScope scope to inject local variable values scope) Injects variable values from Java to Ruby just before an evaluation or method invocation.
public static boolean	Returns: true when the name is a legal Ruby variable/constant name, otherwise false. isKindOfRubyVariable(LocalVariableBehavior behavior, String a given name to be checked name) Checks the given name is whether a legal Ruby variable/constant name or not.
private static BiVariable	resolve(BiVariable[] entries)
public static void	retrieve(LocalVariableBehavior behavior, BiVariableMap variable map that holds retrieved name-value pairs. map, RubyObject a receiver when the script has been evaluated once receiver) Retrieves variable/constant names and values after the evaluation or method invocation.
public static void	terminateGlobalVariables(LocalVariableBehavior behavior, Collection<BiVariable> a variable list to be cleared from Ruby runtime variables, Ruby Ruby runtime runtime) Clears global variable values from Ruby runtime to behave the same as JSR 223 reference implementation.
public static void	terminateLocalVariables(LocalVariableBehavior behavior, List<String> variable name list to be cleared varNames, List<BiVariable> variable value list to be cleared variables) Clears local variables form the variable map so that old local variable name-value pairs are not to be used in successive evaluations.
public static void	tryLazyRetrieval(LocalVariableBehavior behavior, BiVariableMap variable map that holds retrieved name-value pairs. map, IRubyObject a receiver when the script has been evaluated once receiver, Object key) Retrieves specified variable/constant name and value after the evaluation or method invocation only when it is requested.

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

VariableInterceptor	back to summary
public VariableInterceptor()

Method Detail

getVariableInstance	back to summary
public static BiVariable getVariableInstance(LocalVariableBehavior behavior, RubyObject receiver, String name, Object... value) Returns an appropriate type of a variable instance to the specified local variable behavior. Parameters receiver:RubyObject Receiver object returned when a script is evaluated. name:String variable name value:Object[] variable value Returns:BiVariable an appropriate type of the variable instance.

getVariableInstance

back to summary

public static BiVariable getVariableInstance(LocalVariableBehavior behavior, RubyObject receiver, String name, Object... value)

Returns an appropriate type of a variable instance to the specified local variable behavior.

Parameters

receiver:RubyObject: Receiver object returned when a script is evaluated.
name:String: variable name
value:Object[]: variable value

Returns:BiVariable

an appropriate type of the variable instance.

inject	back to summary
public static void inject(BiVariableMap map, Ruby runtime, ManyVarsDynamicScope scope) Deprecated Injects variable values from Java to Ruby just before an evaluation or method invocation. Parameters map:BiVariableMap a variable map that has name-value pairs to be injected runtime:Ruby Ruby runtime scope:ManyVarsDynamicScope scope to inject local variable values Annotations @Deprecated

inject

back to summary

public static void inject(BiVariableMap map, Ruby runtime, ManyVarsDynamicScope scope)

Deprecated

Injects variable values from Java to Ruby just before an evaluation or method invocation.

Parameters

map:BiVariableMap: a variable map that has name-value pairs to be injected
runtime:Ruby: Ruby runtime
scope:ManyVarsDynamicScope: scope to inject local variable values

Annotations

@Deprecated

inject	back to summary
public static void inject(BiVariableMap map, DynamicScope scope) Injects variable values from Java to Ruby just before an evaluation or method invocation. Parameters map:BiVariableMap a variable map that has name-value pairs to be injected scope:DynamicScope scope to inject local variable values

inject

back to summary

public static void inject(BiVariableMap map, DynamicScope scope)

Injects variable values from Java to Ruby just before an evaluation or method invocation.

Parameters

map:BiVariableMap: a variable map that has name-value pairs to be injected
scope:DynamicScope: scope to inject local variable values

isKindOfRubyVariable	back to summary
public static boolean isKindOfRubyVariable(LocalVariableBehavior behavior, String name) Checks the given name is whether a legal Ruby variable/constant name or not. Parameters name:String a given name to be checked Returns:boolean true when the name is a legal Ruby variable/constant name, otherwise false.

isKindOfRubyVariable

back to summary

public static boolean isKindOfRubyVariable(LocalVariableBehavior behavior, String name)

Checks the given name is whether a legal Ruby variable/constant name or not.

Parameters

name:String: a given name to be checked

Returns:boolean

true when the name is a legal Ruby variable/constant name, otherwise false.

resolve	back to summary
private static BiVariable resolve(BiVariable[] entries)

retrieve	back to summary
public static void retrieve(LocalVariableBehavior behavior, BiVariableMap map, RubyObject receiver) Retrieves variable/constant names and values after the evaluation or method invocation. Parameters map:BiVariableMap variable map that holds retrieved name-value pairs. receiver:RubyObject a receiver when the script has been evaluated once

retrieve

back to summary

public static void retrieve(LocalVariableBehavior behavior, BiVariableMap map, RubyObject receiver)

Retrieves variable/constant names and values after the evaluation or method invocation.

Parameters

map:BiVariableMap: variable map that holds retrieved name-value pairs.
receiver:RubyObject: a receiver when the script has been evaluated once

terminateGlobalVariables	back to summary
public static void terminateGlobalVariables(LocalVariableBehavior behavior, Collection<BiVariable> variables, Ruby runtime) Clears global variable values from Ruby runtime to behave the same as JSR 223 reference implementation. Parameters variables:Collection<BiVariable> a variable list to be cleared from Ruby runtime runtime:Ruby Ruby runtime

terminateGlobalVariables

back to summary

public static void terminateGlobalVariables(LocalVariableBehavior behavior, Collection<BiVariable> variables, Ruby runtime)

Clears global variable values from Ruby runtime to behave the same as JSR 223 reference implementation.

Parameters

variables:Collection<BiVariable>: a variable list to be cleared from Ruby runtime
runtime:Ruby: Ruby runtime

terminateLocalVariables	back to summary
public static void terminateLocalVariables(LocalVariableBehavior behavior, List<String> varNames, List<BiVariable> variables) Clears local variables form the variable map so that old local variable name-value pairs are not to be used in successive evaluations. Parameters varNames:List<String> variable name list to be cleared variables:List<BiVariable> variable value list to be cleared

terminateLocalVariables

back to summary

public static void terminateLocalVariables(LocalVariableBehavior behavior, List<String> varNames, List<BiVariable> variables)

Clears local variables form the variable map so that old local variable name-value pairs are not to be used in successive evaluations.

Parameters

varNames:List<String>: variable name list to be cleared
variables:List<BiVariable>: variable value list to be cleared

tryLazyRetrieval	back to summary
public static void tryLazyRetrieval(LocalVariableBehavior behavior, BiVariableMap map, IRubyObject receiver, Object key) Retrieves specified variable/constant name and value after the evaluation or method invocation only when it is requested. Parameters map:BiVariableMap variable map that holds retrieved name-value pairs. receiver:IRubyObject a receiver when the script has been evaluated once

tryLazyRetrieval

back to summary

public static void tryLazyRetrieval(LocalVariableBehavior behavior, BiVariableMap map, IRubyObject receiver, Object key)

Retrieves specified variable/constant name and value after the evaluation or method invocation only when it is requested.

Parameters

map:BiVariableMap: variable map that holds retrieved name-value pairs.
receiver:IRubyObject: a receiver when the script has been evaluated once

public Class VariableInterceptor

Constructor Summary

Method Summary

Constructor Detail

Method Detail