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

Class ASTConstructorDeclaration

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

All Implemented Interfaces:

Node, QualifiableNode, SignedNode<ASTMethodOrConstructorDeclaration>, AccessNode, Annotatable, ASTMethodOrConstructorDeclaration, JavaNode, JavaQualifiableNode, MethodLikeNode, ScopedNode

public class ASTConstructorDeclaration
extends AbstractMethodOrConstructorDeclaration

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, NON_SEALED, PRIVATE, PROTECTED, PUBLIC, SEALED, STATIC, STRICTFP, SYNCHRONIZED, TRANSIENT, VOLATILE

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
boolean	containsComment()
ASTAnnotation	getAnnotation(String binaryName)	Returns a specific annotation on this node, or null if absent.
int	getArity()	Returns the number of formal parameters expected by this constructor (excluding any receiver parameter).
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.
int	getParameterCount()	Deprecated. Use getArity()
ASTFormalParameters	getParameters()	Deprecated. to be removed with PMD 7.0.0 - use getFormalParameters() instead
boolean	isAnnotationPresent(String binaryName)	Checks whether the annotation is present on this node.
boolean	isAnyAnnotationPresent(Collection<String> binaryNames)	Checks whether any annotation is present on this node.
Object	jjtAccept(JavaParserVisitor visitor, Object data)	Calls back the visitor's visit method corresponding to the runtime type of this Node.
void	setContainsComment()	Deprecated.

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, isAbstract, isDefault, isFinal, isNative, isPackagePrivate, isPrivate, isProtected, isPublic, 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, getRoot, 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, isAbstract, isDefault, isFinal, isNative, isPackagePrivate, isPrivate, isProtected, isPublic, 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, getRoot, 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

ASTConstructorDeclaration

@InternalApi
@Deprecated
public ASTConstructorDeclaration(int id)

Deprecated.

ASTConstructorDeclaration

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

Deprecated.

Method Detail

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.

Returns:

The kind of method-like

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

containsComment

public boolean containsComment()

setContainsComment

@InternalApi
@Deprecated
public void setContainsComment()

Deprecated.

getParameters

@Deprecated
public ASTFormalParameters getParameters()

Deprecated.

to be removed with PMD 7.0.0 - use getFormalParameters() instead

getParameterCount

@Deprecated
@DeprecatedAttribute(replaceWith="@Arity")
public int getParameterCount()

Deprecated.

Use getArity()

getArity

public int getArity()

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

getFormalParameters

public ASTFormalParameters getFormalParameters()

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

Description copied from interface: Annotatable

Returns a specific annotation on this node, or null if absent.

Specified by:

getAnnotation in interface Annotatable

Parameters:

binaryName - Binary name of the annotation type. Note: for now, canonical names are tolerated, this may be changed in PMD 7.

isAnnotationPresent

public boolean isAnnotationPresent(String binaryName)

Description copied from interface: Annotatable

Checks whether the annotation is present on this node.

Specified by:

isAnnotationPresent in interface Annotatable

Parameters:

binaryName - Binary name of the annotation type. Note: for now, canonical names are tolerated, this may be changed in PMD 7.

Returns:

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

isAnyAnnotationPresent

public boolean isAnyAnnotationPresent(Collection<String> binaryNames)

Description copied from interface: Annotatable

Checks whether any annotation is present on this node.

Specified by:

isAnyAnnotationPresent in interface Annotatable

Parameters:

binaryNames - Collection that contains binary names of annotations. Note: for now, canonical names are tolerated, this may be changed in PMD 7.

Returns:

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