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

Class ASTConstructorDeclaration

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

All Implemented Interfaces:

GenericNode<JavaNode>, JjtreeNode<JavaNode>, Node, TextAvailableNode, AccessNode, Annotatable, ASTBodyDeclaration, ASTMethodOrConstructorDeclaration, JavadocCommentOwner, JavaNode, SymbolDeclaratorNode, TypeParamOwnerNode, Reportable

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

A constructor of a class or enum declaration.

 ConstructorDeclaration ::= ModifierList
                            TypeParameters?
                            <IDENTIFIER>
                            FormalParameters
                            (ThrowsList)?
                            Block

 

Nested Class Summary

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

AccessNode.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
<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)
boolean	containsComment()
@NonNull ASTBlock	getBody()	Returns the body of this method or constructor.
JMethodSig	getGenericSignature()	Returns the generic signature for the method.
String	getName()	Returns the name of the method, or the simple name of the declaring class for a constructor declaration.
FileLocation	getReportLocation()
@NonNull ASTCompilationUnit	getRoot()
T	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.
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(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, 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.java.ast.AccessNode

getDeclaredAnnotations, getEffectiveVisibility, getModifiers, getVisibility, hasExplicitModifiers, hasModifiers, isFinal, isNative, isPackagePrivate, isPrivate, isProtected, isPublic, isStatic, isStrictfp, isSynchronized, isSyntacticallyAbstract, isSyntacticallyFinal, isSyntacticallyPublic, isSyntacticallyStatic, isTransient, isVolatile

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

getArity, getFormalParameters, getThrowsList, isAbstract, isVarargs

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

ancestors, ancestorsOrSelf, asStream, children, descendants, descendantsOrSelf, getChild, getFirstChild, getLastChild, getNextSibling, getNthParent, 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, jjtAccept

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

acceptVisitor, ancestors, children, compareLocation, descendants, findChildNodesWithXPath, findChildrenOfType, findDescendantsOfType, findDescendantsOfType, firstChild, getAstInfo, getBeginColumn, getBeginLine, getEndColumn, getEndLine, getFirstChildOfType, getFirstDescendantOfType, getFirstParentOfType, getImage, getIndexInParent, getLanguageVersion, getNumChildren, getParentsOfType, getTextDocument, getUserMap, getXPathAttributesIterator, getXPathNodeName, hasDescendantOfType, 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 Detail

symbolTable

protected JSymbolTable symbolTable

Method Detail

getName

public String getName()

Description copied from interface: ASTMethodOrConstructorDeclaration

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

getReportLocation

public FileLocation getReportLocation()

acceptVisitor

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

containsComment

public boolean containsComment()

getBody

public @NonNull ASTBlock getBody()

Description copied from interface: ASTMethodOrConstructorDeclaration

Returns the body of this method or constructor. Returns null if this is the declaration of an abstract method.

getSymbol

public T getSymbol()

Description copied from interface: SymbolDeclaratorNode

Returns the symbol this node declares.

Specified by:

getSymbol in interface ASTMethodOrConstructorDeclaration

Specified by:

getSymbol in interface SymbolDeclaratorNode

Specified by:

getSymbol in interface TypeParamOwnerNode

getGenericSignature

public JMethodSig getGenericSignature()

Description copied from interface: ASTMethodOrConstructorDeclaration

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 ASTMethodOrConstructorDeclaration

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>

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