org.jruby.ast

Class ArgsNode

java.lang.Object

org.jruby.ast.Node

org.jruby.ast.ArgsNode

All Implemented Interfaces:

ISourcePositionHolder, ParseResult

public class ArgsNode
extends Node

Represents the argument declarations of a method. The fields: foo(p1, ..., pn, o1 = v1, ..., on = v2, *r, q1, ..., qn) p1...pn = pre arguments o1...on = optional arguments r = rest argument q1...qn = post arguments (only in 1.9)

Field Summary

Fields

Modifier and Type	Field and Description
protected Arity	arity
protected boolean	hasKwargs
protected boolean	hasMasgnArgs
protected boolean	hasOptArgs
protected boolean	isSimple
protected int	maxArgsCount
protected int	restArg
protected ArgumentNode	restArgNode

Constructor Summary

Constructors

Constructor and Description
ArgsNode(ISourcePosition position, ListNode pre, ListNode optionalArguments, RestArgNode rest, ListNode post, BlockArgNode blockArgNode) Construct a new ArgsNode with no keyword arguments.
ArgsNode(ISourcePosition position, ListNode pre, ListNode optionalArguments, RestArgNode rest, ListNode post, ListNode keywords, KeywordRestArgNode keyRest, BlockArgNode blockArgNode) Construct a new ArgsNode with keyword arguments.

Method Summary

Methods

Modifier and Type	Method and Description
<T> T	accept(NodeVisitor<T> iVisitor) Accept for the visitor pattern.
protected Arity	calculateArity()
void	checkArgCount(Ruby runtime, int argsLength)
void	checkArgCount(Ruby runtime, String name, int argsLength)
List<Node>	childNodes()
Arity	getArity()
BlockArgNode	getBlock() Gets the explicit block argument of the parameter list (&block).
KeywordRestArgNode	getKeyRest()
ListNode	getKeywords()
int	getMaxArgumentsCount()
NodeType	getNodeType()
ListNode	getOptArgs() Gets the optArgs.
int	getOptionalArgsCount()
ListNode	getPost()
int	getPostCount()
int	getPostIndex()
ListNode	getPre() Gets the required arguments at the beginning of the argument definition
int	getPreCount()
int	getRequiredArgsCount()
int	getRestArg() Gets the restArg.
ArgumentNode	getRestArgNode() Gets the restArgNode.
boolean	hasKwargs()
protected boolean	hasMasgnArgs()

Methods inherited from class org.jruby.ast.Node

createList, createList, createList, createList, findFirstChild, getNodeName, getPosition, isNil, needsDefinitionCheck, setPosition, toString, toString

Methods inherited from class java.lang.Object

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

Field Detail

restArgNode

protected final ArgumentNode restArgNode

restArg

protected final int restArg

arity

protected Arity arity

hasOptArgs

protected final boolean hasOptArgs

hasMasgnArgs

protected final boolean hasMasgnArgs

hasKwargs

protected final boolean hasKwargs

maxArgsCount

protected int maxArgsCount

isSimple

protected final boolean isSimple

Constructor Detail

ArgsNode

public ArgsNode(ISourcePosition position,
        ListNode pre,
        ListNode optionalArguments,
        RestArgNode rest,
        ListNode post,
        BlockArgNode blockArgNode)

Construct a new ArgsNode with no keyword arguments.

Parameters:

position -

pre -

optionalArguments -

rest -

post -

blockArgNode -

ArgsNode

public ArgsNode(ISourcePosition position,
        ListNode pre,
        ListNode optionalArguments,
        RestArgNode rest,
        ListNode post,
        ListNode keywords,
        KeywordRestArgNode keyRest,
        BlockArgNode blockArgNode)

Construct a new ArgsNode with keyword arguments.

Parameters:

position -

pre -

optionalArguments -

rest -

post -

keywords -

keyRest -

blockArgNode -

Method Detail

getNodeType

public NodeType getNodeType()

Specified by:

getNodeType in class Node

Returns:

the nodeId

calculateArity

protected Arity calculateArity()

hasKwargs

public boolean hasKwargs()

hasMasgnArgs

protected boolean hasMasgnArgs()

accept

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

Accept for the visitor pattern.

Specified by:

accept in class Node

Parameters:

iVisitor - the visitor

getPre

public ListNode getPre()

Gets the required arguments at the beginning of the argument definition

getArity

public Arity getArity()

getRequiredArgsCount

public int getRequiredArgsCount()

getOptionalArgsCount

public int getOptionalArgsCount()

getPost

public ListNode getPost()

getMaxArgumentsCount

public int getMaxArgumentsCount()

getOptArgs

public ListNode getOptArgs()

Gets the optArgs.

Returns:

Returns a ListNode

getRestArg

public int getRestArg()

Gets the restArg.

Returns:

Returns a int

getRestArgNode

public ArgumentNode getRestArgNode()

Gets the restArgNode.

Returns:

Returns an ArgumentNode

getBlock

public BlockArgNode getBlock()

Gets the explicit block argument of the parameter list (&block).

Returns:

Returns a BlockArgNode

getPostCount

public int getPostCount()

getPostIndex

public int getPostIndex()

getPreCount

public int getPreCount()

getKeywords

public ListNode getKeywords()

getKeyRest

public KeywordRestArgNode getKeyRest()

checkArgCount

public void checkArgCount(Ruby runtime,
                 int argsLength)

checkArgCount

public void checkArgCount(Ruby runtime,
                 String name,
                 int argsLength)

childNodes

public List<Node> childNodes()

Specified by:

childNodes in class Node