Package net.sourceforge.pmd.lang.java.ast

Class ASTFormalParameters

java.lang.Object

net.sourceforge.pmd.lang.ast.impl.AbstractNode<B,N>

net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

net.sourceforge.pmd.lang.java.ast.ASTList<ASTFormalParameter>

net.sourceforge.pmd.lang.java.ast.ASTFormalParameters

All Implemented Interfaces:

Iterable<ASTFormalParameter>, net.sourceforge.pmd.lang.ast.impl.GenericNode<JavaNode>, net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeNode<JavaNode>, net.sourceforge.pmd.lang.ast.Node, net.sourceforge.pmd.lang.ast.TextAvailableNode, JavaNode, net.sourceforge.pmd.reporting.Reportable

public final class ASTFormalParameters
extends ASTList<ASTFormalParameter>

A list of formal parameters in a method or constructor declaration. Some formal parameter lists may feature a receiver parameter. That is not treated as a regular formal parameter, as it does not declare a variable.

 FormalParameters ::=  "(" ")"
                    |  "(" (ReceiverParameter | FormalParameter) ("," FormalParameter)* ")"

 

Field Summary

Fields

Modifier and Type	Field	Description
protected JSymbolTable	symbolTable

Fields inherited from class net.sourceforge.pmd.lang.java.ast.ASTList

elementType

Fields inherited from class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode

id

Fields inherited from interface net.sourceforge.pmd.lang.ast.Node

COORDS_COMPARATOR

Method Summary

Modifier and Type	Method	Description
<P,R> R	acceptVisitor(net.sourceforge.pmd.lang.ast.AstVisitor<? super P,? extends R> visitor, P data)
protected <P,R> R	acceptVisitor(JavaVisitor<? super P,? extends R> visitor, P data)
protected void	addChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
protected void	enlargeLeft(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken child)
@Nullable ASTReceiverParameter	getReceiverParameter()	Returns the receiver parameter if it is present, otherwise returns null.
@NonNull ASTCompilationUnit	getRoot()
@NonNull JSymbolTable	getSymbolTable()	Returns the symbol table for the program point represented by this node.
TypeSystem	getTypeSystem()	Returns the type system with which this node was created.
String	getXPathNodeName()
protected void	insertChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
void	jjtClose()
protected void	removeChildAtIndex(int childIndex)
protected void	setChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
protected void	setFirstToken(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken token)
protected void	setImage(String image)
protected void	setLastToken(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken token)
int	size()	Returns the number of formal parameters.

Methods inherited from class net.sourceforge.pmd.lang.java.ast.ASTList

get, isEmpty, iterator, orEmpty, orEmptyStream, singleOrNull, sizeOrZero, toList, toStream

Methods inherited from class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode

compareLocation, fitTokensToChildren, getFirstToken, getImage, getLastToken, getTextRegion, jjtOpen, toString

Methods inherited from class net.sourceforge.pmd.lang.ast.impl.AbstractNode

children, firstChild, getChild, getIndexInParent, getNumChildren, getParent, getUserMap, remove, setParent

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.sourceforge.pmd.lang.ast.impl.GenericNode

ancestors, ancestorsOrSelf, asStream, children, descendants, descendantsOrSelf, getChild, getFirstChild, getLastChild, getNextSibling, getParent, getPreviousSibling

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface net.sourceforge.pmd.lang.java.ast.JavaNode

getEnclosingType

Methods inherited from interface net.sourceforge.pmd.lang.ast.impl.javacc.JjtreeNode

getFirstToken, getLastToken, tokens

Methods inherited from interface net.sourceforge.pmd.lang.ast.Node

ancestors, children, compareLocation, descendants, firstChild, getAstInfo, getBeginColumn, getBeginLine, getEndColumn, getEndLine, getImage, getIndexInParent, getLanguageVersion, getNumChildren, getReportLocation, getTextDocument, getUserMap, getXPathAttributesIterator, hasImageEqualTo, isFindBoundary

Methods inherited from interface net.sourceforge.pmd.lang.ast.TextAvailableNode

getOriginalText, getText, getTextRegion

Field Detail

symbolTable

protected JSymbolTable symbolTable

Method Detail

size

public int size()

Returns the number of formal parameters. This excludes the receiver parameter, if any.

Overrides:

size in class ASTList<ASTFormalParameter>

acceptVisitor

protected <P,R> R acceptVisitor(JavaVisitor<? super P,? extends R> visitor,
                                      P data)

getReceiverParameter

public @Nullable ASTReceiverParameter getReceiverParameter()

Returns the receiver parameter if it is present, otherwise returns null.

jjtClose

public void jjtClose()

Overrides:

jjtClose in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

acceptVisitor

public final <P,R> R acceptVisitor(net.sourceforge.pmd.lang.ast.AstVisitor<? super P,? extends R> visitor,
                                         P data)

Specified by:

acceptVisitor in interface net.sourceforge.pmd.lang.ast.Node

addChild

protected void addChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child,
                        int index)

Overrides:

addChild in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

insertChild

protected void insertChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child,
                           int index)

Overrides:

insertChild in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

removeChildAtIndex

protected void removeChildAtIndex(int childIndex)

Overrides:

removeChildAtIndex in class net.sourceforge.pmd.lang.ast.impl.AbstractNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

setImage

protected void setImage(String image)

Overrides:

setImage in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

setFirstToken

protected void setFirstToken(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken token)

Overrides:

setFirstToken in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

setLastToken

protected void setLastToken(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken token)

Overrides:

setLastToken in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

enlargeLeft

protected void enlargeLeft(net.sourceforge.pmd.lang.ast.impl.javacc.JavaccToken child)

Overrides:

enlargeLeft in class net.sourceforge.pmd.lang.ast.impl.javacc.AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

setChild

protected void setChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child,
                        int index)

Overrides:

setChild in class net.sourceforge.pmd.lang.ast.impl.AbstractNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

getSymbolTable

public @NonNull JSymbolTable getSymbolTable()

Description copied from interface: JavaNode

Returns the symbol table for the program point represented by this node.

Specified by:

getSymbolTable in interface JavaNode

getTypeSystem

public TypeSystem getTypeSystem()

Description copied from interface: JavaNode

Returns the type system with which this node was created. This is the object responsible for representing types in the compilation unit.

Specified by:

getTypeSystem in interface JavaNode

getRoot

public final @NonNull ASTCompilationUnit getRoot()

Specified by:

getRoot in interface JavaNode

Specified by:

getRoot in interface net.sourceforge.pmd.lang.ast.Node

getXPathNodeName

public final String getXPathNodeName()

Specified by:

getXPathNodeName in interface net.sourceforge.pmd.lang.ast.Node