Package org.jruby.embed.variable

Class GlobalVariable

java.lang.Object
org.jruby.embed.variable.GlobalVariable
All Implemented Interfaces:
BiVariable
Direct Known Subclasses:
LocalGlobalVariable
public class GlobalVariable extends Object
An implementation of BiVariable for a Ruby global variable.
Author:
Yoko Harada <[email protected]>

  • Field Details

    • receiver

      protected final IRubyObject receiver

    • name

      protected final String name

    • javaObject

      protected volatile Object javaObject

    • javaType

      protected volatile Class javaType

    • rubyObject

      protected volatile IRubyObject rubyObject

    • fromRuby

      protected volatile boolean fromRuby

  • Constructor Details

  • 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 global variable is put in BiVariableMap.
      Parameters:
      receiver - Receiver object returned when a script is evaluated.
      name - a variable name
      javaObject - Java object that should be assigned to.
      Returns:
      the instance of GlobalVariable

    • retrieve

      public static void retrieve(IRubyObject receiver, BiVariableMap vars)
      Retrieves global variables from Ruby after the evaluation.
      Parameters:
      receiver - receiver object returned when a script is evaluated.
      vars - map to save retrieved global variables.

    • retrieveByKey

      public static void retrieveByKey(Ruby runtime, BiVariableMap vars, String key)
      Retrieves a global variable by key from Ruby after the evaluation.
      Parameters:
      runtime - Ruby runtime
      vars - map to save a retrieved global variable.
      key - name of the global variable

    • isPredefined

      protected static boolean isPredefined(String name)

    • getType

      public BiVariable.Type getType()
      Returns enum type of this variable defined in BiVariable.
      Returns:
      this enum type, BiVariable.Type.GlobalVariable.

    • isValidName

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

    • setJavaObject

      public void setJavaObject(Ruby runtime, Object javaObject)
      Sets a Java object and its Ruby type as a value of this object. At the same time, sets Ruby object to Ruby runtime.
      Specified by:
      setJavaObject in interface BiVariable
      Parameters:
      runtime - is used to convert a Java object to Ruby object.
      javaObject - is a variable value to be set.

    • inject

      public void inject()
      A global variable is injected when it is set. This method does nothing. Instead injection is done by tryEagerInjection.

    • tryEagerInjection

      @Deprecated public void tryEagerInjection(Ruby runtime, IRubyObject receiver)
      Deprecated.

    • tryEagerInjection

      public void tryEagerInjection(IRubyObject receiver)
      Injects a global variable value to a parsed Ruby script. This method is invoked during EvalUnit#run() is executed.
      Parameters:
      receiver - is the instance that will have variable injection.

    • remove

      public void remove()
      Attempts to remove this variable from top self or receiver.

    • isReceiverIdentical

      public boolean isReceiverIdentical(RubyObject recv)
      Returns true if a given receiver is identical to the receiver this object has.
      Specified by:
      isReceiverIdentical in interface BiVariable
      Returns:
      true always

    • updateByJavaObject

      protected void updateByJavaObject(Ruby runtime, Object... values)

    • updateRubyObject

      protected void updateRubyObject(IRubyObject rubyObject)

    • getReceiver

      public IRubyObject getReceiver()
      Description copied from interface: BiVariable
      Returns the original receiver where this variable has been retrieved.
      Specified by:
      getReceiver in interface BiVariable
      Returns:
      an original receiver.

    • getName

      public String getName()
      Description copied from interface: BiVariable
      Returns a name of the variable this object holds. The name follows Ruby's naming rule.
      Specified by:
      getName in interface BiVariable
      Returns:
      a name of the variable

    • getJavaObject

      public Object getJavaObject()
      Description copied from interface: BiVariable
      Returns a value of the variable this object holds in Java type.
      Specified by:
      getJavaObject in interface BiVariable
      Returns:
      a value in Java type.

    • getRubyObject

      public IRubyObject getRubyObject()
      Description copied from interface: BiVariable
      Returns a value of the variable this object holds in a org.jruby.runtime.builtin.IRubyObject type.
      Specified by:
      getRubyObject in interface BiVariable
      Returns:
      a value in IRubyObject type.

    • setRubyObject

      public void setRubyObject(IRubyObject rubyObject)
      Description copied from interface: BiVariable
      Sets a org.jruby.runtime.builtin.IRubyObject type, Ruby object as a value of this object. At the same time, an equivalent Java object is set automatically.
      Specified by:
      setRubyObject in interface BiVariable
      Parameters:
      rubyObject - is a variable value to be set.

    • getRubyClass

      protected static RubyModule getRubyClass(Ruby runtime)

    • isValidName

      protected static boolean isValidName(String pattern, Object name)