Package org.jruby.ast

Class ArgsNode

java.lang.Object

org.jruby.ast.Node

org.jruby.ast.ArgsNode

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	Description
private final Node[]	args
private final BlockArgNode	blockArgNode
private final KeywordRestArgNode	keyRest
private final short	keywordsIndex
private static final Node[]	NO_ARGS
private final short	optIndex
private final short	postIndex
protected final RestArgNode	restArgNode

Fields inherited from class org.jruby.ast.Node

containsVariableAssignment, EMPTY_LIST, newline

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
<T> T	accept(NodeVisitor<T> iVisitor)	Accept for the visitor pattern.
List<Node>	childNodes()
Node[]	getArgs()
BlockArgNode	getBlock()	Gets the explicit block argument of the parameter list (&block).
KeywordRestArgNode	getKeyRest()
int	getKeywordCount()
ListNode	getKeywords()
int	getKeywordsIndex()
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.
RestArgNode	getRestArgNode()	Gets the restArgNode.
boolean	hasKeyRest()
boolean	hasKwargs()
boolean	hasRestArg()

Methods inherited from class org.jruby.ast.Node

containsVariableAssignment, createList, createList, createList, createList, executesOnce, findFirstChild, getFile, getLine, getNodeName, isNewline, isNil, needsDefinitionCheck, setLine, setNewline, toString, toString, toStringExtraInfo, toStringInternal, unsetNewline

Methods inherited from class java.lang.Object

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

Field Details

args

private final Node[] args

optIndex

private final short optIndex

postIndex

private final short postIndex

keywordsIndex

private final short keywordsIndex

restArgNode

protected final RestArgNode restArgNode

keyRest

private final KeywordRestArgNode keyRest

blockArgNode

private final BlockArgNode blockArgNode

NO_ARGS

private static final Node[] NO_ARGS

Constructor Details

ArgsNode

public ArgsNode(int line,
 ListNode pre,
 ListNode optionalArguments,
 RestArgNode rest,
 ListNode post,
 BlockArgNode blockArgNode)

Construct a new ArgsNode with no keyword arguments.

ArgsNode

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

Construct a new ArgsNode with keyword arguments.

Method Details

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

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

getOptArgs

public ListNode getOptArgs()

Gets the optArgs.

Returns:

Returns a ListNode

getRestArgNode

public RestArgNode getRestArgNode()

Gets the restArgNode.

Returns:

Returns an ArgumentNode

hasRestArg

public boolean hasRestArg()

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.