org.jruby.ast

Class ArgsNode

java.lang.Object

org.jruby.ast.Node

org.jruby.ast.ArgsNode

All Implemented Interfaces:

ISourcePosition, ISourcePositionHolder, ParseResult, PositionAware

public class ArgsNode
extends Node

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

Field Summary

Fields

Modifier and Type	Field and Description
protected ArgumentNode	restArgNode

Fields inherited from class org.jruby.ast.Node

containsVariableAssignment, newline

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.
List<Node>	childNodes()
int	countKeywords()
Node[]	getArgs()
BlockArgNode	getBlock() Gets the explicit block argument of the parameter list (&block).
KeywordRestArgNode	getKeyRest()
int	getKeywordCount()
ListNode	getKeywords()
int	getKeywordsIndex()
int	getMaxArgumentsCount()
NodeType	getNodeType()
int	getOptArgIndex()
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	getRequiredKeywordCount() How many of the keywords listed happen to be required keyword args.
ArgumentNode	getRestArgNode() Gets the restArgNode.
boolean	hasKeyRest()
boolean	hasKwargs()
boolean	hasRestArg()

Methods inherited from class org.jruby.ast.Node

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

Methods inherited from class java.lang.Object

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

Field Detail

restArgNode

protected final ArgumentNode restArgNode

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.

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.

Method Detail

getArgs

public Node[] getArgs()

getOptArgIndex

public int getOptArgIndex()

getPostIndex

public int getPostIndex()

getKeywordsIndex

public int getKeywordsIndex()

getNodeType

public NodeType getNodeType()

Specified by:

getNodeType in class Node

Returns:

the nodeId

hasKwargs

public boolean hasKwargs()

countKeywords

public int countKeywords()

hasRestArg

public boolean hasRestArg()

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

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

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()

getPreCount

public int getPreCount()

getKeywords

public ListNode getKeywords()

getKeyRest

public KeywordRestArgNode getKeyRest()

hasKeyRest

public boolean hasKeyRest()

childNodes

public List<Node> childNodes()

Specified by:

childNodes in class Node

getKeywordCount

public int getKeywordCount()

getRequiredKeywordCount

public int getRequiredKeywordCount()

How many of the keywords listed happen to be required keyword args. Note: total kwargs - req kwarg = opt kwargs.