org.jruby.ast

Class LocalVarNode

java.lang.Object

org.jruby.ast.Node

org.jruby.ast.LocalVarNode

All Implemented Interfaces:

IScopedNode, SideEffectFree, INameNode, ISourcePosition, ISourcePositionHolder, ParseResult, PositionAware

public class LocalVarNode
extends Node
implements INameNode, IScopedNode, SideEffectFree

Access a local variable

Field Summary

Fields inherited from class org.jruby.ast.Node

containsVariableAssignment, newline

Constructor Summary

Constructors

Constructor and Description
LocalVarNode(ISourcePosition position, int location, java.lang.String name)

Method Summary

Modifier and Type	Method and Description
<T> T	accept(NodeVisitor<T> iVisitor) Accept for the visitor pattern.
java.util.List<Node>	childNodes()
int	getDepth() How many scopes should we burrow down to until we need to set the block variable value.
int	getIndex() Gets the index within the scope construct that actually holds the eval'd value of this local variable
java.lang.String	getName() What is the name of this variable
NodeType	getNodeType()
boolean	needsDefinitionCheck() Check whether the given node is considered always "defined" or whether it has some form of definition check.
void	setName(java.lang.String name) Set the name of this variable (for refactoring support)

Methods inherited from class org.jruby.ast.Node

containsVariableAssignment, createList, createList, createList, createList, findFirstChild, getFile, getLine, getNodeName, getPosition, isNewline, isNil, setNewline, setPosition, toString, toString, toStringInternal

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

LocalVarNode

public LocalVarNode(ISourcePosition position,
                    int location,
                    java.lang.String name)

Method Detail

getNodeType

public NodeType getNodeType()

Specified by:

getNodeType in class Node

Returns:

the nodeId

accept

public <T> T accept(NodeVisitor<T> iVisitor)

Accept for the visitor pattern.

Specified by:

accept in class Node

Parameters:

iVisitor - the visitor

getDepth

public int getDepth()

How many scopes should we burrow down to until we need to set the block variable value.

Specified by:

getDepth in interface IScopedNode

Returns:

0 for current scope, 1 for one down, ...

getIndex

public int getIndex()

Gets the index within the scope construct that actually holds the eval'd value of this local variable

Specified by:

getIndex in interface IScopedNode

Returns:

Returns an int offset into storage structure

getName

public java.lang.String getName()

What is the name of this variable

Specified by:

getName in interface INameNode

Returns:

the name of the variable

setName

public void setName(java.lang.String name)

Set the name of this variable (for refactoring support)

Parameters:

name - the new name

childNodes

public java.util.List<Node> childNodes()

Specified by:

childNodes in class Node

needsDefinitionCheck

public boolean needsDefinitionCheck()

Description copied from class: Node

Check whether the given node is considered always "defined" or whether it has some form of definition check.

Overrides:

needsDefinitionCheck in class Node

Returns:

Whether the type of node represents a possibly undefined construct