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

Class ASTCatchStatement

  • All Implemented Interfaces:
    net.sourceforge.pmd.lang.ast.Node, JavaNode, net.sourceforge.pmd.lang.symboltable.ScopedNode
    public class ASTCatchStatement
extends AbstractJavaNode
    Catch statement node. 
          "catch" "(" FormalParameter ")" Block

    • Field Summary

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

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

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      ASTBlock getBlock()
      Returns the Block node of this catch branch.
      java.util.List<ASTType> getCaughtExceptionTypeNodes()
      Returns the list of type nodes denoting the exception types caught by this catch block.
      java.util.List<java.lang.Class<? extends java.lang.Exception>> getCaughtExceptionTypes()
      Returns the list of exception types caught by this catch block.
      java.lang.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.
      java.lang.Object jjtAccept​(JavaParserVisitor visitor, java.lang.Object data)
      Accept the visitor

      • 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, getNthParent, getParentsOfType, getUserData, 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.ast.Node

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

    • Constructor Detail

      • ASTCatchStatement

        public ASTCatchStatement​(int id)

      • ASTCatchStatement

        public ASTCatchStatement​(JavaParser p,
                         int id)

    • Method Detail

      • 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

        public ASTBlock getBlock()
        Returns the Block node of this catch branch.

      • getCaughtExceptionTypeNodes

        public java.util.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 java.util.List<java.lang.Class<? extends java.lang.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 java.lang.String getExceptionName()
        Returns exception name caught by this catch block.