Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
**** BEGIN LICENSE BLOCK ***** Version: EPL 1.0/GPL 2.0/LGPL 2.1 The contents of this file are subject to the Eclipse 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 http://www.eclipse.org/legal/epl-v10.html 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 <yokolet@gmail.com> 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 EPL, 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 EPL, the GPL or the LGPL. **** END LICENSE BLOCK *****
 
 package org.jruby.embed.variable;
 
 import java.util.List;
An implementation of BiVariable for a Ruby class variable.

Author(s):
Yoko Harada <yokolet@gmail.com>
 
 public class ClassVariable extends AbstractVariable {
     private static String pattern = "@@([a-zA-Z]|_)([a-zA-Z]|_|\\d)*";

    
Returns an instance of this class. This factory method is used when a class variables is put in org.jruby.embed.internal.BiVariableMap. This variable is originated from Java.

Parameters:
runtime
name a variable name
javaObject Java object that should be assigned to.
Returns:
the instance of ClassVariable
 
     public static BiVariable getInstance(RubyObject receiverString nameObject... javaObject) {
         if (name.matches()) {
             return new ClassVariable(receivernamejavaObject);
         }
         return null;
     }

    
Constructor when the variable is originated from Java

Parameters:
receiver
name
javaObject
 
     private ClassVariable(RubyObject receiverString nameObject... javaObjects) {
         super(receivernamefalse);
         updateByJavaObject(receiver.getRuntime(), javaObjects);
     }

    
A constructor used when this variable 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 class variable name
irubyObject Ruby class variable object
 
     ClassVariable(IRubyObject receiverString nameIRubyObject irubyObject) {
         super(receivernametrueirubyObject);
     }

    
Retrieves class variables from Ruby after the evaluation.

Parameters:
runtime Ruby runtime
receiver receiver object returned when a script is evaluated.
vars map to save retrieved class variables.
 
     public static void retrieve(RubyObject receiverBiVariableMap vars) {
         if (vars.isLazy()) return;
         // trying to get variables from receiver;
         updateClassVar(receivervars);
         // trying to get variables from topself.
         RubyObject topSelf = (RubyObjectreceiver.getRuntime().getTopSelf();
        updateClassVar(topSelfvars);
    }
    private static void updateClassVar(RubyObject receiverBiVariableMap vars) {
        List<Stringkeys = receiver.getMetaClass().getClassVariableNameList();
        for (String key : keys) {
            IRubyObject value = receiver.getMetaClass().getClassVar(key);
            BiVariable var = vars.getVariable(receiverkey);
            if (var != null) {
                var.setRubyObject(value);
            } else {
                var = new ClassVariable(receiverkeyvalue);
                vars.update(keyvar);
            }
        }
    }

    
Retrieves a class variable 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
    public static void retrieveByKey(RubyObject receiverBiVariableMap varsString key) {
        IRubyObject value = null;
        if (receiver == receiver.getRuntime().getTopSelf()
                && receiver.getMetaClass().getClassVariableNameList().contains(key)) {
            value = receiver.getMetaClass().getClassVar(key);
        } else {
            RubyClass klazz = receiver.getMetaClass();
            if (klazz.hasClassVariable(key.intern())) {
                value = klazz.getClassVar(key.intern());
            }
        }
        if (value == nullreturn;
        
        BiVariable var = vars.getVariable(receiverkey);
        if (var != null) {
            var.setRubyObject(value);
        } else {
            var = new ClassVariable(receiverkeyvalue);
            vars.update(keyvar);
        }
    }

    
Returns enum type of this variable defined in BiVariable.

Returns:
this enum type, BiVariable.Type.ClassVariable.
    public Type getType() {
        return .;
    }

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

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

    
Injects a class variable value 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.
    public void inject() {
        RubyModule rubyClass = getRubyClass(.getRuntime());
        rubyClass.setClassVar();
    }

    
Attempts to remove this variable from top self or receiver.
    public void remove() {
        RubyModule rubyClass = getRubyClass(.getRuntime());
        rubyClass.removeClassVariable();
    }
New to GrepCode? Check out our FAQ X