Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
**** BEGIN LICENSE BLOCK ***** Version: CPL 1.0/GPL 2.0/LGPL 2.1 The contents of this file are subject to the Common Public License Version 1.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. Copyright (C) 2009-2011 Yoko Harada <> Alternatively, the contents of this file may be used under the terms of either of the GNU General Public License Version 2 or later (the "GPL"), or the GNU Lesser General Public License Version 2.1 or later (the "LGPL"), in which case the provisions of the GPL or the LGPL are applicable instead of those above. If you wish to allow use of your version of this file only under the terms of either the GPL or the LGPL, and not to allow others to use your version of this file under the terms of the CPL, indicate your decision by deleting the provisions above and replace them with the notice and other provisions required by the GPL or the LGPL. If you do not delete the provisions above, a recipient may use your version of this file under the terms of any one of the CPL, the GPL or the LGPL. **** END LICENSE BLOCK *****
 package org.jruby.embed.variable;
 import org.jruby.Ruby;
An implementation of BiVariable for a persistent local variable. This type of a local variable survives over multiple evaluation.

Yoko Harada <>
 public class PersistentLocalVariable extends AbstractVariable {
     private static String pattern = "([a-z]|_)([a-zA-Z]|_|\\d)*";

Returns an instance of this class. This factory method is used when a persistent local variable is put in org.jruby.embed.internal.BiVariableMap.

runtime Ruby runtime
name a variable name
javaObject Java object that should be assigned to.
the instance of PersistentLocalVariable
     public static BiVariable getInstance(RubyObject receiverString nameObject... javaObject) {
         if (name.matches()) {
             return new PersistentLocalVariable(receivernamejavaObject);
         return null;
     private PersistentLocalVariable(RubyObject receiverString nameObject... javaObjects) {
         updateByJavaObject(receiver.getRuntime(), javaObjects);

A constructor used when persistent local variables are retrieved from Ruby.

name the persistent local variable name
irubyObject Ruby local object
     PersistentLocalVariable(IRubyObject originString nameIRubyObject irubyObject) {

Returns enum type of this variable defined in BiVariable.

this enum type, BiVariable.Type.LocalVariable.
     public Type getType() {
         return .;

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

name is a name to be checked.
true if the given name is of a Ruby local variable.
     public static boolean isValidName(Object name) {
         return isValidName(name);

Retrieves local variables from Ruby after the evaluation. This retrieval doesn't depend on eager option. Local variables are always retrieved eagerly.

runtime Ruby runtime
receiver receiver object returned when a script is evaluated.
vars map to save retrieved local variables.
    public static void retrieve(RubyObject receiverBiVariableMap vars) {
        ManyVarsDynamicScope scope =
        if (scope == null) {
        String[] names = scope.getAllNamesInScope();
        IRubyObject[] values = scope.getValues();
        if (names == null || values == null || names.length == 0 || values.length == 0) {
        // Local variable is always saved as a top level variable.
        for (int i=0; i<names.lengthi++) {
            BiVariable var;
            if ((var = vars.getVariable((RubyObject)receiver.getRuntime().getTopSelf(), names[i])) != null
                    && receiver.getRuntime().getTopSelf() == var.getReceiver()) {
            } else {
                var = new PersistentLocalVariable(receiver.getRuntime().getTopSelf(), names[i], values[i]);
                vars.update(names[i], var);

Injects a local variable value to a parsed Ruby script. This method is invoked during EvalUnit#run() is executed.
    public void inject() {
        //done in JRubyVariableMap.inject()

Attempts to remove this variable from top self or receiver.
    public void remove() {
        ThreadContext context = .getRuntime().getCurrentContext();
        try {
            DynamicScope currentScope = context.getCurrentScope();
            ManyVarsDynamicScope scope = (ManyVarsDynamicScopecontext.getCurrentScope();
            scope = new ManyVarsDynamicScope(context.runtime.getStaticScopeFactory().newEvalScope(currentScope.getStaticScope()), currentScope);
        } catch (ArrayIndexOutOfBoundsException e) {
            //no context is left.
            //no operation is needed.
New to GrepCode? Check out our FAQ X