/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */

package org.jruby.runtime.builtin;

Interface that gives access to the internal variables of a Ruby
object.
Author:
headius/**
 * Interface that gives access to the internal variables of a Ruby
 * object.
 *
 * @author headius
 */
public interface InternalVariables {
    
Returns true if object has the named internal variable.  Use only
for internal variables (not ivar/cvar/constant).
Params:
name – the name of an internal variable
Returns:
true if object has the named internal variable./**
     * Returns true if object has the named internal variable.  Use only
     * for internal variables (not ivar/cvar/constant).
     * 
     * @param name the name of an internal variable
     * @return true if object has the named internal variable.
     */
    boolean hasInternalVariable(String name);

    @Deprecated
    boolean fastHasInternalVariable(String internedName);
    
    
Returns the named internal variable if present, else null.  Use only
for internal variables (not ivar/cvar/constant).
Params:
name – the name of an internal variable
Returns:
the named internal variable if present, else null/**
     * Returns the named internal variable if present, else null.  Use only
     * for internal variables (not ivar/cvar/constant).
     * 
     * @param name the name of an internal variable
     * @return the named internal variable if present, else null
     */
    Object getInternalVariable(String name);

    @Deprecated
    Object fastGetInternalVariable(String internedNaem);
    
    
Sets the named internal variable to the specified value.  Use only
for internal variables (not ivar/cvar/constant).
Params:
name – the name of an internal variable
value – the value to be set/**
     * Sets the named internal variable to the specified value.  Use only
     * for internal variables (not ivar/cvar/constant).
     * 
     * @param name the name of an internal variable
     * @param value the value to be set
     */
    void setInternalVariable(String name, Object value);

    @Deprecated
    void fastSetInternalVariable(String internedName, Object value);
    
    
Removes the named internal variable, if present, returning its
value.  Use only for internal variables (not ivar/cvar/constant).
Params:
name – the name of the variable to remove
Returns:
the value of the remove variable, if present; else null/**
     * Removes the named internal variable, if present, returning its
     * value.  Use only for internal variables (not ivar/cvar/constant).
     * 
     * @param name the name of the variable to remove
     * @return the value of the remove variable, if present; else null
     */
    Object removeInternalVariable(String name);
}