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

Class ASTMethodDeclaration

java.lang.Object

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

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

net.sourceforge.pmd.lang.java.ast.ASTMethodDeclaration

All Implemented Interfaces:

GenericNode<JavaNode>, JjtreeNode<JavaNode>, Node, TextAvailableNode, Annotatable, ASTBodyDeclaration, ASTExecutableDeclaration, JavadocCommentOwner, JavaNode, ModifierOwner, ReturnScopeNode, SymbolDeclaratorNode, TypeParamOwnerNode, Reportable

public final class ASTMethodDeclaration
extends AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

A method declaration, in a class or interface declaration. Since 7.0, this also represents annotation methods. Annotation methods have a much more restricted grammar though, in particular:

• They can't declare a throws clause
• They can't declare type parameters
• Their formal parameters must be empty
• They can't be declared void
• They must be abstract

They can however declare a default value.

 MethodDeclaration ::= ModifierList
                       TypeParameters?
                       Type
                       <IDENTIFIER>
                       FormalParameters
                       ArrayDimensions?
                       ThrowsList?
                       (Block | ";" )

 

Nested Class Summary

Nested classes/interfaces inherited from interface net.sourceforge.pmd.lang.java.ast.ModifierOwner

ModifierOwner.Visibility

Field Summary

Fields

Modifier and Type	Field	Description
protected JSymbolTable	symbolTable

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
final <P, R> R	acceptVisitor(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(JavaccToken child)
@Nullable ASTRecordComponent	getAccessedRecordComponent()	If this method declaration is an explicit record component accessor, returns the corresponding record component.
@Nullable ASTDefaultValue	getDefaultClause()	Returns the default clause, if this is an annotation method declaration that features one.
@Nullable ASTArrayDimensions	getExtraDimensions()	Returns the extra array dimensions that may be after the formal parameters.
JMethodSig	getGenericSignature()	Returns the generic signature for the method.
String	getImage()
String	getName()	Returns the name of the method, or the simple name of the declaring class for a constructor declaration.
JMethodSig	getOverriddenMethod()	Returns the signature of the method this method overrides in a supertype.
FileLocation	getReportLocation()
@NonNull ASTType	getResultTypeNode()	Returns the result type node of the method.
final @NonNull ASTCompilationUnit	getRoot()
JMethodSymbol	getSymbol()	Returns the symbol this node declares.
@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.
final String	getXPathNodeName()
protected void	insertChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
boolean	isMainMethod()	Returns whether this is a main method declaration.
boolean	isOverridden()	Deprecated. since 7.26.0.
boolean	isOverride()	Returns true if this method overrides a method in a supertype.
boolean	isVoid()	Returns true if the result type of this method is void.
void	jjtClose()
protected void	removeChildAtIndex(int childIndex)
protected void	setChild(net.sourceforge.pmd.lang.java.ast.AbstractJavaNode child, int index)
protected void	setFirstToken(JavaccToken token)
protected void	setImage(String image)
protected void	setLastToken(JavaccToken token)

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

compareLocation, fitTokensToChildren, getFirstToken, 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.java.ast.Annotatable

getAnnotation, isAnnotationPresent, isAnnotationPresent, isAnyAnnotationPresent

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

getArity, getBody, getFormalParameters, getThrowsList, isAbstract, isFinal, isStatic, isVarargs

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 net.sourceforge.pmd.lang.java.ast.JavadocCommentOwner

getJavadocComment

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

getEnclosingType, getRoot, getSymbolTable, getTypeSystem

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

getFirstToken, getLastToken, tokens

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

getDeclaredAnnotations, getEffectiveVisibility, getModifiers, getVisibility, hasExplicitModifiers, hasModifiers, hasVisibility

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

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

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

getOriginalText, getText, getTextRegion

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

getTypeParameters

Field Details

symbolTable

protected JSymbolTable symbolTable

Method Details

acceptVisitor

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

isOverride

public boolean isOverride()

Returns true if this method overrides a method in a supertype.

Since:

7.26.0

isOverridden

@Deprecated
@DeprecatedAttribute(replaceWith="@Override")
public boolean isOverridden()

Deprecated.

since 7.26.0. Use isOverride() instead.

getOverriddenMethod

public JMethodSig getOverriddenMethod()

Returns the signature of the method this method overrides in a supertype. Note that this method may be implementing several methods of super-interfaces at once, in that case, an arbitrary one is returned.

If the method has an Override annotation, but we couldn't resolve any method that is actually implemented, this will return TypeSystem.UNRESOLVED_METHOD.

getAccessedRecordComponent

public @Nullable ASTRecordComponent getAccessedRecordComponent()

If this method declaration is an explicit record component accessor, returns the corresponding record component. Otherwise returns null.

isVoid

public boolean isVoid()

Returns true if the result type of this method is void.

getDefaultClause

public @Nullable ASTDefaultValue getDefaultClause()

Returns the default clause, if this is an annotation method declaration that features one. Otherwise returns null.

getResultTypeNode

public @NonNull ASTType getResultTypeNode()

Returns the result type node of the method. This may be a ASTVoidType.

getExtraDimensions

public @Nullable ASTArrayDimensions getExtraDimensions()

Returns the extra array dimensions that may be after the formal parameters.

isMainMethod

public boolean isMainMethod()

Returns whether this is a main method declaration.

See Also:

• 12.1.4. Invoke a main Method

getImage

public String getImage()

Specified by:

getImage in interface Node

Overrides:

getImage in class AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

getSymbol

public JMethodSymbol getSymbol()

Description copied from interface: SymbolDeclaratorNode

Returns the symbol this node declares.

Specified by:

getSymbol in interface ASTExecutableDeclaration

Specified by:

getSymbol in interface SymbolDeclaratorNode

Specified by:

getSymbol in interface TypeParamOwnerNode

getGenericSignature

public JMethodSig getGenericSignature()

Description copied from interface: ASTExecutableDeclaration

Returns the generic signature for the method. This is a JMethodSig declared in the generic type declaration of the enclosing type. The signature may mention type parameters of the enclosing types, and its own type parameters.

Specified by:

getGenericSignature in interface ASTExecutableDeclaration

getReportLocation

public FileLocation getReportLocation()

Specified by:

getReportLocation in interface Node

Specified by:

getReportLocation in interface Reportable

getName

public String getName()

Description copied from interface: ASTExecutableDeclaration

Returns the name of the method, or the simple name of the declaring class for a constructor declaration.

Specified by:

getName in interface ASTExecutableDeclaration

jjtClose

public void jjtClose()

Overrides:

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

acceptVisitor

public final <P,
R> R acceptVisitor(AstVisitor<? super P,? extends R> visitor,
 P data)

Specified by:

acceptVisitor in interface Node

addChild

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

Overrides:

addChild in class 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 AbstractJjtreeNode<net.sourceforge.pmd.lang.java.ast.AbstractJavaNode,JavaNode>

removeChildAtIndex

protected void removeChildAtIndex(int childIndex)

Overrides:

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

setImage

protected void setImage(String image)

Overrides:

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

setFirstToken

protected void setFirstToken(JavaccToken token)

Overrides:

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

setLastToken

protected void setLastToken(JavaccToken token)

Overrides:

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

enlargeLeft

protected void enlargeLeft(JavaccToken child)

Overrides:

enlargeLeft in class 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 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 Node

getXPathNodeName

public final String getXPathNodeName()

Specified by:

getXPathNodeName in interface Node