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

Class ASTMethodDeclaration

java.lang.Object

net.sourceforge.pmd.lang.ast.AbstractNode

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

net.sourceforge.pmd.lang.java.ast.AbstractJavaNode

net.sourceforge.pmd.lang.java.ast.AbstractJavaAccessNode

net.sourceforge.pmd.lang.java.ast.AbstractMethodLikeNode

net.sourceforge.pmd.lang.java.ast.AbstractMethodOrConstructorDeclaration

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

All Implemented Interfaces:

net.sourceforge.pmd.lang.ast.Node, net.sourceforge.pmd.lang.ast.QualifiableNode, net.sourceforge.pmd.lang.ast.SignedNode<ASTMethodOrConstructorDeclaration>, net.sourceforge.pmd.lang.dfa.DFAGraphMethod, AccessNode, Annotatable, ASTMethodOrConstructorDeclaration, JavaNode, JavaQualifiableNode, MethodLikeNode, net.sourceforge.pmd.lang.symboltable.ScopedNode

public class ASTMethodDeclaration
extends AbstractMethodOrConstructorDeclaration
implements net.sourceforge.pmd.lang.dfa.DFAGraphMethod

Method declaration node.

 MethodDeclaration := [ TypeParameters() ] (TypeAnnotation())* ResultType() MethodDeclarator() [ "throws" NameList() ] ( Block() | ";" )
 

Nested Class Summary

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

MethodLikeNode.MethodLikeKind

Field Summary

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

parser

Fields inherited from class net.sourceforge.pmd.lang.ast.AbstractNode

beginColumn, beginLine, childIndex, children, endColumn, endLine, firstToken, id, lastToken, parent

Fields inherited from interface net.sourceforge.pmd.lang.java.ast.AccessNode

ABSTRACT, DEFAULT, FINAL, NATIVE, PRIVATE, PROTECTED, PUBLIC, STATIC, STRICTFP, SYNCHRONIZED, TRANSIENT, VOLATILE

Constructor Summary

Constructors

Constructor	Description
ASTMethodDeclaration(int id)	Deprecated.
ASTMethodDeclaration(JavaParser p, int id)	Deprecated.

Method Summary

Modifier and Type	Method	Description
ASTAnnotation	getAnnotation(String annotQualifiedName)	Get specific annotaion on this node.
int	getArity()	Returns the number of formal parameters expected by this method (excluding any receiver parameter).
ASTBlock	getBlock()	Deprecated. Use getBody()
ASTBlock	getBody()	Returns the block defined by this method, or null if the method is abstract.
List<ASTAnnotation>	getDeclaredAnnotations()	Get all annotations present on this node.
ASTFormalParameters	getFormalParameters()
MethodLikeNode.MethodLikeKind	getKind()	Returns a token indicating whether this node is a lambda expression or a method or constructor declaration.
ASTMethodDeclarator	getMethodDeclarator()	Deprecated. Method declarator nodes will be removed with 7.0.0
String	getMethodName()	Deprecated. Use getName()
String	getName()	Returns the simple name of the method.
ASTResultType	getResultType()	Returns the result type node of the method.
ASTNameList	getThrows()	Returns the exception names listed in the throws clause of this method declaration, or null if there are none.
boolean	isAbstract()	Returns true if this method is abstract, so doesn't declare a body.
boolean	isAnnotationPresent(String annotQualifiedName)	Checks whether the annotation is present on this node.
boolean	isAnyAnnotationPresent(Collection<String> annotQualifiedNames)	Checks whether any annotation is present on this node.
boolean	isInterfaceMember()	Returns true if this method declaration is a member of an interface type.
boolean	isPublic()	Returns true if this method has public visibility.
boolean	isSyntacticallyAbstract()	Returns true if this method is explicitly modified by the abstract modifier.
boolean	isSyntacticallyPublic()	Returns true if this method is explicitly modified by the public modifier.
boolean	isVoid()	Returns true if the result type of this method is void.
Object	jjtAccept(JavaParserVisitor visitor, Object data)	Calls back the visitor's visit method corresponding to the runtime type of this Node.

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

getSignature

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

getQualifiedName, setQualifiedName

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

getModifiers, isDefault, isFinal, isNative, isPackagePrivate, isPrivate, isProtected, isStatic, isStrictfp, isSynchronized, isTransient, isVolatile, setAbstract, setDefault, setFinal, setModifiers, setNative, setPrivate, setProtected, setPublic, setStatic, setStrictfp, setSynchronized, setTransient, setVolatile

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

childrenAccept, comment, comment, getScope, getXPathNodeName, jjtClose, jjtOpen, setScope

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

children, getChild, getParent

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

appendElement, findChildNodesWithXPath, findChildrenOfType, findDescendantsOfType, findDescendantsOfType, findDescendantsOfType, getAsDocument, getBeginColumn, getBeginLine, getDataFlowNode, getEndColumn, getEndLine, getFirstChildOfType, getFirstDescendantOfType, getFirstParentOfAnyType, getFirstParentOfType, getImage, getIndexInParent, getNthParent, getNumChildren, getParentsOfType, getUserData, getUserMap, getXPathAttributesIterator, hasDecendantOfAnyType, hasDescendantMatchingXPath, hasDescendantOfAnyType, hasDescendantOfType, hasImageEqualTo, isFindBoundary, isSingleLine, jjtAddChild, jjtGetChild, jjtGetChildIndex, jjtGetFirstToken, jjtGetId, jjtGetLastToken, jjtGetNumChildren, jjtGetParent, jjtSetChildIndex, jjtSetFirstToken, jjtSetLastToken, jjtSetParent, remove, removeChildAtIndex, setDataFlowNode, setImage, setUserData, testingOnlySetBeginColumn, testingOnlySetBeginLine, testingOnlySetEndColumn, testingOnlySetEndLine, toString

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.AccessNode

getModifiers, isDefault, isFinal, isNative, isPackagePrivate, isPrivate, isProtected, isStatic, isStrictfp, isSynchronized, isTransient, isVolatile, setAbstract, setDefault, setFinal, setModifiers, setNative, setPrivate, setProtected, setPublic, setStatic, setStrictfp, setSynchronized, setTransient, setVolatile

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

children, childrenAccept, getChild, getParent, setScope

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

getQualifiedName

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

findChildNodesWithXPath, findChildrenOfType, findDescendantsOfType, findDescendantsOfType, findDescendantsOfType, getAsDocument, getBeginColumn, getBeginLine, getDataFlowNode, getEndColumn, getEndLine, getFirstChildOfType, getFirstDescendantOfType, getFirstParentOfAnyType, getFirstParentOfType, getImage, getIndexInParent, getNthParent, getNumChildren, getParentsOfType, getUserData, getUserMap, getXPathAttributesIterator, getXPathNodeName, hasDescendantMatchingXPath, hasDescendantOfType, hasImageEqualTo, isFindBoundary, jjtAddChild, jjtClose, jjtGetChild, jjtGetChildIndex, jjtGetId, jjtGetNumChildren, jjtGetParent, jjtOpen, jjtSetChildIndex, jjtSetParent, remove, removeChildAtIndex, setDataFlowNode, setImage, setUserData

Methods inherited from interface net.sourceforge.pmd.lang.symboltable.ScopedNode

getScope

Constructor Detail

ASTMethodDeclaration

@InternalApi
@Deprecated
public ASTMethodDeclaration(int id)

Deprecated.

ASTMethodDeclaration

@InternalApi
@Deprecated
public ASTMethodDeclaration(JavaParser p,
                            int id)

Deprecated.

Method Detail

jjtAccept

public Object jjtAccept(JavaParserVisitor visitor,
                        Object data)

Description copied from interface: JavaNode

Calls back the visitor's visit method corresponding to the runtime type of this Node.

Specified by:

jjtAccept in interface JavaNode

Overrides:

jjtAccept in class AbstractJavaNode

Parameters:

visitor - Visitor to dispatch

data - Visit data

getMethodName

@Deprecated
public String getMethodName()

Deprecated.

Use getName()

Returns the simple name of the method.

getName

public String getName()

Returns the simple name of the method.

Specified by:

getName in interface net.sourceforge.pmd.lang.dfa.DFAGraphMethod

isSyntacticallyPublic

public boolean isSyntacticallyPublic()

Returns true if this method is explicitly modified by the public modifier.

isSyntacticallyAbstract

public boolean isSyntacticallyAbstract()

Returns true if this method is explicitly modified by the abstract modifier.

isPublic

public boolean isPublic()

Returns true if this method has public visibility. Non-private interface members are implicitly public, whether they declare the public modifier or not.

Specified by:

isPublic in interface AccessNode

Overrides:

isPublic in class AbstractJavaAccessNode

isAbstract

public boolean isAbstract()

Returns true if this method is abstract, so doesn't declare a body. Interface members are implicitly abstract, whether they declare the abstract modifier or not. Default interface methods are not abstract though, consistently with the standard reflection API.

Specified by:

isAbstract in interface AccessNode

Overrides:

isAbstract in class AbstractJavaAccessNode

isInterfaceMember

public boolean isInterfaceMember()

Returns true if this method declaration is a member of an interface type.

isVoid

public boolean isVoid()

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

getResultType

public ASTResultType getResultType()

Returns the result type node of the method.

getBlock

@Deprecated
public ASTBlock getBlock()

Deprecated.

Use getBody()

Returns the block defined by this method, or null if the method is abstract.

getBody

public ASTBlock getBody()

Returns the block defined by this method, or null if the method is abstract.

getArity

public int getArity()

Returns the number of formal parameters expected by this method (excluding any receiver parameter). A varargs parameter counts as one.

getThrows

public ASTNameList getThrows()

Returns the exception names listed in the throws clause of this method declaration, or null if there are none.

getKind

public MethodLikeNode.MethodLikeKind getKind()

Description copied from interface: MethodLikeNode

Returns a token indicating whether this node is a lambda expression or a method or constructor declaration. Can be used to downcast safely to a subinterface or an implementing class.

Specified by:

getKind in interface MethodLikeNode

Returns:

The kind of method-like

getFormalParameters

public ASTFormalParameters getFormalParameters()

getMethodDeclarator

@Deprecated
public ASTMethodDeclarator getMethodDeclarator()

Deprecated.

Method declarator nodes will be removed with 7.0.0

Returns the method declarator. Never null.

getDeclaredAnnotations

public List<ASTAnnotation> getDeclaredAnnotations()

Description copied from interface: Annotatable

Get all annotations present on this node.

Specified by:

getDeclaredAnnotations in interface Annotatable

Returns:

all annotations present on this node.

getAnnotation

public ASTAnnotation getAnnotation(String annotQualifiedName)

Description copied from interface: Annotatable

Get specific annotaion on this node.

Specified by:

getAnnotation in interface Annotatable

Parameters:

annotQualifiedName - qulified name of the annotation.

Returns:

ASTAnnotaion node if the annotation is present on this node, else null

isAnnotationPresent

public boolean isAnnotationPresent(String annotQualifiedName)

Description copied from interface: Annotatable

Checks whether the annotation is present on this node.

Specified by:

isAnnotationPresent in interface Annotatable

Parameters:

annotQualifiedName - qulified name of the annotation.

Returns:

true if the annotation is present on this node, else false

isAnyAnnotationPresent

public boolean isAnyAnnotationPresent(Collection<String> annotQualifiedNames)

Description copied from interface: Annotatable

Checks whether any annotation is present on this node.

Specified by:

isAnyAnnotationPresent in interface Annotatable

Parameters:

annotQualifiedNames - collection that cotains qulified name of annotations.

Returns:

true if any annotation is present on this node, else false