org.jrubyparser.ast
Class ArgumentNode

java.lang.Object
  org.jrubyparser.ast.Node
      org.jrubyparser.ast.ArgumentNode

All Implemented Interfaces:

ILocalVariable, INameMatchable, INameNode, IParameter, ISourcePositionHolder

Direct Known Subclasses:

KeywordRestArgNode, RestArgNode, TypedArgumentNode

public class ArgumentNode
extends Node
implements IParameter

Simple Node that allows editor projects to keep position info in AST (evaluation does not need this).

Constructor Summary

ArgumentNode(SourcePosition position, String identifier)

ArgumentNode(SourcePosition position, String identifier, int location)

Method Summary

Object	accept(NodeVisitor visitor)
ILocalVariable	getDeclaration() Retrieve the node which is responsible for declaring this one.
IScope	getDefinedScope() Which Variable Scope does this variable belong to? Note that RootNode is a special ILocalScope for the implicit scope created at top-level.
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
String	getLexicalName() Get the name including any leading sigils.
SourcePosition	getLexicalNamePosition() The position of the name + any sigils that come with it.
String	getName() Get the plain name without sigils.
SourcePosition	getNamePosition() The position of just the name part of the node.
NodeType	getNodeType()
List<ILocalVariable>	getOccurrences() Find all occurences of this variable including itself.
boolean	isNameMatch(String name)
boolean	isSame(Node other) Checks node for 'sameness' for diffing.
void	setName(String name) Set the name (name should not include sigils).

Methods inherited from class org.jrubyparser.ast.Node

adopt, adopt, adoptUsingNodesPosition, childNodes, comparePositionWith, createList, getClosestIScope, getClosestModule, getGrandParent, getInlineComment, getInnermostIter, getMethodFor, getNodeAt, getNodeName, getOutermostIter, getParent, getPosition, getPositionIncludingComments, getPreviousComments, insertAfter, insertAll, insertBefore, insertNode, isBlockParameter, isDescendentOf, isLeaf, isMethodParameter, setParent, setPosition, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ArgumentNode

public ArgumentNode(SourcePosition position,
                    String identifier)

ArgumentNode

public ArgumentNode(SourcePosition position,
                    String identifier,
                    int location)

Method Detail

isSame

public boolean isSame(Node other)

Checks node for 'sameness' for diffing.

Overrides:

isSame in class Node

Parameters:

other - to be compared to

Returns:

Returns a boolean

getNodeType

public NodeType getNodeType()

Specified by:

getNodeType in class Node

Returns:

the nodeId

accept

public Object accept(NodeVisitor visitor)

Specified by:

accept in class Node

getDepth

public int getDepth()

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

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

Returns:

Returns an int offset into storage structure

getLexicalName

public String getLexicalName()

Description copied from interface: INameNode

Get the name including any leading sigils.

Specified by:

getLexicalName in interface INameNode

getName

public String getName()

Description copied from interface: INameNode

Get the plain name without sigils.

Specified by:

getName in interface INameNode

setName

public void setName(String name)

Description copied from interface: INameNode

Set the name (name should not include sigils).

Specified by:

setName in interface INameNode

isNameMatch

public boolean isNameMatch(String name)

Specified by:

isNameMatch in interface INameMatchable

getDefinedScope

public IScope getDefinedScope()

Description copied from interface: ILocalVariable

Which Variable Scope does this variable belong to? Note that RootNode is a special ILocalScope for the implicit scope created at top-level.

Specified by:

getDefinedScope in interface ILocalVariable

getOccurrences

public List<ILocalVariable> getOccurrences()

Description copied from interface: ILocalVariable

Find all occurences of this variable including itself.

Specified by:

getOccurrences in interface ILocalVariable

getDeclaration

public ILocalVariable getDeclaration()

Description copied from interface: ILocalVariable

Retrieve the node which is responsible for declaring this one. This can be a variable or a parameter.

Specified by:

getDeclaration in interface ILocalVariable

getNamePosition

public SourcePosition getNamePosition()

Description copied from interface: INameNode

The position of just the name part of the node.

Specified by:

getNamePosition in interface INameNode

getLexicalNamePosition

public SourcePosition getLexicalNamePosition()

Description copied from interface: INameNode

The position of the name + any sigils that come with it.

Specified by:

getLexicalNamePosition in interface INameNode