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

Class ASTCatchStatement

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

All Implemented Interfaces:

Node, JavaNode, ScopedNode

public class ASTCatchStatement
extends AbstractJavaNode

Catch statement node.

      "catch" "(" FormalParameter ")" Block
 

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
ASTBlock	getBlock()	Deprecated. Use getBody()
ASTBlock	getBody()	Returns the body of this catch clause.
List<ASTType>	getCaughtExceptionTypeNodes()	Returns the list of type nodes denoting the exception types caught by this catch block.
List<Class<? extends Exception>>	getCaughtExceptionTypes()	Returns the list of exception types caught by this catch block.
ASTVariableDeclaratorId	getExceptionId()	Returns the declarator id for the exception parameter.
String	getExceptionName()	Returns exception name caught by this catch block.
boolean	isMulticatchStatement()	Returns true if this node is a multi-catch statement, that is, it catches several unrelated exception types at the same time.
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.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.JavaNode

children, getChild, getParent

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, hasDescendantMatchingXPath, hasDescendantOfType, hasImageEqualTo, isFindBoundary, jjtAddChild, jjtGetChild, jjtGetChildIndex, jjtGetId, jjtGetNumChildren, jjtGetParent, jjtSetChildIndex, jjtSetParent, remove, removeChildAtIndex, setDataFlowNode, setImage, setUserData

Constructor Detail

ASTCatchStatement

@InternalApi
@Deprecated
public ASTCatchStatement(int id)

Deprecated.

ASTCatchStatement

@InternalApi
@Deprecated
public ASTCatchStatement(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

isMulticatchStatement

public boolean isMulticatchStatement()

Returns true if this node is a multi-catch statement, that is, it catches several unrelated exception types at the same time. Such a block can be declared like the following for example:

catch (IllegalStateException | IllegalArgumentException e) {}

Returns:

True if this node is a multi-catch statement

getBlock

@Deprecated
public ASTBlock getBlock()

Deprecated.

Use getBody()

Returns the Block node of this catch branch.

getBody

public ASTBlock getBody()

Returns the body of this catch clause.

getCaughtExceptionTypeNodes

public List<ASTType> getCaughtExceptionTypeNodes()

Returns the list of type nodes denoting the exception types caught by this catch block. The returned list has at least one element.

getCaughtExceptionTypes

public List<Class<? extends Exception>> getCaughtExceptionTypes()

Returns the list of exception types caught by this catch block. Any of these can be null, if they couldn't be resolved. This can happen if the auxclasspath is not correctly set.

getExceptionName

public String getExceptionName()

Returns exception name caught by this catch block.

getExceptionId

public ASTVariableDeclaratorId getExceptionId()

Returns the declarator id for the exception parameter.